Skip to content

Versioning ​

Revi uses date-based URL versions for the public API:

text
/api/YYYY-MM/...

Recommended version:

text
/api/2026-10

The response includes:

http
Revi-Version: 2026-10

Version Policy ​

These rules are binding. They decide when a new dated version may be created, what its date means, and how long it is supported.

  1. The date is the month the version takes effect. YYYY-MM names the month in which the version starts being served in production, not the month its code was written. A version is never published with a date far in the future, and a version that is already being served is never renamed to a later date.
  2. Additive changes stay inside the version in force. New endpoints, new optional request fields, new response fields, new error codes and new scopes are added to the dated version currently in force. They do not justify a new dated version.
  3. Only a breaking change justifies a new dated version. Breaking means removing or renaming an endpoint, field or error code; making an optional request field required; narrowing an accepted value range; or changing the meaning of an existing field. Anything that would make a correct existing client stop working.
  4. Support window: at least 24 months after a successor is published. The clock starts the month the successor version takes effect, never the month the version itself was released. A version with no successor has no expiry date.
  5. Signalling. Deprecated versions return Deprecation: true; versions with a planned retirement return Sunset; retired versions return 410 Gone.

Compatibility ​

Version 2026-04 remains available for existing integrations, with no redirects and no automatic migration. 2026-10 is the recommended version and the one that receives new capabilities, including connection-scoped order source state, invitation policy reads, audit events and backfills.

Public API documentation for Revi.