Schemas: health
Schemas whose first using operation belongs to the health family. A shared schema is described once, here, and linked from every operation that uses it.
Descriptions come from the contract, which is written in French. They are reproduced verbatim so that the contract remains the source of truth.
DependencyState
Etat d'une dependance de fondation.
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
error_code | string | null | no | Code d'erreur stable si la sonde a echoue. | |
latency_ms | number | yes | Duree de la sonde en millisecondes. | |
name | string | yes | Nom technique de la dependance. | |
status | "up" | "down" | yes | Disponibilite observee. |
Used by : healthReady
Environment
Environnements d'execution reconnus (Revision 1, section 8.1).
Type : string
Allowed values : local, shared_dev, staging, production
Used by : serviceVersion
LivenessResponse
Reponse de la sonde de vivacite.
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
environment | string | yes | Environnement declare par la configuration. | |
revision | string | null | yes | Revision Git de l'artefact deploye ; null hors deploiement. | |
service | string | yes | Nom technique du service. | |
status | "alive" | yes | Le processus API repond. | |
version | string | yes | Version du paquet API. |
Used by : healthLive
ReadinessResponse
Reponse de la sonde d'aptitude au trafic.
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
dependencies | array<DependencyState> | yes | Etat de chaque dependance de fondation reellement interrogee. | |
revision | string | null | yes | Revision Git de l'artefact deploye ; null hors deploiement. | |
service | string | yes | Nom technique du service. | |
status | "ready" | "not_ready" | yes | Aptitude globale du service. | |
version | string | yes | Version du paquet API. |
Used by : healthReady
VersionResponse
Version servie : produit, revision, environnement, contrat, moteur.
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
api_version | string | yes | Version majeure du contrat d'API, celle du chemin. | |
engine_version | string | null | yes | Version du moteur de decision enregistree avec chaque evaluation ; null pour CONTROL, qui n'execute pas le moteur. | |
environment | Environment | yes | Environnement declare par la configuration. | |
revision | string | null | yes | SHA Git abrege (12 caracteres) de l'artefact deploye ; null hors deploiement. | |
version | string | yes | Version produit (SemVer), source unique : fichier racine VERSION. |
Used by : serviceVersion