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

Stash branch-utils REST API documentation has typo in example

    XMLWordPrintable

Details

    Description

      Creating on behalf of a customer from Dell.

      The documentation for Stash's branch-utils REST documentation (https://developer.atlassian.com/static/rest/stash/3.10.0/stash-branch-utils-rest.html) has an typo in the DELETE example for the "/rest/branch-utils/1.0/projects/{projectKey}/repos/{repositorySlug}/branches" endpoint.
      
      In the example, the DELETE request payload JSON has name set to "/refs/heads/my-branch", but it should be "refs/heads/my-branch" (no leading /).
      
      Since the API doesn't return any information when a branch doesn't exist, this took a while for me to figure out what was wrong.  Please update the documentation to avoid others the headache.
      

      Attachments

        Activity

          People

            rstocker Robin Stocker (Inactive)
            dtester Dallas Tester (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: