Aller au contenu

Provenance, licence et qualité de la donnée servie

GET
/v1/meta
curl --request GET \
--url https://api-equides.org/v1/meta

La réutilisation impose de mentionner la source et la date de mise à jour : source, ingere_le et empreinte_source y pourvoient.

Les remarques énoncent les défauts connus de la source et le régime de réutilisation applicable.

Métadonnées du jeu de données chargé.

Media typeapplication/json
object
jeu_de_donnees
required

Provenance de l’extraction servie. source et ingere_le sont ce que la mention obligatoire de réutilisation doit citer.

object
anomalies

Défauts de la source, dénombrés à l’ingestion et conservés tels quels : cette API est un miroir fidèle, pas un correcteur.

object
annee_naissance_absente
integer
annee_naissance_max
integer | null
annee_naissance_min
integer | null
identifiants_illisibles
integer
parents_pendants

Parents référencés mais absents du fichier : le lien est rompu, et exposé comme une absence de parent.

integer
robe_absente
integer
sans_filiation
integer
slugs_non_deductibles
integer
empreinte_source

Empreinte blake3 du fichier source : elle identifie exactement l’extraction servie.

string
ingere_le

Date d’ingestion, ISO 8601.

string
licence
string
lignes
integer
producteur
string
source
string
url_modele

Gabarit reconstruisant l’URL publique d’une fiche.

string
remarques
required

Précisions sur la donnée, son régime de réutilisation et ses défauts connus, que la fiche du producteur ne porte pas.

Array<string>
version_api
required
string
Examplegenerated
{
"jeu_de_donnees": {
"anomalies": {
"annee_naissance_absente": 1,
"annee_naissance_max": 1,
"annee_naissance_min": 1,
"identifiants_illisibles": 1,
"parents_pendants": 1,
"robe_absente": 1,
"sans_filiation": 1,
"slugs_non_deductibles": 1
},
"empreinte_source": "example",
"ingere_le": "example",
"licence": "example",
"lignes": 1,
"producteur": "example",
"source": "example",
"url_modele": "example"
},
"remarques": [
"example"
],
"version_api": "example"
}

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"
}