Aller au contenu

Autocomplétion sur le nom

GET
/v1/search
curl --request GET \
--url 'https://api-equides.org/v1/search?q=invictus%20du%20f&limite=10'

Renvoie des suggestions classées par pertinence, pour alimenter un champ de saisie.

À distinguer de /v1/equides?nom=…, qui filtre et pagine sans classer. Ici le coût est borné par limite et non par la popularité du préfixe : la réponse doit arriver avant la frappe suivante.

q
required
string
>= 1 characters

Début de nom, insensible à la casse et aux accents. Obligatoire et non vide.

Les espaces comptent : chaque mot déjà saisi doit se retrouver dans le nom, seul le dernier est traité comme un début de mot. INVICTUS DU F ne suggère donc que des noms portant INVICTUS, DU, et un mot commençant par F.

Example
invictus du f
limite
integer
default: 10 >= 1 <= 100

Nombre de suggestions (1 à 100, défaut 10). Une valeur hors bornes est ramenée au plafond, non refusée.

Example
10

Suggestions, de la plus pertinente à la moins.

Media typeapplication/json
object
limite
required
integer
q
required

Requête telle que reçue, pour que le client sache à quoi la réponse répond — les frappes arrivent dans le désordre.

string
resultats
required

De la suggestion la plus pertinente à la moins.

Array<object>
object
annee_naissance
integer
id
string
nom
string
race
string
score

Pertinence dans [0, 1] ; 1 pour une correspondance exacte de mot.

number
sexe
string
Examplegenerated
{
"limite": 1,
"q": "example",
"resultats": [
{
"annee_naissance": 1,
"id": "example",
"nom": "example",
"race": "example",
"score": 1,
"sexe": "example"
}
]
}

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

q manquant ou vide, ou paramètre inconnu.

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

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