-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi.yaml
367 lines (367 loc) · 9.64 KB
/
openapi.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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
openapi: 3.0.3
info:
title: Resume
description: API for curriculum management.
version: 1.0.0
servers:
- url: 'http://127.0.0.1:8000'
tags:
- name: user
description: Endpoint for create user.
- name: authentication
description: Endpoint for authentication.
- name: profile
description: User profile endpoint.
paths:
/signup/:
post:
tags:
- user
description: Signup.
operationId: signup
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Login'
'400':
description: Bad Request
content:
application/json:
schema:
type: boolean
example: false
requestBody:
$ref: '#/components/requestBodies/AccessData'
/login/:
post:
tags:
- authentication
description: Login.
operationId: login
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Login'
'400':
description: Bad Request
content:
application/json:
schema:
type: boolean
example: false
requestBody:
$ref: '#/components/requestBodies/AccessData'
/token/refresh/:
post:
tags:
- authentication
description: Update access token.
operationId: tokenRefresh
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TokenRefresh'
'400':
description: Bad Request
content:
application/json:
schema:
type: boolean
example: false
requestBody:
$ref: '#/components/requestBodies/TokenRefresh'
/profile/:
post:
tags:
- profile
description: Create a new profile user.
operationId: createProfile
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Profile'
'400':
description: Bad Request
requestBody:
$ref: '#/components/requestBodies/Profile'
get:
tags:
- profile
description: List all profiles.
operationId: getProfile
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Profile'
'401':
description: Unauthorized
content:
application/json:
schema:
properties:
detail:
type: string
example: Authentication credentials were not provided.
'403':
description: Forbidden
content:
application/json:
schema:
properties:
detail:
type: string
example: You do not have permission to perform this action.
security:
- bearerAuth: ["admin"]
/profile/{uuid}:
get:
tags:
- profile
description: List a specific profile.
operationId: getProfileDetailByUUID
parameters:
- name: uuid
in: path
description: UUID of profile to return.
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Profile'
'404':
description: Not Found
content:
application/json:
schema:
properties:
detail:
type: string
example: Not found.
put:
tags:
- profile
description: Update a specific profile.
operationId: updateProfileByUUID
parameters:
- name: uuid
in: path
description: UUID of profile to return.
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Profile'
'401':
description: Unauthorized
content:
application/json:
schema:
properties:
detail:
type: string
example: Authentication credentials were not provided.
'404':
description: Not Found
content:
application/json:
schema:
properties:
detail:
type: string
example: Not found.
security:
- bearerAuth: []
delete:
tags:
- profile
description: Completely delete a user profile.
operationId: deleteProfileByUUID
parameters:
- name: uuid
in: path
description: UUID of profile to return.
required: true
schema:
type: string
responses:
'204':
description: No Content
'401':
description: Unauthorized
content:
application/json:
schema:
properties:
detail:
type: string
example: Authentication credentials were not provided.
'404':
description: Not Found
content:
application/json:
schema:
properties:
detail:
type: string
example: Not found.
security:
- bearerAuth: []
components:
schemas:
Login:
type: object
properties:
refresh:
type: string
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxIiwibmFtZSI6IjEiLCJpYXQiOjF9.uql_1EDEK4ZUzltJ4cRLAGfjrhrmDwsbQtORY8UX0JY
access:
type: string
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIwIiwibmFtZSI6IjAiLCJpYXQiOjB9.uQ8GeRjJTwU5RTPlogcE_DJqDaC9HULIndL45619sTw
TokenRefresh:
type: object
properties:
access:
type: string
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIwIiwibmFtZSI6IjAiLCJpYXQiOjB9.uQ8GeRjJTwU5RTPlogcE_DJqDaC9HULIndL45619sTw
User:
type: object
properties:
first_name:
type: string
example: John
last_name:
type: string
example: Doe
email:
type: string
example: password
Profile:
type: object
properties:
name:
type: string
example: John Doe
occupation:
type: string
example: Software Engineer
contact_email:
type: string
example: email@email.com
location:
type: string
example: Sao Paulo, Brazil
phone:
type: string
example: '+55900000000'
social_link:
$ref: '#/components/schemas/SocialLink'
SocialLink:
type: object
properties:
github:
type: string
example: https://github.com/user
linkedin:
type: string
example: https://www.linkedin.com/in/user
twitter:
type: string
example: https://twitter.com/user
website:
type: string
example: https://example.com
requestBodies:
AccessData:
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: email@email.com.br
password:
type: string
example: password
description: Access data.
required: true
TokenRefresh:
content:
application/json:
schema:
type: object
properties:
refresh:
type: string
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxIiwibmFtZSI6IjEiLCJpYXQiOjF9.uql_1EDEK4ZUzltJ4cRLAGfjrhrmDwsbQtORY8UX0JY
description: Updated access token.
required: true
Profile:
content:
application/json:
schema:
type: object
properties:
user:
$ref: '#/components/schemas/User'
occupation:
type: string
example: Software Engineer
contact_email:
type: string
example: email@email.com
phone:
type: string
example: '+55900000000'
city:
type: string
example: Sao Paulo
country:
type: string
example: Brazil
social_link:
$ref: '#/components/schemas/SocialLink'
description: Updated a user profile.
required: true
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT