Versioning and Deprecation
Every public Connect procedure path includes its stable major package version.
The current contract uses publicapi.v1, for example:
/public-api/publicapi.v1.Contact/GetContactCompatible changes
Section titled “Compatible changes”HeyX may add procedures, optional request fields, response fields, and enum
values within publicapi.v1. Clients must ignore response fields they do not
recognize and handle unknown enum values safely. Existing required request
fields do not change incompatibly within a major version.
Breaking changes
Section titled “Breaking changes”An incompatible contract is introduced under a new package and procedure path,
such as publicapi.v2. It does not silently replace publicapi.v1. Migration
guidance identifies replacement operations and material behavior changes.
Deprecation signals
Section titled “Deprecation signals”HeyX documents a public procedure deprecation before removal. Deprecated HTTP
responses use the Deprecation header and link to migration guidance. Once a
removal date is scheduled, responses also include the Sunset header. Ordinary
breaking changes receive at least 90 days of notice; urgent security or legal
changes may require a shorter timeline.
The machine-readable policy is linked from the OpenAPI specification and published at heyx.app/versioning.md.