Version in the URL
The Spirii Public API is versioned in the URL path. The current major version is v2:
https://api.spirii.com/v2/locations
Current version
| Version | Status |
|---|
| v2.7.0 | Current — generally available. |
| v2.7.0-dev | Development preview — may change without notice. |
Version history
| Version | Notes |
|---|
| v2.7.0 | Current GA release. |
| v2.6.0 | Previous GA release. |
| v2.5.0 | |
| v2.4.0 | |
| v2.3.0 | |
| v2.2.0 | |
| v2.1.0 | |
| v2.0.1 | |
| v2.0 | Initial v2 release. |
What counts as a breaking change
The following changes are considered breaking and trigger a major version bump:
- Removing or renaming a field on a response object.
- Removing an endpoint or HTTP method.
- Changing the type of an existing field.
- Tightening validation on request bodies in a way that rejects previously valid input.
The following are not breaking and may ship in any minor version:
- Adding new endpoints.
- Adding new optional request parameters.
- Adding new fields to response objects.
- Adding new enum values to existing fields.
When parsing responses, treat unknown fields as ignorable and unknown enum values as a generic fallback. This keeps your integration forward-compatible with minor releases.
Deprecation policy
When a version is deprecated, we announce it in the Changelog and via email to your account contact. Deprecated versions:
- Remain reachable for at least 12 months after the deprecation announcement.
- Receive security fixes only — no new features or bug fixes.
- Return a
Sunset HTTP header indicating the end-of-life date.
After the sunset date, the version returns 410 Gone.
