Bitbucket server REST API documentation (generated) is VERY incomplete

The new Bitbucket (server) REST API documentation is incomplete in countless examples. One example: Create a project

  1. Old (and useful) REST Resources Provided By: Bitbucket Server - REST with complete example request representations and logically ordered for project, repo and pull request endpoints
  2. New (hardly useful): https://developer.atlassian.com/server/bitbucket/rest/api-group-projects/#api-projects-post - the example request is incomplete, no body.
    • Why would the create project request contain an id parameter in the request body?
    • Why are all the repository and pull request related endpoints grouped under ‘Project’?

Can this please be fixed, asap.

2 Likes

Hello,
Thank you for reporting this. It is clearly an bug in the documentation and I have opened [BSERV-13364] New (Swagger based) REST documentation is missing rerquest bodies - Create and track feature requests for Atlassian products. to help us track and resolve this.

2 Likes

We have deployed an updated version of the software rendering the documentation, and it now includes the request bodies.

Why would the create project request contain an id parameter in the request body?

This was an error on our end, and we have fixed this, it will be updated as part of the next Bitbucket release.

Why are all the repository and pull request related endpoints grouped under ‘Project’?

They are currently grouped as part of the URL structure. We are well aware that the current grouping is not optimal in all cases and are evaluating solutions to improve this. I appreciate your patience and taking the time to report these problems to us.

1 Like