Wersjonowanie i wycofywanie API
VaultPAM stosuje wersjonowanie głównej wersji w ścieżce dla publicznych API HTTP.
Model wersjonowania
- Zmiany dodatkowe pozostają w bieżącej wersji głównej.
- Zmiany niezgodne wstecz wymagają nowej ścieżki głównej, takiej jak
/api/v2/. - Bieżącą publiczną wersją główną jest
v1.
Zmiany niezgodne wstecz
Zmiana jest niezgodna wstecz, gdy usuwa lub zawęża istniejący kontrakt klienta, na przykład:
- usuwa punkt końcowy lub metodę HTTP,
- czyni opcjonalne pole żądania wymaganym,
- usuwa pole odpowiedzi używane przez istniejących klientów,
- zmienia typ pola w sposób niezgodny,
- zaostrza reguły uwierzytelniania lub dostępu w sposób, który psuje udokumentowanych klientów.
Wycofywanie i wygaszanie
- Wycofywane operacje są oznaczane w kontrakcie API.
- Informacje o wydaniu zawierają wskazówki dotyczące migracji w tym samym wydaniu, które wprowadza wycofanie.
- Wycofywane zachowanie pozostaje dostępne przez co najmniej dwa oznaczone wydania produkcyjne przed usunięciem.
- Daty wygaszania są ogłaszane z wyprzedzeniem, aby klienci mogli zaplanować migrację.
Wsparcie migracji
Gdy API ulega zmianie, ścieżka zastępcza powinna być udokumentowana wraz z informacją o wycofaniu. Klienci nie powinni zgadywać, do którego punktu końcowego lub formatu danych przejść w następnej kolejności.
Potrzebujesz pomocy?
Skorzystaj z aktualnej dokumentacji API, aby poznać bieżące szczegóły punktów końcowych, oraz z informacji o wydaniu, aby poznać zmiany wpływające na aktualizacje.