Versioning
The Patholytix API is versioned to allow the platform to evolve without breaking existing integrations.
Current version
The current API version is v1.
Backwards compatibility guarantee
Within a major version, we guarantee:
- Existing endpoints will not be removed without advance deprecation notice
- Existing request fields will not be removed or have their type changed
- Existing response fields will not be removed or have their type changed
- HTTP status codes for existing scenarios will not change
We may add new optional request fields, new response fields, or new endpoints within a major version without a deprecation notice. Well-written clients should handle unknown response fields gracefully (ignore unknown fields rather than failing).
What constitutes a breaking change
| Change | Breaking? |
|---|---|
| Adding a new optional request field | No |
| Adding a new response field | No |
| Adding a new endpoint | No |
| Removing a request field | Yes |
| Removing a response field | Yes |
| Changing a field type | Yes |
| Changing a status code | Yes |
| Removing an endpoint | Yes |
| Changing authentication requirements | Yes |
Deprecation policy
When a breaking change is required, the deprecated behaviour is announced in advance via:
Deprecationresponse header on affected endpointsSunsetresponse header indicating the planned retirement date- Changelog entry on this portal
The old and new behaviour are supported concurrently during the deprecation window. Contact your Deciphex account representative for timelines specific to your integration.
Changelog
Changes to the API are documented in the Changelog section, including:
- New endpoints and fields
- Deprecation announcements