Versionarea API și Retragerea
VaultPAM utilizează versionare în cale pentru API-uri HTTP publice.
Model de versionare
- Modificările aditive rămân în versiunea majoră curentă.
- Modificările care rup compatibilitatea necesită o nouă cale majoră, cum ar fi
/api/v2/. - Versiunea majoră publică curentă este
v1.
Modificări care rup compatibilitatea
O modificare rup compatibilitatea atunci când elimină sau restrânge un contract de client existent, cum ar fi:
- eliminarea unui endpoint sau a unei metode HTTP,
- transformarea unui câmp de cerere opțional în obligatoriu,
- eliminarea unui câmp de răspuns pe care clienții existenți îl utilizează,
- modificarea unui tip de câmp într-un mod incompatibil,
- restricționarea regulilor de autentificare sau acces într-un mod care rup clienții documentați.
Retragere și sunset
- Operațiunile retrase sunt marcate în contractul API.
- Notele de lansare includ îndrumări de migrare în aceeași lansare care introduce retragerea.
- Comportamentul retras rămâne disponibil pentru cel puțin două lansări de producție etichetate înainte de eliminare.
- Datele de sunset sunt anunțate în avans, astfel încât clienții să-și poată planifica migrarea.
Suport pentru migrare
Atunci când un API se modifică, calea de înlocuire trebuie documentată alături de notificarea de retragere. Clienții nu ar trebui să ghicească către care endpoint sau formă de sarcină utilă să se mute în continuare.
Aveți nevoie de ajutor?
Utilizați referința API live pentru detaliile endpoint-ului curent și notele de lansare pentru modificări care afectează upgrade-urile.