Skip to main content

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โ€‹

TimelineAction
AnnouncementDeprecation notice in changelog and API response headers
+3 monthsWarning emails to affected users
+6 monthsFeature removed from documentation
+12 monthsFeature disabled (major versions only)

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

Next Stepsโ€‹