forked from skypro-backend/example-for-graduate-work
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
606 lines (601 loc) · 15.9 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
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
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
openapi: 3.0.3
info:
title: Ads app API Documentation
version: '1.0'
servers:
- url: http://localhost:8080
paths:
/users/set_password:
post:
tags:
- Пользователи
summary: 'Обновление пароля'
operationId: setPassword
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NewPassword'
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/users/me:
get:
tags:
- Пользователи
summary: 'Получить информацию об авторизованном пользователе'
operationId: getUser
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/User'
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
patch:
tags:
- Пользователи
summary: 'Обновить информацию об авторизованном пользователе'
operationId: updateUser
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/User'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'204':
description: No Content
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/users/me/image:
patch:
tags:
- Пользователи
summary: 'Обновить аватар авторизованного пользователя'
operationId: updateUserImage
requestBody:
content:
multipart/form-data:
schema:
required:
- image
type: object
properties:
image:
type: string
format: binary
responses:
'200':
description: OK
'404':
description: Not Found
/register:
post:
tags:
- Регистрация
summary: 'Регистрация пользователя'
operationId: register
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterReq'
responses:
'404':
description: Not Found
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
/login:
post:
tags:
- Авторизация
summary: 'Авторизация пользователя'
operationId: login
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoginReq'
responses:
'200':
description: OK
'404':
description: Not Found
'401':
description: Unauthorized
'403':
description: Forbidden
/ads:
get:
tags:
- Объявления
operationId: getAllAds
summary: 'Получить все объявления'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseWrapperAds'
post:
tags:
- Объявления
summary: 'Добавить объявление'
operationId: addAd
requestBody:
content:
multipart/form-data:
schema:
required:
- image
- properties
type: object
properties:
properties:
$ref: '#/components/schemas/CreateAds'
image:
type: string
format: binary
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Ads'
'404':
description: Not Found
'403':
description: Forbidden
'401':
description: Unauthorized
/ads/{id}/comments:
get:
tags:
- Комментарии
summary: 'Получить комментарии объявления'
operationId: getComments
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseWrapperComment'
'404':
description: Not Found
post:
tags:
- Комментарии
summary: 'Добавить комментарий к объявлению'
operationId: addComment
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
'404':
description: Not Found
'403':
description: Forbidden
'401':
description: Unauthorized
/ads/{id}:
get:
tags:
- Объявления
summary: 'Получить информацию об объявлении'
operationId: getAds
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/FullAds'
'404':
description: Not Found
delete:
tags:
- Объявления
summary: 'Удалить объявление'
operationId: removeAd
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
responses:
'204':
description: No Content
'401':
description: Unauthorized
'403':
description: Forbidden
patch:
tags:
- Объявления
summary: 'Обновить информацию об объявлении'
operationId: updateAds
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAds'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Ads'
'404':
description: Not Found
'403':
description: Forbidden
'401':
description: Unauthorized
/ads/{adId}/comments/{commentId}:
delete:
tags:
- Комментарии
summary: 'Удалить комментарий'
operationId: deleteComment
parameters:
- name: adId
in: path
required: true
schema:
type: integer
format: int32
- name: commentId
in: path
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
'404':
description: Not Found
'403':
description: Forbidden
'401':
description: Unauthorized
patch:
tags:
- Комментарии
summary: 'Обновить комментарий'
operationId: updateComment
parameters:
- name: adId
in: path
required: true
schema:
type: integer
format: int32
- name: commentId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
responses:
'200':
description: OK
content:
'application/json':
schema:
$ref: '#/components/schemas/Comment'
'404':
description: Not Found
'403':
description: Forbidden
'401':
description: Unauthorized
/ads/me:
get:
tags:
- Объявления
summary: 'Получить объявления авторизованного пользователя'
operationId: getAdsMe
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseWrapperAds'
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
/ads/{id}/image:
patch:
tags:
- Объявления
summary: 'Обновить картинку объявления'
operationId: updateImage
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
multipart/form-data:
schema:
required:
- image
type: object
properties:
image:
type: string
format: binary
responses:
'200':
description: OK
content:
application/octet-stream:
schema:
type: array
items:
type: string
format: byte
'404':
description: Not Found
components:
schemas:
NewPassword:
type: object
properties:
currentPassword:
type: string
description: 'текущий пароль'
newPassword:
type: string
description: 'новый пароль'
RegisterReq:
type: object
properties:
username:
type: string
description: 'логин'
password:
type: string
description: 'пароль'
firstName:
type: string
description: 'имя пользователя'
lastName:
type: string
description: 'фамилия пользователя'
phone:
type: string
description: 'телефон пользователя'
role:
type: string
description: 'роль пользователя'
enum:
- USER
- ADMIN
LoginReq:
type: object
properties:
password:
type: string
description: 'пароль'
username:
type: string
description: 'логин'
CreateAds:
required:
- description
- price
- title
type: object
properties:
description:
type: string
description: 'описание объявления'
price:
type: integer
format: int32
description: 'цена объявления'
title:
type: string
description: 'заголовок объявления'
Ads:
type: object
properties:
author:
type: integer
format: int32
description: 'id автора объявления'
image:
type: string
description: 'ссылка на картинку объявления'
pk:
type: integer
format: int32
description: 'id объявления'
price:
type: integer
format: int32
description: 'цена объявления'
title:
type: string
description: 'заголовок объявления'
Comment:
type: object
properties:
author:
type: integer
format: int32
description: 'id автора комментария'
authorImage:
type: string
description: 'ссылка на аватар автора комментария'
authorFirstName:
type: string
description: 'имя создателя комментария'
createdAt:
type: integer
format: int64
description: 'дата и время создания комментария в миллисекундах с 00:00:00 01.01.1970'
pk:
type: integer
format: int32
description: 'id комментария'
text:
type: string
description: 'текст комментария'
User:
type: object
properties:
id:
type: integer
format: int32
description: 'id пользователя'
email:
type: string
description: 'логин пользователя'
firstName:
type: string
description: 'имя пользователя'
lastName:
type: string
description: 'фамилия пользователя'
phone:
type: string
description: 'телефон пользователя'
image:
type: string
description: 'ссылка на аватар пользователя'
ResponseWrapperAds:
type: object
properties:
count:
type: integer
format: int32
description: 'общее количество объявлений'
results:
type: array
items:
$ref: '#/components/schemas/Ads'
FullAds:
type: object
properties:
pk:
type: integer
format: int32
description: 'id объявления'
authorFirstName:
type: string
description: 'имя автора объявления'
authorLastName:
type: string
description: 'фамилия автора объявления'
description:
type: string
description: 'описание объявления'
email:
type: string
description: 'логин автора объявления'
image:
type: string
description: 'ссылка на картинку объявления'
phone:
type: string
description: 'телефон автора объявления'
price:
type: integer
format: int32
description: 'цена объявления'
title:
type: string
description: 'заголовок объявления'
ResponseWrapperComment:
type: object
properties:
count:
type: integer
format: int32
description: 'общее количество комментариев'
results:
type: array
items:
$ref: '#/components/schemas/Comment'