API-versiebeheer en afschaffing
VaultPAM maakt gebruik van path-major versioning voor openbare HTTP API's.
Versiemodel
- Additieve wijzigingen blijven in de huidige hoofdversie.
- Wijzigingen die niet compatibel zijn, vereisen een nieuw hoofdpad zoals
/api/v2/. - De huidige openbare hoofdversie is
v1.
Wijzigingen die niet compatibel zijn
Een wijziging is niet compatibel wanneer deze een bestaand clientcontract verwijdert of beperkt, zoals:
- verwijdering van een eindpunt of HTTP-methode,
- een optioneel aanvraagveld verplicht maken,
- verwijdering van een reactieveld dat bestaande clients gebruiken,
- een veldtype op een onverenigbare manier wijzigen,
- verificatie- of toegangsregels aanscherpen op een manier die gedocumenteerde clients breekt.
Afschaffing en vervaldatum
- Afgeschafte bewerkingen zijn gemarkeerd in het API-contract.
- Releaseopmerkingen bevatten migratierichtlijnen in dezelfde release waarin de afschaffing wordt geïntroduceerd.
- Afgeschaft gedrag blijft beschikbaar voor minstens twee getagde productiereleases voordat het wordt verwijderd.
- Vervaldatums worden van tevoren aangekondigd zodat klanten hun migratie kunnen plannen.
Migratieondersteuning
Wanneer een API verandert, moet het vervangingspad naast de afschaffingskennisgeving worden gedocumenteerd. Klanten hoeven niet te raden naar welk eindpunt of payload-indeling ze vervolgens moeten gaan.
Hulp nodig?
Gebruik de live API-referentie voor huidige eindpuntdetails en de releaseopmerkingen voor wijzigingen die van invloed zijn op upgrades.