Uploaded image for project: 'Bitbucket Data Center'
  1. Bitbucket Data Center
  2. BSERV-12773

The source and target matcher fields should be consistently named between the GET and POST methods of the Default Reviewers APIs

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Unresolved
    • None
    • API - REST
    • None
    • 2
    • We collect Bitbucket feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

    Description

      Summary

      The source and target matcher fields are different between the GET and POST methods of the Default Reviewers REST APIs

      GET methods use "sourceRefMatcher" and "targetRefMatcher" while POST methods use "sourceMatcher" and "targetMatcher".

      Here's a sample response for a GET /rest/default-reviewers/1.0/projects/{projectKey}/conditions request:

      [
    {
        "id": 27,
        "scope": {
            "type": "PROJECT",
            "resourceId": 145
        },
        "sourceRefMatcher": {
            "active": true,
            "id": "ANY_REF_MATCHER_ID",
            "displayId": "ANY_REF_MATCHER_ID",
            "type": {
                "id": "ANY_REF",
                "name": "Any branch"
            }
        },
        "targetRefMatcher": {
            "active": true,
            "id": "ANY_REF_MATCHER_ID",
            "displayId": "ANY_REF_MATCHER_ID",
            "type": {
                "id": "ANY_REF",
                "name": "Any branch"
            }
        },
        "reviewers": [
            {
                "name": "user1",
                "emailAddress": "user1@testdomain.com",
                "id": 51,
                "displayName": "User1",
                "active": true,
                "slug": "user1",
                "type": "NORMAL",
                "links": {
                    "self": [
                        {
                            "href": "https://bitbucket.myhost.com/users/user1"
                        }
                    ]
                }
            }
        ],
        "requiredApprovals": 1
    }
]

      Here's a sample request payload for a POST /rest/default-reviewers/1.0/projects/{projectKey}/condition request

      {
    "sourceMatcher": {
        "active": true,
        "id": "ANY_REF_MATCHER_ID",
        "displayId": "ANY_REF_MATCHER_ID",
        "type": {
            "id": "ANY_REF",
            "name": "Any branch"
        }
    },
    "targetMatcher": {
        "active": true,
        "id": "ANY_REF_MATCHER_ID",
        "displayId": "ANY_REF_MATCHER_ID",
        "type": {
            "id": "ANY_REF",
            "name": "Any branch"
        }
    },
    "reviewers": [
        {
            "name": "user1",
            "emailAddress": "user1@testdomain.com",
            "id": 51,
            "displayName": "User1",
            "active": true,
            "slug": "user1",
            "type": "NORMAL"
        }
    ],
    "requiredApprovals": 1
}

      The difference can cause confusion on the field names to pass in the POST methods, especially since the Default Reviewers REST resources documentation is currently missing examples (this doc issue is tracked in ticket: BSERV-12665)

      Attachments

        Issue Links

          is related to

          Bug - A problem which impairs or prevents the functions of the product. BSERV-12665 Default Reviewers REST resources documentation missing examples

          • Low - Low priority issues
          • Closed
          relates to

          Suggestion - BSERV-12774 Support the specification of default reviewers as an array of usernames for the Default Reviewers APIs

          • Gathering Interest

          Suggestion - BSERV-12775 Support bulk creation of default reviewers pull request conditions through the Default Reviewers REST APIs

          • Gathering Interest

          Activity

            People

              Unassigned Unassigned
              jmariano@atlassian.com JP Mariano
              Votes:
              3 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated: