Versioning & Changelog
We use semantic versioning for the public API specification:
- MAJOR: breaking changes require
/v2and deprecation headers for/v1. - MINOR: additive changes (new endpoints/fields).
- PATCH: bug fixes and docs clarifications.
Stable URLs
- Latest:
/openapi.yaml - Compatibility alias:
/openapi/v1/openapi.yaml
Deprecation headers
Deprecation: true, optionalSunset: <date>.
Changelog
- Maintained in repo and published with each release.