From 6ffd3ed53384e4011a4a32ccae9e4c6ce6cbd522 Mon Sep 17 00:00:00 2001
From: yann <yann@needsome.coffee>
Date: Tue, 10 Jun 2025 15:41:07 +0200
Subject: [PATCH] fixed style

---
 README.md | 87 ++++++++++++++++++++++++++++---------------------------
 1 file changed, 44 insertions(+), 43 deletions(-)

diff --git a/README.md b/README.md
index c81a9f7..2d5db36 100644
--- a/README.md
+++ b/README.md
@@ -74,8 +74,8 @@ User's management:
 
 ### *User create:* 
 
--> POST   /api/user/create/  
-<- 201_CREATED ; 400_BAD_REQUEST
+-> `POST /api/user/create/`  
+<- `201_CREATED` ; `400_BAD_REQUEST`
 ```
 params:
 
@@ -92,13 +92,13 @@ params:
 
 ### *User info:*
 *token required*  
--> GET   /api/user/   
-<- 200_OK with user's info 
+-> `GET   /api/user/`   
+<- `200_OK / data` 
 
 ### *User update:*  
 *token required*  
--> PATCH   /api/user/  
-<- 201_CREATED; 400_BAD_REQUEST
+-> `PATCH   /api/user/`  
+<- `201_CREATED`; `400_BAD_REQUEST`
 ```
 params:
 
@@ -111,8 +111,8 @@ params:
 
 ### *Password update:*  
 
--> GET /api/user/password-update/  
-<- 204_NO_CONTENT; 400_BAD_REQUEST
+-> `GET /api/user/password-update/`  
+<- `204_NO_CONTENT`; `400_BAD_REQUEST`
 ```
 params:
 
@@ -124,8 +124,8 @@ params:
 ### *Delete a user*  
 
 *token required*  
--> DELETE  /api/user/  
-<- 204_NO_CONTENT; 401_UNAUTHORIZED  
+-> `DELETE  /api/user/`  
+<- `204_NO_CONTENT`; `401_UNAUTHORIZED`  
 ```
 params:
 
@@ -136,8 +136,8 @@ params:
 
 ### *Get token*  
 
--> POST  /api/token/
-<- 200_OK
+-> `POST  /api/token/`  
+<- `200_OK`
 ```
 params
 {  
@@ -153,8 +153,8 @@ response
 ```
 ### *Refresh token*  
 
--> POST  /api/token/refresh/
-<- 200_OK
+-> `POST  /api/token/refresh/`  
+<- `200_OK`
 ```
 params
 {  
@@ -173,8 +173,8 @@ response
 Project:
 ---
 ### *Retrieve the list of projects*
--> GET /api/project/  
-<- 200_OK / data; 403_FORBIDDEN
+-> `GET /api/project/`  
+<- `200_OK / data`; `403_FORBIDDEN`
 ```
 querystrings
 
@@ -183,8 +183,8 @@ querystrings
 ```
 
 ### *Create a project*
--> POST /api/project/
-<- 200_OK / data; 403_FORBIDDEN
+-> `POST /api/project/`  
+<- `200_OK / data`; `403_FORBIDDEN`
 ```
 params:
 
@@ -209,13 +209,14 @@ params:
 ```
 ### *Get project's detail*
 *token required*  
--> GET /api/project/{id}/  
-<- 200_OK / data; 403_FORBIDDEN
+-> `GET /api/project/{id}/`  
+<- `200_OK / data`; `403_FORBIDDEN`
 
 ### *Update a project*
 *token required*  
--> PATCH /api/project/{id}/  
-<- 200_OK / data; 403_FORBIDDEN
+-> `PATCH /api/project/{id}/`  
+<- `200_OK / data`; `403_FORBIDDEN`
+```
 params:
 
 {  
@@ -236,12 +237,12 @@ params:
           },
   "description": str,
 }
-
+```
 ### *Add a contributor to a project*
 *token required*  
 
--> PATCH /api/project/{id}/contributor/  
-<- 202_ACCEPTED; 403_FORBIDDEN
+-> `PATCH /api/project/{id}/contributor/`  
+<- `202_ACCEPTED`; `403_FORBIDDEN`
 ```
 params:
 
@@ -251,20 +252,20 @@ params:
 ```
 ### *Delete a project*
 *token required*  
--> DELETE /api/project/{id}/  
-<- 204_NO_CONTENT; 403_FORBIDDEN
+-> `DELETE /api/project/{id}/`  
+<- `204_NO_CONTENT`; `403_FORBIDDEN`
 
 Issue:
 ---
 ### *List issues (where requestor is contributor)*
 *token required*  
--> GET /api/issue/  
-<- 200_OK
+-> `GET /api/issue/`  
+<- `200_OK`
 
 ### *Create an issue*
 *token required*  
--> POST /api/issue/
-<- 201_CREATED / data; 403_FORBIDDEN
+-> `POST /api/issue/`  
+<- `201_CREATED / data`; `403_FORBIDDEN`
 ```
 params:
 
@@ -312,28 +313,28 @@ params:
 ```
 ### *Update an issue*
 *token required*  
--> PATCH /api/issue/{id}/  
-<- 200_OK / data; 403_FORBIDDEN
+-> `PATCH /api/issue/{id}/`  
+<- `200_OK / data`; `403_FORBIDDEN`
 
 /!\ Only the author of an issue can affect it  
 (update to another author)
 
 ### *Delete an issue*
 *token required*  
--> DELETE /api/issue/{id}/  
-<- 204_NO_CONTENT; 403_FORBIDDEN
+-> `DELETE /api/issue/{id}/`  
+<- `204_NO_CONTENT`; `403_FORBIDDEN`
 
 ### *Retrieve contributors for a given issue*
 *token required*  
--> GET /api/issue/{id}/contributors/  
-<- 200_OK; 403_FORBIDDEN
+-> `GET /api/issue/{id}/contributors/`  
+<- `200_OK`; `403_FORBIDDEN`
 
 Comment:
 ---
 ### *Create a comment*
 *token required*  
--> POST /api/comment/
-<- 201_CREATED / data; 403_FORBIDDEN
+-> `POST /api/comment/`  
+<- `201_CREATED / data`; `403_FORBIDDEN`
 ```
 params:
 
@@ -346,13 +347,13 @@ params:
 
 ### *Update a comment*
 *token required*  
--> PATCH /api/comment/{id}/  
-<- 200_OK / data; 403_FORBIDDEN
+-> `PATCH /api/comment/{id}/`  
+<- `200_OK / data`; `403_FORBIDDEN`
 
 ### *Delete a comment*
 *token required*  
--> DELETE /api/comment/{id}/  
-<- 204_NO_CONTENT; 403_FORBIDDEN
+-> `DELETE /api/comment/{id}/`  
+<- `204_NO_CONTENT`; `403_FORBIDDEN`
 ___
 ## Author