This repository has been archived by the owner on Aug 4, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
apihelp.py
55 lines (55 loc) · 1.66 KB
/
apihelp.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
apih = {
"/v1": "Shows the api rest version and all information of routes",
"/v1/vtuber": [
{
"/": "Shows all vtubers stored in the database",
"Is_it_a_protected_route": False,
"route_method": "GET",
"status_code": 200
},
{
"/random": "Select a random vtuber and shows her information",
"Is_it_a_protected_route": False,
"route_method": "GET",
"status_code": 200
},
{
"/{id}": "Shows vtuber's information by id",
"Is_it_a_protected_route": False,
"route_method": "GET",
"status_code": 200
},
{
"/create": "Creates a vtuber",
"Is_it_a_protected_route": True,
"route_method": "POST",
"status_code": 201
},
{
"/delete/{id}": "Delete a vtuber by id",
"Is_it_a_protected_route": True,
"route_method": "DELETE",
"status_code": 204
},
{
"/update/{id}": "Update the vtuber's information by id",
"Is_it_a_protected_route": True,
"route_method": "PUT",
"status_code": 200
}
],
"/v1/auth": [
{
"/signup": "Registers a user for the use of routes. By default [normal user]",
"Is_it_a_protected_route": True,
"route_method": "POST",
"status_code": 201
},
{
"/login": "Sign in to a registered user.",
"Is_it_a_protected_route": False,
"routed_method": "POST",
"status_code": 200
}
]
}