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

REST doc improvements

    XMLWordPrintable

Details

    Description

      (1) Some of the links in the index are dead. For example, http://example.com/rest/api/1.0/hooks links to https://developer.atlassian.com/static/rest/stash/3.11.3/stash-rest.html#idp245872 which doesn't go anywhere.

      (2) There are no examples requests for some of the endpoints.

      /rest/api/1.0/projects/

      {projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/settings claims to have an example, but clicking 'expand' doesn't show anyting.

      (3) Some parameters aren't documented.

      /rest/api/1.0/projects/{projectKey}

      /repos/

      {repositorySlug}/settings/hooks/{hookKey} does not document hookKey, nor give an example.

      This seems like the REST endpoint that should give me settings for the (legacy) HipChat notification hook. I tried the obvious values, but no success:

      /rest/api/1.0/projects/AB/repos/beta.research/settings/hooks/hipchat-hook-config-form/ -> HTTP 500

      /rest/api/1.0/projects/AB/repos/beta.research/settings/hooks/com.atlassian.stash.stash-hipchat-integration/ -> HTTP 500

      /rest/api/1.0/projects/AB/repos/beta.research/settings/hooks/com.atlassian.stash.stash-hipchat-integration:hipchat-hook-config-form/ -> HTTP 404

      Using /settings doesn't help, and seems to ignore my key entirely:

      /rest/api/1.0/projects/AB/repos/beta.research/settings/hooks/whatever-I-put-here-doesnt-matter/settings -> HTTP 204 every time

      (3) The index ordering is inconsistent.

      http://example.com/rest/api/1.0/users/{userSlug}/settings lists GET before POST, but others vary, e.g. "http://example.com/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}

      /pull-requests/

      {pullRequestId}

      /comments [POST, GET]"

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              5f6b68f735aa Wilfred Hughes
              Votes:
              3 Vote for this issue
              Watchers:
              11 Start watching this issue

              Dates

                Created:
                Updated:

                Backbone Issue Sync