Versioning & Changelog

Contract-stability policy for external clients, with dated API and documentation changes.

API ReferenceEndpoint CatalogOpenAPI v1 JSON

Version policy

  • URI versioning: all stable endpoints are exposed under /api/v1.
  • Non-breaking additions (new optional fields, new endpoints) may be shipped without a URI version bump.
  • Breaking changes require a new major URI version (for example,/api/v2) with migration documentation.
  • Existing v1 routes remain available for a deprecation window before retirement.

Deprecation policy

  • Deprecations are announced here with concrete dates.
  • Clients should monitor this page and use contract tests against OpenAPI v1.
  • No silent breaking changes are made on stable versions.

Release notes

v1DocsFebruary 21, 2026
  • Published complete external endpoint catalog for all /api/v1 routes.
  • Added canonical object model documentation and endpoint-level error matrix.
  • Published machine-readable OpenAPI spec at /openapi/v1-public.json.
  • Aligned usage-summary authentication docs with implementation behavior.