meeting-planner/backend
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add status code to responses

Browse Source
This commit is contained in:
rui hildt 2020-03-23 18:02:50 +01:00
parent d0a8c17089
commit 8f6dab9cae
1 changed files with 33 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
research/API Documentation.md
View File

@ -36,12 +36,15 @@ A json object for the registered user with `id`, `username`, `email`, `timezone`
``` ```
{ {
"status": 201,
"data": {
"id": 1, "id": 1,
"username": "jean", "username": "jean",
"email": "jean@example.com", "email": "jean@example.com",
"timezone": "Europe/Brussels", "timezone": "Europe/Brussels",
"earliest_time":"09:30 AM", "earliest_time":"09:30 AM",
"latest_time":"10:00 PM" "latest_time":"10:00 PM"l
}
} }
``` ```
@ -64,6 +67,8 @@ A json object for the registered user with `id`, `username`, `email`, `timezone`
``` ```
{ {
"status": 200,
"data": {
"id": 1, "id": 1,
"username": "jean", "username": "jean",
"email": "jean@example.com", "email": "jean@example.com",
@ -71,6 +76,7 @@ A json object for the registered user with `id`, `username`, `email`, `timezone`
"earliest_time":"09:30 AM", "earliest_time":"09:30 AM",
"latest_time":"10:00 PM" "latest_time":"10:00 PM"
} }
}
``` ```
#### Delete an account #### Delete an account
@ -90,9 +96,13 @@ A json object for the deleted user with `username` and `email`.
``` ```
{ {
"status": 200,
"data": {
"id": 15,
"username": "jean", "username": "jean",
"email": "jean@example.com" "email": "jean@example.com"
} }
}
``` ```
#### Log in an account #### Log in an account
@ -113,11 +123,14 @@ A json object for the registered user with `id`, `username`, `email`, `timezone`
``` ```
{ {
"status": 201,
"data": {
"id": 1, "id": 1,
"username": "jean", "username": "jean",
"email": "jean@example.com", "email": "jean@example.com",
"timezone": "Europe/Brussels", "timezone": "Europe/Brussels",
"earliest_time":"09:30 AM", "earliest_time":"09:30 AM",
"latest_time":"10:00 PM" "latest_time":"10:00 PM"l
}
} }
``` ```