Versions de l'API

La version de l'API est dans le chemin : /v1.

Ce qui ne casse pas /v1

• nouveaux endpoints ;
• nouveaux champs facultatifs dans les requêtes ;
• nouveaux champs dans les réponses ;
• nouveaux codes d'erreur ou d'avertissement ;
• nouveaux messages (le texte de message n'est pas contractuel).

Votre client doit donc ignorer les champs qu'il ne connaît pas et traiter un code inconnu comme une erreur générique.

Ce qui demanderait /v2

Supprimer ou renommer un champ, changer le sens d'un code d'erreur, changer un code HTTP.

Deux versions distinctes

La version de l'API (/v1) décrit la forme des requêtes. La version de la spécification (spec_version) décrit les règles du fichier officiel. Elles évoluent séparément : voir la page suivante.

La référence OpenAPI est sur /reference et le schéma brut sur /openapi.json.