forked from peter-evans/swagger-github-pages
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
528 lines (528 loc) · 12.8 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
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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
openapi: 3.0.1
info:
title: TikTok System
description: UNQ app
version: '1.0'
paths:
/login:
post:
tags:
- Auth
summary: Post login
description: Retorna el usuario que satisfaga las credenciales
operationId: postLogin
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserLoginDTO'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserDTO'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
/user:
get:
tags:
- User
summary: Get user
description: Retorna el usuario logueado
operationId: getUser
parameters:
- name: Authorization
in: header
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserDTO'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
/user/{id}:
get:
tags:
- User
summary: Get user with id
description: Retorna el usuario pasado como parametro
operationId: getUserWithId
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserDTO'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
/user/{id}/follow:
put:
tags:
- User
summary: Put user with id follow
description: Agrega/quita al usuario pasado por parametro como follower
operationId: putUserWithIdFollow
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: Authorization
in: header
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserDTO'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
/post/{id}:
get:
tags:
- Post
summary: Get post with id
description: Retorna el post pasado por parametro
operationId: getPostWithId
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PostDTO'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
/post/{id}/comment:
post:
tags:
- Post
summary: Post post with id comment
description: Agrega un comentario en el post pasado por parametro
operationId: postPostWithIdComment
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: Authorization
in: header
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NewCommentDTO'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PostDTO'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
/post/{id}/like:
put:
tags:
- Post
summary: Put post with id like
description: Agraga/quita like a un post pasado por parametro
operationId: putPostWithIdLike
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: Authorization
in: header
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PostDTO'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
/search:
get:
tags:
- Search
summary: Get search
description: Busca segun la query pasador por query param (Tener en cuenta que pasa cuando la query viene vacia o no viene)
operationId: getSearch
parameters:
- name: query
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SearchResultDTO'
/trends:
get:
tags:
- Trends
summary: Get trends
description: Retorna la lista de los topicos mas usados
operationId: getTrends
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: string
/trends/{trendName}:
get:
tags:
- Trends
summary: Get trends with trendname
description: Retorna los post del topico pasado por parametro
operationId: getTrendsWithTrendname
parameters:
- name: trendName
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SimplePostDTO'
/recommendAccounts:
get:
tags:
- Recommend accounts
summary: Get recommendaccounts
description: Retorna los usuarios recomendados, tener en cuenta que el header puede o no estar y esto cambia los recomendados que se muestran al usuario
operationId: getRecommendaccounts
parameters:
- name: Authorization
in: header
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SimpleUserDTO'
/timeline:
get:
tags:
- Timeline
summary: Get timeline
description: Retorna el timeline de un usuario
operationId: getTimeline
parameters:
- name: Authorization
in: header
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SimpleUserDTO'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
/latestPosts:
get:
tags:
- Post
summary: Get latestposts
description: Retorna los ultimos post agregados
operationId: getLatestposts
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SimplePostDTO'
components:
schemas:
UserLoginDTO:
required:
- password
- username
type: object
properties:
username:
type: string
password:
type: string
SimplePostDTO:
required:
- description
- id
- likes
- title
- video
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
video:
type: string
likes:
type: array
items:
$ref: '#/components/schemas/SimpleUserDTO'
SimpleUserDTO:
required:
- id
- image
- username
type: object
properties:
id:
type: string
username:
type: string
image:
type: string
UserDTO:
required:
- email
- followers
- following
- id
- image
- posts
- username
type: object
properties:
id:
type: string
username:
type: string
email:
type: string
image:
type: string
followers:
type: array
items:
$ref: '#/components/schemas/SimpleUserDTO'
following:
type: array
items:
$ref: '#/components/schemas/SimpleUserDTO'
posts:
type: array
items:
$ref: '#/components/schemas/SimplePostDTO'
ErrorDTO:
required:
- message
type: object
properties:
message:
type: string
CommentDTO:
required:
- id
- text
- user
type: object
properties:
id:
type: string
text:
type: string
user:
$ref: '#/components/schemas/SimpleUserDTO'
PostDTO:
required:
- comments
- description
- id
- likes
- title
- video
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
video:
type: string
likes:
type: array
items:
$ref: '#/components/schemas/SimpleUserDTO'
comments:
type: array
items:
$ref: '#/components/schemas/CommentDTO'
NewCommentDTO:
required:
- text
type: object
properties:
text:
type: string
SearchResultDTO:
required:
- posts
- users
type: object
properties:
users:
type: array
items:
$ref: '#/components/schemas/SimpleUserDTO'
posts:
type: array
items:
$ref: '#/components/schemas/SimplePostDTO'