-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathswagger.yaml
202 lines (202 loc) · 4.61 KB
/
swagger.yaml
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
# servers:
# - url: http://localhost:3000
# components:
# securitySchemes:
# bearerAuth:
# type: http
# scheme: bearer
# security:
# - bearerAuth: []
paths:
/api/auth/signup:
post:
tags:
- default
summary: Register a user
requestBody:
content:
application/json:
schema:
type: object
example:
name: Muritala David
email: [email protected]
password: Famzer22@
img: ok
responses:
'200':
description: Successful response
content:
application/json: {}
/api/auth/verify:
post:
tags:
- default
summary: Verify A User
requestBody:
content:
application/json:
schema:
type: object
example:
token: >-
8aff3e468636878d22163d5122c38b87125bff813ec2d846a83f9cf03498d7a7
id: 4
responses:
'200':
description: Successful response
content:
application/json: {}
/api/auth/request-email-verification:
post:
tags:
- default
summary: Request Email Verification
requestBody:
content: {}
parameters:
- name: email
in: query
schema:
type: string
example: [email protected]
responses:
'200':
description: Successful response
content:
application/json: {}
/api/auth/request-password-reset:
post:
tags:
- default
summary: Request Reset Password
requestBody:
content: {}
security:
- bearerAuth: []
parameters:
- name: email
in: query
schema:
type: string
example: [email protected]
responses:
'200':
description: Successful response
content:
application/json: {}
/api/users:
put:
tags:
- default
summary: Update A User
requestBody:
content:
application/json:
schema:
type: object
example:
name: Bode Thomas
security:
- bearerAuth: []
responses:
'200':
description: Successful response
content:
application/json: {}
/api/auth/login:
post:
tags:
- default
summary: Login a user
requestBody:
content:
application/json:
schema:
type: object
example:
email: [email protected]
password: Famzer22@
responses:
'200':
description: Successful response
content:
application/json: {}
/api/auth/reset-password:
post:
tags:
- default
summary: Reset Password
requestBody:
content:
application/json:
schema:
type: object
example:
userId: 1
resetToken: >-
2db3c6ef4e116445ace1d8a5c582bd3098e4fc5a64b7bff33a47098a713908fa
password: passerBy22@
passwordConfirm: passerBy22@
responses:
'200':
description: Successful response
content:
application/json: {}
/api/posts/create:
post:
tags:
- default
summary: Create a post
requestBody:
content:
application/json:
schema:
type: object
example:
authorId: 4
title: Example
content: A content
security:
- bearerAuth: []
responses:
'200':
description: Successful response
content:
application/json: {}
/api/posts/publish/1:
put:
tags:
- default
summary: Publish Post
requestBody:
content: {}
responses:
'200':
description: Successful response
content:
application/json: {}
/api/posts/1:
get:
tags:
- default
summary: Get Post By Id
security:
- bearerAuth: []
responses:
'200':
description: Successful response
content:
application/json: {}
/api/posts:
get:
tags:
- default
summary: Get all posts
security:
- bearerAuth: []
responses:
'200':
description: Successful response
content:
application/json: {}