Skip to main content

Deprecation policy

Zex uses a contract-first discipline. Deprecations are handled explicitly to avoid silent breakage.

Principles​

  • New behavior ships behind a new RC and new contracts.
  • We do not silently change request/response shapes for existing versions.
  • A deprecation must be written down (changelog) before it is enforced.

What counts as a breaking change​

  • removing fields or endpoints
  • changing enum vocabularies
  • changing required headers

Where it is recorded​

  • changelog/api-changelog.md is the public record for contract changes.
  • Internal operational changes live in internal docs and receipts, not public docs.