Skip to content
This repository was archived by the owner on Feb 20, 2023. It is now read-only.
This repository was archived by the owner on Feb 20, 2023. It is now read-only.

Documentation des erreurs #1

@NonozgYtb

Description

@NonozgYtb

Il faut créer une page dans la docs où on retrouve la correspondance entre les erreurs communes (non spécifique à une route ou un groupe de route, cf. exemple 2) retournées par l'API et leurs significations.

Proposition :

Error Code Status Signification Docs
UNAUTHTICATED 401 L'accès à cette ressource demande une authentification. Concept : Authentification
UNAUTHORIZED 403 L'accès à cette ressource est restreint et demande des permissions que ce compte n'a pas.

Il serait préférable pour pour chaque route, les erreurs soient spécifiées.
Exemple avec la route imaginaire : POST /api/appel/:id_cours

Error Code Status Problème
UNAUTHORIZED 403 Seuls les catégories suivantes de membre peuvent modifier l'appel : Professeurs, CPE, Assistants d'éducations, Administrateur Etablissement
FINISHED_COURSE 403 Un appel ne peut pas être modifier plus de 3 heures (modifiable dans les configuration de l'ENT) après la fin d'un cours. Sauf pour les membres : Administrateur Etablissement

On peut ici remarquer l'erreur FINISHED_COURSE spécifique à la fiche des absences (date limite de modification de l'appel).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions