-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
682 lines (628 loc) · 15.5 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
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
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
swagger: "2.0"
info:
version: "1.0.0"
title: "todo app"
host: "localhost"
basePath: "/api"
schemes:
- "https"
- "http"
paths:
/user:
post:
tags: [user]
summary: Create user
operationId: "createUser"
parameters:
- in: body
name: credentials
required: true
schema:
type: object
required: [username, password, email]
properties:
username:
type: string
password:
type: string
format: password
email:
type: string
responses:
201:
description: User Created
schema:
allOf:
- $ref: "#/definitions/ResponseOk"
- type: object
properties:
result:
$ref: "#/definitions/User"
400:
$ref: "#/responses/InvalidInput"
default:
$ref: "#/responses/UnexpectedError"
get:
tags: [user]
summary: Get self
operationId: getSelf
security:
- BearerAuth: []
responses:
200:
description: User found
schema:
$ref: "#/definitions/User"
default:
$ref: "#/responses/UnexpectedError"
delete:
tags: [user]
summary: Delete self
operationId: deleteSelf
security:
- BearerAuth: []
responses:
200:
$ref: "#/responses/Successfully"
403:
$ref: "#/responses/NoAccessEntity"
default:
$ref: "#/responses/UnexpectedError"
/user/password:
put:
tags: [ user ]
summary: Update self
operationId: updateSelf
parameters:
- name: dto
in: body
required: true
schema:
type: object
required: [ password ]
properties:
actual_password:
description: Current password
type: string
format: password
new_password:
x-nullable: true
type: string
format: password
security:
- BearerAuth: [ ]
responses:
200:
$ref: "#/responses/Successfully"
400:
$ref: "#/responses/InvalidInput"
403:
description: Password incorrect
schema:
$ref: "#/definitions/ResponseError"
409:
description: Unique data already uses
schema:
$ref: "#/definitions/ResponseError"
default:
$ref: "#/responses/UnexpectedError"
/auth/login:
post:
tags: [user]
summary: Login to app
operationId: loginUser
consumes:
- multipart/form-data
parameters:
- name: email
in: formData
required: true
type: string
format: email
- name: password
in: formData
required: true
type: string
format: password
responses:
200:
description: successful login
schema:
allOf:
- $ref: "#/definitions/ResponseOk"
- type: object
properties:
result:
type: object
properties:
access_token:
type: string
format: jwt
refresh_token:
type: string
format: jwt
400:
description: Incorrect credentionals supplied
schema:
$ref: "#/definitions/ResponseError"
default:
$ref: "#/responses/UnexpectedError"
/auth/logout:
get:
tags: [user]
summary: Logout from session
operationId: logoutUser
security:
- BearerAuth: []
responses:
default:
$ref: "#/responses/Successfully"
/task:
post:
tags: [tasks]
summary: Create task
operationId: createTask
parameters:
- in: body
name: Task object
required: true
schema:
type: object
required: [author_id, title]
properties:
author_id:
type: string
format: uuid
list_id:
type: string
format: uuid
x-nullable: true
title:
type: string
body:
type: string
security:
- BearerAuth: []
responses:
200:
description: Task created
schema:
allOf:
- $ref: "#/definitions/ResponseOk"
- type: object
properties:
result:
$ref: "#/definitions/Task"
400:
$ref: "#/responses/InvalidInput"
default:
$ref: "#/responses/UnexpectedError"
/task/{id}:
parameters:
- name: id
in: path
description: Task id
required: true
type: string
get:
tags: [tasks]
summary: Get task by ID
operationId: getTask
security:
- BearerAuth: []
responses:
200:
description: Succesfully
schema:
allOf:
- $ref: "#/definitions/ResponseOk"
- type: object
properties:
result:
$ref: "#/definitions/Task"
404:
$ref: "#/responses/NotFound"
403:
$ref: "#/responses/NoAccessEntity"
default:
$ref: "#/responses/UnexpectedError"
put:
tags: [tasks]
summary: Update task by ID
operationId: updateTask
parameters:
- name: task-update-fields
in: body
required: true
schema:
type: object
properties:
done:
type: boolean
x-nullable: true
title:
type: string
x-nullable: true
body:
type: string
x-nullable: true
security:
- BearerAuth: []
responses:
200:
$ref: "#/responses/Successfully"
404:
$ref: "#/responses/NotFound"
default:
$ref: "#/responses/UnexpectedError"
delete:
tags: [tasks]
summary: Delete task by ID
operationId: deleteTask
security:
- BearerAuth: []
responses:
200:
$ref: "#/responses/Successfully"
404:
$ref: "#/responses/NotFound"
403:
$ref: "#/responses/NoAccessEntity"
default:
$ref: "#/responses/UnexpectedError"
/task/{id}/change-status:
post:
tags: [tasks]
summary: Change task status (is done)
operationId: changeTaskStatus
parameters:
- name: id
in: path
description: Task id
required: true
type: string
security:
- BearerAuth: []
responses:
200:
description: Succesfully
schema:
allOf:
- $ref: "#/definitions/ResponseOk"
- type: object
properties:
result:
type: object
properties:
current_state:
type: boolean
404:
$ref: "#/responses/NotFound"
403:
$ref: "#/responses/NoAccessEntity"
default:
$ref: "#/responses/UnexpectedError"
/task/default-list:
get:
tags: [ tasks ]
summary: Get main (default) task lsit
operationId: getMainTaskList
security:
- BearerAuth: [ ]
responses:
200:
description: Main (default) task list
schema:
type: array
items:
$ref: "#/definitions/BasicTask"
/task-list:
post:
tags: [task-list]
summary: "Create task list"
operationId: createTaskList
security:
- BearerAuth: []
parameters:
- name: task-list
in: body
required: true
schema:
type: object
properties:
title:
type: string
responses:
201:
description: List created
schema:
allOf:
- $ref: "#/definitions/ResponseOk"
- type: object
properties:
result:
$ref: "#/definitions/BasicTaskList"
400:
$ref: "#/responses/InvalidInput"
default:
$ref: "#/responses/UnexpectedError"
get:
tags: [task-list]
summary: Get self task lists
operationId: getMyTaskLists
security:
- BearerAuth: []
responses:
200:
description: List of task sets
schema:
allOf:
- $ref: "#/definitions/ResponseOk"
- type: object
properties:
result:
type: array
items:
$ref: "#/definitions/BasicTaskList"
default:
$ref: "#/responses/UnexpectedError"
/task-list/{id}:
parameters:
- name: id
in: path
required: true
type: string
get:
tags: [task-list]
summary: Get task list by ID
operationId: getTaskList
security:
- BearerAuth: []
responses:
200:
description: Task list with {id}
schema:
allOf:
- $ref: "#/definitions/ResponseOk"
- type: object
properties:
result:
$ref: "#/definitions/TaskList"
404:
$ref: "#/responses/NotFound"
403:
$ref: "#/responses/NoAccessEntity"
default:
$ref: "#/responses/UnexpectedError"
put:
tags: [task-list]
summary: Update task list by ID
operationId: updateTaskList
parameters:
- name: new_task_list
in: body
required: true
schema:
type: object
properties:
new_title:
type: string
security:
- BearerAuth: []
responses:
200:
description: Task list updated
schema:
$ref: "#/definitions/ResponseOk"
404:
$ref: "#/responses/NotFound"
403:
$ref: "#/responses/NoAccessEntity"
default:
$ref: "#/responses/UnexpectedError"
delete:
tags: [task-list]
summary: Delete task list by ID
operationId: deleteTaskList
security:
- BearerAuth: []
responses:
200:
description: Sucessfully delete
schema:
$ref: "#/definitions/ResponseOk"
404:
$ref: "#/responses/NotFound"
403:
$ref: "#/responses/NoAccessEntity"
default:
$ref: "#/responses/UnexpectedError"
/task-list/{id}/info:
get:
tags: [task-list]
summary: Get basic task list info (without tasks)
parameters:
- name: id
in: path
required: true
type: string
security:
- BearerAuth: []
responses:
200:
description: Task list object with tasks
schema:
allOf:
- $ref: "#/definitions/ResponseOk"
- type: object
properties:
result:
$ref: "#/definitions/BasicTaskList"
404:
$ref: "#/responses/NotFound"
403:
$ref: "#/responses/NoAccessEntity"
default:
$ref: "#/responses/UnexpectedError"
/task-list/{id}/tasks:
get:
tags: [task-list]
summary: Get tasks from list by ID
operationId: getTasksFromList
parameters:
- name: id
in: path
required: true
type: string
security:
- BearerAuth: []
responses:
200:
description: Task list
schema:
allOf:
- $ref: "#/definitions/ResponseOk"
- type: object
properties:
result:
type: array
items:
$ref: "#/definitions/Task"
404:
$ref: "#/responses/NotFound"
403:
$ref: "#/responses/NoAccessEntity"
default:
$ref: "#/responses/UnexpectedError"
securityDefinitions:
BearerAuth:
type: apiKey
name: Authorization
in: header
definitions:
User:
type: object
required:
- password
- email
- username
properties:
id:
type: string
format: uuid
username:
type: string
password:
type: string
format: password
email:
type: string
format: email
create_at:
type: string
format: date-time
BasicTask:
type: object
required:
- title
- done
properties:
id:
type: string
format: uuid
done:
type: boolean
default: false
title:
type: string
body:
type: string
create_at:
type: string
format: date-time
update_at:
type: string
format: date-time
Task:
allOf:
- type: object
required:
- creator_id
properties:
creator_id:
type: string
format: uuid
list_id:
type: string
x-nullable: true
format: uuid
- $ref: "#/definitions/BasicTask"
BasicTaskList:
type: object
required:
- title
properties:
id:
type: string
format: uuid
creator_id:
type: string
format: uuid
title:
type: string
TaskList:
type: object
allOf:
- $ref: '#/definitions/BasicTaskList'
- type: object
properties:
tasks:
type: array
items:
$ref: "#/definitions/BasicTask"
ResponseOk:
type: object
required: [ok]
properties:
ok:
type: boolean
default: true
ResponseError:
type: object
required: [ok]
properties:
ok:
type: boolean
default: false
error:
$ref: "#/definitions/Error"
ErrorCode:
type: string
Error:
type: object
properties:
msg:
type: string
error_code:
$ref: "#/definitions/ErrorCode"
responses:
UnexpectedError:
description: Unexpected error
schema:
$ref: "#/definitions/ResponseError"
Successfully:
description: Successfully operation
schema:
$ref: "#/definitions/ResponseOk"
NotFound:
description: Entity not found
schema:
$ref: "#/definitions/ResponseError"
NoAccessEntity:
description: User haven't acces to this entity
schema:
$ref: "#/definitions/ResponseError"
InvalidInput:
description: Invalid data supplied
schema:
$ref: "#/definitions/ResponseError"