Change Type | Breaking Change? |
---|---|
Removing or renaming a property in the request or response. | Yes |
Changing a property’s type. | Yes |
Changing an API’s endpoint URL. | Yes |
Altering response behavior for the same request. | Yes |
Changing the paging mechanism. | Yes |
Adding a new property to the request or response. | No |
Adding a member to an enumeration. | No |
Updating an error code. | No |
Changing the order of properties in the request or response. | No |
https://api.example.com/v{version_number}/{service}/{param_value}
For example, version 2 of the Create Checkout Session API:
https://api.example.com/v2/create-checkout-session/1000