Rate this page:
We are fixing discrepancies between the documented and actual objects returned by some of our APIs.
The previous schemas did not accurately reflect the data returned by our API, and we are updating the schemas to correct the discrepancies.
Where the Bitbucket Cloud APIs have previously shown that they return the schema object, they can return either the or the subtype. The schemas of both the and subtypes inherit the definition and should return all the fields defined in the object schema.
We have updated or removed some properties in the schema definitions for the , , and objects; to reflect the properties shared and returned by our APIs. The properties that have been changed or removed were not marked as .
We have also updated the swagger definitions attached to a number of endpoints. Many of these endpoints previously stated that they return a object, but have been updated to state that they return an object. This reflects the current API behavior. The reason for this change is that the endpoints currently are able to return either or objects, so is a more correct representation.
We have also taken the chance to fix a number of endpoints which have no attached swagger, or have erroneously attached swagger definitions.
These changes should require little or no action by developers. If you use our file to auto-generate client code, you may wish to regenerate your client code. As the actual returned payloads from our APIs are not changing, we're not expecting anyone to be impacted by these changes.
The following lists show all the endpoints that have changed, along with the that have changed in the API. This announcement is purely to indicate that the APIs schema has been updated to match the current API return types. There's no change to the response or request bodies for any of our APIs.
Rate this page: