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

Improve the documentation for the REST API

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Unresolved
    • None
    • API - REST
    • None
    • 1
    • 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

      The REST API documentation, especially around endpoints that offer POST capability needs to be dramatically improved. There are many endpoints where there are limits to the amount of data, dependencies, required fields, etc that are not documented.

      As an example, the REST endpoint for creating a pull request, the description must be under 32,768 characters. This limitation is not documented in the base documentation for the pull request feature or the REST API documentation.

      The lack of detail in the documentation results in painful troubleshooting when the user inadvertently exceeds limits they had no idea that existed. The first step would be to consult the documentation, but there is no information that provides any troubleshooting assistance.

      Attachments

        Activity

          People

            Unassigned Unassigned
            cdrummond Craig Drummond
            Votes:
            1 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated: