From 6d9a838eea84f701d3c191b4258cd158f7d34553 Mon Sep 17 00:00:00 2001 From: jboinembalome Date: Mon, 30 Nov 2020 15:46:17 +0100 Subject: [PATCH] Ajout d'exemples pour les responses --- responses/erreur/forbidden.yaml | 7 +++++-- responses/erreur/internalServerError.yaml | 5 ++++- responses/erreur/notfound.yaml | 5 ++++- responses/erreur/unauthorized.yaml | 5 ++++- responses/erreur/unsupportedMediaType.yaml | 5 ++++- 5 files changed, 21 insertions(+), 6 deletions(-) diff --git a/responses/erreur/forbidden.yaml b/responses/erreur/forbidden.yaml index 123b03b..1c4bc41 100644 --- a/responses/erreur/forbidden.yaml +++ b/responses/erreur/forbidden.yaml @@ -1,5 +1,8 @@ -description: Acces interdit +description: L’utilisateur souhaitant accéder à la ressource n’a pas les droits d’accès suffisants content: application/json: schema: - $ref: ../../schemas/erreur/erreur.yaml \ No newline at end of file + $ref: ../../schemas/erreur/erreur.yaml + example: + code: 403 + message: Le serveur comprend la requête mais refuse de l'autoriser. \ No newline at end of file diff --git a/responses/erreur/internalServerError.yaml b/responses/erreur/internalServerError.yaml index 7ae61e0..03cc226 100644 --- a/responses/erreur/internalServerError.yaml +++ b/responses/erreur/internalServerError.yaml @@ -2,4 +2,7 @@ description: Une erreur est survenue sur le serveur content: application/json: schema: - $ref: ../../schemas/erreur/erreur.yaml \ No newline at end of file + $ref: ../../schemas/erreur/erreur.yaml + example: + code: 500 + message: Le serveur a rencontré un problème inattendu qui l'empêche de répondre à la requête \ No newline at end of file diff --git a/responses/erreur/notfound.yaml b/responses/erreur/notfound.yaml index 04d0c1c..5278b39 100644 --- a/responses/erreur/notfound.yaml +++ b/responses/erreur/notfound.yaml @@ -2,4 +2,7 @@ description: La ressource n'a pas été trouvée content: application/json: schema: - $ref: ../../schemas/erreur/erreur.yaml \ No newline at end of file + $ref: ../../schemas/erreur/erreur.yaml + example: + code: 404 + message: Le serveur ne peut pas trouver la ressource demandée \ No newline at end of file diff --git a/responses/erreur/unauthorized.yaml b/responses/erreur/unauthorized.yaml index 40fa1cd..ebc5a72 100644 --- a/responses/erreur/unauthorized.yaml +++ b/responses/erreur/unauthorized.yaml @@ -2,4 +2,7 @@ description: L'utilisateur souhaitant accéder à la ressource n'est pas authent content: application/json: schema: - $ref: ../../schemas/erreur/erreur.yaml \ No newline at end of file + $ref: ../../schemas/erreur/erreur.yaml + example: + code: 401 + message: La requête n'a pas été effectuée car il manque des informations d'authentification valides pour la ressource visée \ No newline at end of file diff --git a/responses/erreur/unsupportedMediaType.yaml b/responses/erreur/unsupportedMediaType.yaml index 78548db..24cc68f 100644 --- a/responses/erreur/unsupportedMediaType.yaml +++ b/responses/erreur/unsupportedMediaType.yaml @@ -2,4 +2,7 @@ description: L’opération ne peut pas être effectuée car certaines données content: application/json: schema: - $ref: ../../schemas/erreur/erreur.yaml \ No newline at end of file + $ref: ../../schemas/erreur/erreur.yaml + example: + code: 415 + message: Le serveur refuse la requête car le format de la charge utile (payload) n'est pas pris en charge \ No newline at end of file