Aller au contenu

Description OpenAPI de ce service

GET
/openapi.json
curl --request GET \
--url https://api-equides.org/openapi.json

La page de documentation est rendue depuis ce document : l’une ne peut pas diverger de l’autre.

Document OpenAPI 3.1.

Media typeapplication/json
object
Examplegenerated
{}

Contenu inchangé depuis l’ETag fourni en If-None-Match. Aucun corps, et rien n’est recalculé côté service.

Quota de débit dépassé pour l’adresse appelante. Retry-After indique le délai.

Media typeapplication/problem+json

Corps d’erreur conforme à la RFC 9457 (« Problem Details for HTTP APIs »), servi en application/problem+json. Les champs parametre et indice sont des extensions, que la RFC autorise.

object
detail
required

Explication propre à cette occurrence.

string
documentation
string
indice

Extension : piste de correction — valeurs admises, référentiel à consulter, ou paramètre le plus proche en cas de faute de frappe.

string
parametre

Extension : paramètre fautif, quand l’erreur en désigne un.

string
status
required
integer
title
required

Résumé lisible, stable pour un type donné.

string
type
required

URI du type de problème, relative — le client la résout contre l’URI de la requête. Elle pointe vers la section correspondante de la documentation.

string
Example
{
"detail": "paramètre inconnu `rase`",
"documentation": "https://docs.api-equides.org",
"indice": "vouliez-vous dire `race` ?",
"parametre": "rase",
"status": 400,
"title": "Paramètre invalide",
"type": "/#erreur-parametre-invalide"
}

Capacité de traitement simultané atteinte, délai maximal dépassé, ou données non chargées. Retry-After indique le délai.

Media typeapplication/problem+json

Corps d’erreur conforme à la RFC 9457 (« Problem Details for HTTP APIs »), servi en application/problem+json. Les champs parametre et indice sont des extensions, que la RFC autorise.

object
detail
required

Explication propre à cette occurrence.

string
documentation
string
indice

Extension : piste de correction — valeurs admises, référentiel à consulter, ou paramètre le plus proche en cas de faute de frappe.

string
parametre

Extension : paramètre fautif, quand l’erreur en désigne un.

string
status
required
integer
title
required

Résumé lisible, stable pour un type donné.

string
type
required

URI du type de problème, relative — le client la résout contre l’URI de la requête. Elle pointe vers la section correspondante de la documentation.

string
Example
{
"detail": "paramètre inconnu `rase`",
"documentation": "https://docs.api-equides.org",
"indice": "vouliez-vous dire `race` ?",
"parametre": "rase",
"status": 400,
"title": "Paramètre invalide",
"type": "/#erreur-parametre-invalide"
}