HakiChain API deprecation and Sunset policy
This policy applies to the public HakiChain discovery API and any future public HTTP APIs published under /api/v1. Customer-data APIs follow separate enterprise agreements.
Versioning
Public APIs are versioned in the URL path. The current public version is /api/v1. Breaking changes require a new major path version (for example, /api/v2).
Deprecation notice and Sunset timeline
When HakiChain deprecates a public API version or endpoint, responses include RFC 8594 headers:
Deprecation: true(or an HTTP-date) — the Deprecation headerSunset: <HTTP-date>— the Sunset header naming the earliest removal dateLink: <https://hakichain.com/developers/deprecation-policy>; rel="deprecation-policy"
HakiChain publishes at least 90 days notice before removing a public version. A successor version remains available for at least 90 days after it is published. Agents should stop calling a surface after its Sunset date.
Machine-readable copies
- Markdown deprecation policy
- Request this page with
Accept: text/markdownfor a Markdown representation - OpenAPI specification documents the same Deprecation and Sunset policy
Non-breaking changes
Adding optional JSON fields, new endpoints, or additional response content types is not considered breaking. Clients should ignore unknown fields.