Last updated Jul 28, 2022

Rate this page:

Announcement — Various fixes to Account, User, and Team schemas

Summary

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.

Why we are changing the Account, User, and Team schemas?

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.

Changes to the existing 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.

Changes to some endpoints

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.

What action is required?

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.

Which schema objects are affected?

Comment changes

  • The user is now of type Account instead of type User.

Commit Comment changes

  • The commit field refers to type Commit which has changes (See Commit changes)

Commit changes

  • The author is now of type Account instead of type User.

Issue Change changes

  • The user is now of type Account instead of type User.
  • The issue field refers to type Issue which has changes (See Issue changes)

Issue Comment changes

Issue changes

  • The assignee is now of type Account instead of type User.
  • The reporter is now of type Account instead of type User.

Paginated Commit Comments changes

Paginated Issues changes

  • The values array field refers to type Issue which has changes (See Issue changes)

Paginated Issue Comments changes

Paginated Log Entries changes

Paginated Pull Requests changes

Paginated Pull Request Comments changes

Pull Request Comment changes

Pull Request changes

  • The participants array field refers to type Participant which has changes (See Participant changes)

Participant changes

  • The user is now of type Account instead of type User.

Which API endpoints are affected?

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.

Commits endpoints

Issue tracker endpoints

Pullrequests endpoints

Repositories endpoints

Snippets endpoints

Users endpoints

Rate this page: