Yann/Projet10
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fixed style

Browse Source
This commit is contained in:
yann 2025-06-10 15:41:07 +02:00
parent a4c876132e
commit 6ffd3ed533
1 changed files with 44 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
README.md
View File

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