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

Rest API documentation example is missing when the request contains an @OptionalBody

    XMLWordPrintable

Details

    Description

      Some REST requests, such as pull request merge, allow a body to be set but do not require it.
      These requests are missing example request documentation in the REST API documentation.

      For example: https://docs.atlassian.com/bitbucket-server/rest/6.3.2/bitbucket-rest.html#idp265

      These requests have example representation javadoc in the code:

           * @request.representation.mediaType application/json
           * @request.representation.example {@link RestPullRequestReopenRequest#REOPEN_REQUEST_EXAMPLE}
      

      And if the @OptionalBody tag is removed from the request, then the example appears in the html.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              khughes@atlassian.com Kristy
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:

                Backbone Issue Sync