Versioning and compatibility
The API major version is part of the path. Any compatible API Gateway
implementation that serves /api/v1 must honor the v1 contract. API contract,
SDK, ConnectPlane application, API Gateway image, and shared-platform versions
are independent identifiers.
Breaking changes
Section titled “Breaking changes”Additive, optional changes may ship within v1. Removing an operation or field,
adding a required input, narrowing accepted values, or narrowing a successful
response requires a new major path such as /api/v2.
Deprecation
Section titled “Deprecation”When a major API version is superseded, ConnectPlane will announce its sunset
at least 12 months before removal. The external API changelog and Deprecation
and Sunset response headers will identify the dates before removal.
The Markdown version of this guide remains available for tools and compatibility consumers.