Skip to main content

Versioning and status

The version is in the path (/v1/). Within a version:

ChangeNotice
A new route, a new optional field, a new event type, a new error_codeNone. Ignore what you do not know
A breaking change to an available routeNever within v1. A v2 would run beside v1 for at least 12 months
A change to a preview route30 days, in the changelog and by email to technical contacts
A planned routeSpecified to design against; it answers 404 until it ships

Every operation in specs/openapi.yaml and every message in specs/asyncapi.yaml carries x-status. Write clients that tolerate unknown fields and unknown enum values.