We are fixing discrepancies between the documented and actual objects returned by some of our APIs.
On Jul 22, 2022, we will change the schema definitions for the User
, Team
and Account
objects documented in our swagger.json and at developer.atlassian.com to reflect the data returned from 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 Account
schema object, they can return either the User
or the Team
subtype. The schemas of both the User
and Team
subtypes inherit the Account
definition and should return all the fields defined in the Account
object schema.
We have updated or removed some properties in the schema definitions for the User
, Team
, and Account
objects; to reflect the properties shared and returned by our APIs. The properties that have been changed or removed were not marked as required
.
We have also updated the swagger definitions attached to a number of endpoints. Many of these endpoints previously stated that they return a User
object, but have been updated to state that they return an Account
object. This reflects the current API behavior. The reason for this change is that the endpoints currently are able to return either User
or Team
objects, so Account
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 swagger.json
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.
Comment
changesuser
is now of type Account
instead of type User
.Commit Comment
changescommit
field refers to type Commit
which has changes (See Commit
changes)Commit
changesauthor
is now of type Account
instead of type User
.Issue Change
changesuser
is now of type Account
instead of type User
.issue
field refers to type Issue
which has changes (See Issue
changes)Issue Comment
changesissue
field refers to type Issue
which has changes (See Issue
changes)Comment
has changes (See Comment
changes)Issue
changesassignee
is now of type Account
instead of type User
.reporter
is now of type Account
instead of type User
.Paginated Commit Comments
changesvalues
array field refers to type Commit Comment
which has changes (See Commit Comment
changes)Paginated Issues
changesvalues
array field refers to type Issue
which has changes (See Issue
changes)Paginated Issue Comments
changesvalues
array field refers to type Issue Comment
which has changes (See Issue Comment
changes)Paginated Log Entries
changesvalues
array field refers to type Issue Change
which has changes (See Issue Change
changes)Paginated Pull Requests
changesvalues
array field refers to type Pull Request
which has changes (See Pull Request
changes)Paginated Pull Request Comments
changesvalues
array field refers to type Pull Request Comment
which has changes (See Pull Request Comment
changes)Pull Request Comment
changesComment
has changes (See Comment
changes)Pull Request
changesparticipants
array field refers to type Participant
which has changes (See Participant
changes)Participant
changesuser
is now of type Account
instead of type User
.The following lists show all the endpoints that have changed, along with the fields
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.
Participant
changesCommit Comment
changesCommit Comment
changesPaginated Commit Comments
changesPaginated Issues
changesIssue
changesIssue
changesIssue
changesIssue
changesPaginated Log Entries
changesIssue Change
changesIssue Change
changesPaginated Issue Comments
changesIssue Comment
changesIssue Comment
changesIssue Comment
changes200
response now has type Paginated Accounts
. Previously, this was erroneously not set.200
response now has type Account
. Previously, this was erroneously not set.200
response now has type Account
. Previously, this was erroneously not set.Pull Request
changesPull Request
changesPull Request
changesPull Request
changesPull Request
changesPaginated Pull Requests
changesPaginated Pull Requests
changesParticipant
changesParticipant
changesPaginated Pull Request Comments
changesPull Request Comment
changesPull Request Comment
changesPull Request Comment
changes200
response now has type Paginated Accounts
. Previously, this was erroneously not set.Snippet Comment
which was previously erroneously set to Snippet
. Changed 201
response schema to Snippet Comment
which was previously erroneously set to Snippet
.Snippet Comment
which was previously erroneously unset. Changed 200
response schema to Snippet Comment
which was previously erroneously unset.204
response schema, which was previously erroneously set to Paginated Users
.204
response schema, which was previously erroneously set to Paginated Users
.204
response schema, which was previously erroneously set to Paginated Users
.200
response schema to Paginated Accounts
schema, instead of Paginated Users
schema.200
response schema type to Account
, instead of User
.200
response schema type to Account
, instead of User
.Rate this page: