Développer · Contrats

Contrats de réponse

Chaque réponse de REPERES suit un contrat versionné. Son schéma JSON est généré depuis le code qui la produit : la documentation ne peut pas s'en écarter, et les cas de référence des simulateurs sont validés contre lui à chaque version.

Contrats publiés

Règles de version

Version déclarée
Chaque réponse porte son contrat dans schema_version. Un contrat inconnu ne doit pas être interprété.
Évolution compatible
Un champ peut être ajouté sans changer de version : un client ignore les champs qu'il ne connaît pas.
Rupture
Renommer, retirer ou changer le sens d'un champ crée une nouvelle version (v2) ; l'ancienne reste servie le temps de la transition.
Montants
Décimal exact transmis en texte ("1867.02"), jamais en nombre flottant ; à convertir avec un type décimal.
Statut
Une valeur de référence porte status (ok, depends, ambiguous, not_found, revalorisation_attendue, technical_error) ; une simulation porte statut (ok, partiel, erreur). Les valeurs d'Étalon utilisées par un calcul sont toujours dans valeurs.
Absence
Un champ facultatif absent ou null n'est jamais remplacé par une valeur par défaut : le statut et le message disent pourquoi.
Contrats · REPERES