Novastrum Versioning
The version is part of the path. Breaking changes get a new version; the old one keeps working while you migrate.
Versions
| Version | Path | Status |
|---|---|---|
| v1 | /api/v1/… | Current, the only version |
Always include the version in the path. Requests to a version that does not exist answer 404.
Changes within a version
Within a version we only make changes that do not break existing clients:
- new endpoints,
- new optional request fields,
- new fields in responses.
Write clients that ignore response fields they do not know.
Deprecation
When a new version replaces an old one, the old version stays available for at least 12 months. The deprecation is announced on this page together with a migration guide. There is no deprecated version at the moment.
Changelog
v1 has had no breaking changes. Additions are listed in the API reference.
Links from older SDK documentation to
/changelog/…, /migration/… or
/deprecation-policy lead here.