Versioning and Deprecation
How the RIXL API is versioned, what may change within a version, and how operations are retired.
Major Version
The API major version is the v1 path segment, for example /media/v1/projects/{project_id}/videos. Every public operation is in v1 today.
What Changes Within v1
Only additive changes ship within a major version:
- new operations
- new optional request fields and query parameters
- new response fields
- new enum values
- new response headers
Your client must ignore response fields and enum values it does not recognise. Do not fail on them, and do not validate responses against a closed schema.
Breaking Changes
A breaking change (removing or renaming an operation or field, changing a type, or making an optional input required) ships only under a new major version, such as v2. The previous major version stays available for at least 6 months after its replacement is generally available.
Deprecation
- A deprecated operation is marked
deprecated: truein the OpenAPI spec and announced in the changelog. - Once a removal date is set, responses from that operation carry a
Deprecationheader (RFC 9745) and aSunsetheader (RFC 8594) with the removal date. - The removal date is at least 90 days after the
Sunsetheader first appears.
SDKs
@rixl/sdk is the supported SDK. It is generated from the same OpenAPI spec and follows semver; while it is 0.x, a minor release may contain breaking changes, so read its changelog before upgrading. The SDKs for other languages are previews without these guarantees. The SDK support matrix lists each one's status.