DémarrageErreurs

Erreurs

L’API renvoie toujours du JSON. Deux formats coexistent selon la famille d’endpoints :

Format A — handlers principaux

{ "error": "<message>" }

Utilisé par : users, promotions, projects, holidays, promo-configs, discord-users, gitea, toad, piscine, specialty.

Format B — endpoints Discord

{
  "success": false,
  "message": "<message>"
}

Utilisé par : /discord/technologies, /discord/:name/config, /discord/config/full, /discord/forbidden-schools, /discord/job-queries.

Les réponses succès de la famille Discord ont elles aussi un wrapper : { "success": true, "<resource>": ... }.

Codes HTTP

CodeCas d’usage
200Succès (lecture / mise à jour)
201Ressource créée
204Succès sans corps (suppression)
302Redirection (utilisé par GET / → /docs/)
400Paramètre manquant ou invalide / nom de champ Discord hors liste blanche
401Non utilisé. Le middleware d’auth renvoie 400 ou 403 (cf. ci-dessous)
403Token rejeté par Gitea OU compte non-admin
404Ressource non trouvée (NotFoundError) / spécialité inconnue
409Conflit (ConflictError, ex. clé déjà existante)
500Erreur serveur (Postgres, GraphQL Hasura 01 Edu, Gitea injoignable)

Exemples

Format A

curl $API/api/v1/promotions/abc/students
{ "error": "Requête invalide : 'eventId' doit être fourni." }

Format B

curl $API/api/v1/discord/inexistant/config
{
  "success": false,
  "message": "Le champ 'inexistant' n'est pas autorisé."
}

Sources

  • src/core/errors/conflict.error.ts
  • src/core/errors/not-found.error.ts
  • src/utils/token.ts (codes 400/403/500 du middleware d’auth)

Détecter les erreurs côté client

const r = await fetch(`${API}/api/v1/promotions/72/students`);
if (!r.ok) {
  const body = await r.json();
  // Format A vs B
  const msg = body.error ?? body.message ?? "Erreur inconnue";
  throw new Error(`HTTP ${r.status}: ${msg}`);
}
CORSVersioning