Versions et compatibilité
Objectif
Savoir ce qui peut changer sans préavis et ce qui ne le peut pas.
Version dans le chemin
La version majeure figure dans le chemin : /api/mobile/v1, /api/directory/v1. Un changement incompatible produit une nouvelle version majeure, il ne modifie pas la version existante.
Ce qui peut être ajouté sans préavis
Un nouveau champ dans une réponse, un nouveau point de terminaison, une nouvelle valeur d'énumération documentée comme extensible. Un client doit donc ignorer les champs qu'il ne connaît pas plutôt que d'échouer.
Ce qui ne change pas dans une version majeure
La suppression d'un champ, le changement de type d'un champ existant, ou la modification du sens d'un code d'erreur. Ces évolutions relèvent d'une nouvelle version majeure.
Dépréciation
Une version dépréciée reste servie pendant une période annoncée, afin de laisser aux intégrations le temps de migrer.
Cette page vous a-t-elle aidé ?
Toujours bloqué ? Écrivez au support : support@modernschools.online