XKOVA Docs
Docs / Resources / Deprecations

Deprecations

When a surface is going away, you get warning long before it goes. No endpoint is deprecated today, though a few internal response fields (the legacy chain_id) are already marked deprecated in the reference in favor of the chain object. When a deprecation happens, the surface keeps working through a minimum twelve month overlap and the deprecation is announced and machine-visible, so your integration never breaks without notice.

The policy

  • A minimum twelve month overlap. This is XKOVA's operational commitment: once a surface is deprecated, it keeps working for at least twelve months before it can be removed. You have the full window to migrate.
  • Announced and machine-visible. A deprecation is announced in the Changelog with a migration note, and the operation is flagged deprecated in the API reference. Deprecated endpoints will additionally carry Deprecation and Sunset response headers so you can detect the deprecation from your own logs.
No endpoint is deprecated today, so no response currently carries these signals. Wiring your client to log or alert on a Deprecation header now costs nothing and turns the policy into something your integration enforces for you.

The headers

HeaderMeaning
Deprecation Present whenever the endpoint is deprecated. Its presence is the signal to plan a migration.
Sunset The date after which the endpoint may be removed. Treat it as the deadline for your migration.

What to do when you see one

  1. Read the Sunset date. That is how long the current behavior is guaranteed.
  2. Find the replacement. A deprecation is announced in the Changelog with a migration note pointing at the surface that supersedes it.
  3. Move your calls to the replacement well before the sunset date, then confirm the Deprecation header no longer appears in your responses.

Removal is a breaking change

Removing a surface is a breaking change, so it cannot happen within the current major version on its own. The deprecation overlap exists precisely so that the move to a new behavior is never abrupt. See Versioning for what counts as breaking and how the major version protects you.

Related

See the Changelog for the deprecation announcements and migration notes, and the interactive reference for the current state of any operation.