/General
Versioning
Draft: The version scheme below is a proposal pending the API contract.
Breaking Changes
All changes within a version will be backwards compatible. The following are considered breaking changes and will be versioned:
- Removing or renaming existing fields from response objects.
- Changing the type or format of existing response fields.
- Removing or renaming existing endpoints.
- Making previously optional parameters required.
The following are considered non-breaking changes and may happen at any time:
- Adding new optional query parameters to existing endpoints.
- Adding new fields to JSON response objects.
- Adding new endpoints.
- Improving error messages or adding detail to existing error responses.