Skip to content

Versioning and changelog

Generated contracts are the source of truth. Documentation builds pin their artifact digests and fail when a bound source changes without review.

Event type names include a major version suffix such as .v1. Event schemas live under /events/v1/. A breaking event change requires a new versioned contract. Additive changes must still pass fixture, schema, privacy, and consumer review before publication.

REST operation and schema versions come from generated OpenAPI. The reference rejects duplicate operation IDs, case-insensitive schema-name collisions, stale implementation inventories, and implementation or documentation route drift.

A release changelog should identify the affected contract version, whether a change is additive or breaking, the migration action, and the effective date. This protected preview does not claim a public release date.