Publiczne API v0.3.0-preview.1 · OpenAPI 3.1.2

Wersjonowanie i deprecacja

Bieżące API v1 nie ma aktywnej deprecacji. Parametry dostępności i wsparcia wynikają z właściwej Umowy lub Zamówienia.

Major jest jawny w URI. Każda zmiana v1 wymaga compatibility review, wersji info.version, exact SHA-256, aktualizacji changelogu i regeneracji kontraktów.
Zmiany addytywne mogą wejść w ramach v1 tylko wtedy, gdy nie zmieniają istniejącej semantyki. Zmiana niekompatybilna wymaga nowego major, na przykład /api/v2, oraz przewodnika migracji.
Obecnie brak aktywnej deprecacji, dlatego odpowiedzi nie zawierają nagłówków Deprecation ani Sunset.
Po GA aktywacja deprecacji wymaga co najmniej 180 dni uprzedzenia i równoległego wsparcia. Deprecation zgodny z RFC 9745, Sunset zgodny z RFC 8594 oraz dokumentacja migracji muszą podawać spójne daty absolutne.

Klienci powinni tolerować nieznane pola odpowiedzi i eventów, ale nigdy nie ignorować błędów autoryzacji, precondition ani idempotency conflict.