LegalStack
Гайды

Версионирование

Стратегия версий API, заголовки Deprecation и Sunset.

Мажорная версия API зафиксирована в пути: все публичные эндпойнты живут под /api/v1/. Ломающие изменения в рамках v1 не выпускаются — контракт проверяется на каждом деплое диффом OpenAPI-спек.

Текущая версия API возвращается в заголовке ответа api-version:

HTTP/1.1 200 OK
api-version: 1.0.0

Если операция помечена к выводу из эксплуатации, ответ дополняется заголовками Deprecation (unix-время объявления, RFC 9745) и Sunset (дата отключения, RFC 8594), а также ссылкой Link; rel="successor-version" на замену, когда она есть. История изменений API публикуется в changelog.