Versioning
What v1 promises
The version is part of the path: every endpoint lives under /api/public/v1.
Within v1, changes are additive. These can happen at any time, and your code should tolerate them:
- New endpoints.
- New attributes, relationships, includes, filters and sorts.
- New values in
meta, including newreason_codevalues inmeta.skipped. - New optional request fields.
- Better wording in
detailmessages.
Removing or renaming an attribute or endpoint, changing a type, or making an optional field required would be a breaking change, and breaking changes would come in a new version under a new path.
