Developers
API versioning and deprecation
Versioning
The ThruWire REST API uses a major version in the URL path, currently /api/v1. Additive fields and operations may be introduced within a major version. Clients should ignore unknown response fields, use documented operation IDs, and avoid undocumented behavior.
Deprecation signals
No operation is deprecated merely because this policy exists. When an operation is scheduled for deprecation, ThruWire will mark it in OpenAPI, publish migration guidance, and send the standards-track Deprecation response header defined by RFC 9745. Responses may also link to guidance with rel="deprecation".
Sunset
If an endpoint is scheduled to stop responding, it will additionally send the Sunset header defined by RFC 8594. Its date will not precede the deprecation date. The migration notice will state the notice period, replacement path, and any compatibility considerations for that change.