ETAR · API v1
ETAR API versioning and deprecation policy
The public content API uses URL major versions. /api/v1/content is active. No deprecation or retirement date has been announced.
Compatibility within v1
Existing field meanings, types and public access remain compatible within v1. Optional fields and links may be added; clients should ignore unknown fields. Published pages and documents can change or be withdrawn through editorial review. An empty list is valid and does not mean the API is unavailable.
Breaking changes and migration
A planned incompatible contract change requires a new major URL, such as /api/v2/content. Before a planned retirement, ETAR will publish the affected endpoints, replacement version, migration instructions and deprecation and sunset dates on this page. The notice period will be stated in that announcement; no fixed support term is currently promised. Security or privacy corrections may require immediate restrictions.
Deprecation and Sunset signals
Responses link to this policy with Link: <policy URL>; rel="deprecation"; type="text/html", as defined in RFC 9745. When a deprecation is announced, affected responses will use the RFC 9745 Deprecation Structured Field date: @ followed by Unix seconds. When a retirement is scheduled, Sunset will use an HTTP date in GMT, as defined in RFC 8594. A retirement date will not precede the deprecation date.
Active v1 responses currently omit both date headers. Clients should follow the policy link and inspect these headers on successful and error responses, including HEAD. They should migrate before an announced sunset and never infer a retirement date from an absent header.
Scope and release notes
This policy covers the REST API contract. MCP negotiates its own protocol versions; CLI releases have separate semantic versions. Neither changes the API's read-only scope. The OpenAPI document version describes its revision, while /v1/ identifies the stable API major version.
- API v1: active; deprecation: none; sunset: none.
- OpenAPI 1.1.0: adds links to MCP, the CLI download and this policy. Existing response fields and operations remain compatible.
