API Changelog
GoRoute does not currently publish a per-release changelog.
This page used to list release notes for versions between 2022 and 2024. Those entries did not describe anything that shipped, and several of them referred to endpoints that have never existed in the API, so they have been removed rather than left in place. Nothing has replaced them, because there is no release history to publish yet.
If you need to know whether a specific capability exists, the reference pages below describe the API as it behaves now. They are kept current; this page is not a substitute for them.
Versioning Policy
GoRoute uses semantic versioning for API changes:
- Major versions (v1 → v2): Breaking changes, announced 6+ months in advance
- Minor versions: New features, backward compatible
- Patch versions: Bug fixes, no API changes
The current API version is v1. Every endpoint documented on this site is
served under the /api/v1/ path, and there is no v2.
Deprecation Policy
| Timeline | Action |
|---|---|
| Announcement | Deprecation notice on this page |
| +3 months | Warning emails to affected users |
| +6 months | Feature removed from documentation |
| +12 months | Feature disabled (major versions only) |
The GoRoute API sends no Deprecation header and no Sunset header, on any endpoint.
Nothing in the API sets one, so code that watches response headers for a deprecation signal
will never fire — it will look like nothing is ever deprecated.
The API does send other response headers, and none of them ever carries a deprecation
signal either. You may see Retry-After and X-RateLimit-Limit, X-RateLimit-Remaining
and X-RateLimit-Reset when you are rate limited, WWW-Authenticate when a request fails
authentication, Content-Disposition on an endpoint that returns a file to download,
Cache-Control on a cacheable response, and X-Request-ID on everything — quote that last
one to support. That list is not exhaustive and is not a contract: treat any header as
something that may be added or removed, and do not build deprecation handling on one.
An earlier version of this page said a deprecation notice would appear "in changelog and API response headers". The header half was never built; the row above has been corrected. Watch this page instead.
Keeping Up With Changes
There is no changelog feed, mailing list or RSS subscription for the API. If you were previously told there was one, that was incorrect.
Until a release history exists, the reliable way to check current behaviour is to read the reference documentation for the area you depend on:
- Error Codes — every error the API returns
- Webhooks — event payloads and delivery behaviour
- API Tools — working against the API description
- Support — how to ask about a specific change