-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.json
148 lines (145 loc) · 3.73 KB
/
swagger.json
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
{
"openapi": "3.0.3",
"info": {
"title": "CryptoDash",
"description": "Cryptocurrency information dashboard",
"license": {
"name": "MIT"
},
"version": "1.0.0"
},
"paths": {
"/signup": {
"post": {
"summary": "create user",
"description": "User sign up route, with email sending (send valid email)",
"tags": ["Authentication"],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"name ": {
"type": "string"
},
"email": {
"type": "string"
},
"password": {
"type": "string"
}
}
}
}
}
}
}
},
"/signin": {
"post": {
"summary": "Login",
"description": "User sign In route",
"tags": ["Authentication"],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"email": {
"type": "string"
},
"password": {
"type": "string"
}
}
}
}
}
}
}
},
"/signin/forgot_password": {
"post": {
"summary": "Forgot password",
"description": "Forgot password (Sending recovery token by user's email)",
"tags": ["Forgot password and reset password"],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"email": {
"type": "string"
}
}
}
}
}
}
}
},
"/signin/reset_password": {
"post": {
"summary": "Reset password",
"description": "Reset password (The token' field is to put the token that was sent by email and the 'password' field is where the user will put the new password)",
"tags": ["Forgot password and reset password"],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"token": {
"type": "string"
},
"email": {
"type": "string"
},
"password": {
"type": "string"
}
}
}
}
}
}
}
},
"/dashboard": {
"get": {
"summary": "Dashboard - ⚠️Private route, jwt token required⚠️",
"description": "Dashboard with information about the logged in user and cryptocurrencies.",
"tags": ["Dashboard"]
}
},
"/admin": {
"post": {
"summary": "Admin",
"description": "Sign in admin route",
"tags": ["Administrator"],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"email": {
"type": "string"
},
"password": {
"type": "string"
}
}
}
}
}
}
}
},
"/admin/users": {
"get": {
"summary": "Admin dashboard (⚠️Private route only administrator users access and need the jwt token⚠️)",
"description": "Admin dashboard",
"tags": ["Administrator"]
}
}
}
}