-
Notifications
You must be signed in to change notification settings - Fork 3
/
api-docs.yaml
727 lines (706 loc) · 19.4 KB
/
api-docs.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
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
openapi: 3.0.1
info:
title: Delilah Resto
description: Food store backend API.
contact:
email: guido732@gmail.com
version: 1.0.0
externalDocs:
description: Github Repository
url: https://github.com/guido732/delilah-resto
servers:
- url: https://localhost:3000/v1
- url: http://localhost:3000/v1
tags:
- name: User
description: Operations about user
- name: Products
description: Everything about products
- name: Orders
description: Everything about orders
paths:
/users:
post:
tags:
- User
summary: Create user
description: Creates a new User in the DataBase
operationId: createUser
requestBody:
description: Created user object
content:
application/json:
schema:
$ref: "#/components/schemas/User"
required: true
security: []
responses:
200:
description: User correctly added to database
400:
description: Error validating input data
409:
description: Username already exists, please pick another
default:
$ref: "#/components/responses/Default"
get:
tags:
- User
summary: Gets list of users(Only Admin) or User account details (Not Admin)
description: Gets a list of all the existing users in the DataBase if the user
sending the request is an admin, otherwise the response only targets the active
user.
operationId: getUserInfo
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/UserInfo"
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
default:
$ref: "#/components/responses/Default"
put:
tags:
- User
summary: Edits active user data
operationId: editActiveUserData
requestBody:
description: Fields to change
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/User"
responses:
200:
description: Successful operation
400:
description: Invalid username/password supplied
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
409:
description: Username or email already registered
default:
$ref: "#/components/responses/Default"
delete:
tags:
- User
summary: Disables user account (validation via token)
operationId: deleteActiveUser
responses:
200:
description: User account disabled
401:
$ref: "#/components/responses/Unauthorized"
default:
$ref: "#/components/responses/Default"
/users/login:
get:
tags:
- User
security: []
summary: Logs user into the system
operationId: loginUser
parameters:
- name: username or email
in: query
description: The user name or email for login
required: true
schema:
type: string
- name: password
in: query
description: The password for login in clear text
required: true
schema:
type: string
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Token"
400:
description: Invalid username/password supplied
401:
$ref: "#/components/responses/Disabled"
default:
$ref: "#/components/responses/Default"
/users/:username:
get:
tags:
- User
summary: Get user by user name (only Admin)
operationId: getUserByName
parameters:
- name: username
in: path
description: The name that needs to be fetched.
required: true
schema:
type: string
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/UserInfo"
401:
$ref: "#/components/responses/UnauthorizedAdmin"
404:
$ref: "#/components/responses/NotFound"
default:
$ref: "#/components/responses/Default"
put:
tags:
- User
summary: Edit by username (only Admin)
description: Edits a username fetched by its username (Admin Only). The full object can be sent or only the parameters needing to be modified.
operationId: updateUserAdmin
parameters:
- name: username
in: path
description: name that need to be updated
required: true
schema:
type: string
requestBody:
description: Updated user object
content:
application/json:
schema:
$ref: "#/components/schemas/User"
responses:
200:
description: "User {username} was modified correctly"
401:
$ref: "#/components/responses/UnauthorizedAdmin"
404:
$ref: "#/components/responses/NotFound"
default:
$ref: "#/components/responses/Default"
delete:
tags:
- User
summary: Delete(invalidate) user (only Admin)
description: This can only be done by a logged in admin.
operationId: deleteUserAdmin
parameters:
- name: username
in: path
description: The name that needs to be deleted
required: true
schema:
type: string
responses:
200:
description: "User {username} was disabled correctly"
401:
$ref: "#/components/responses/UnauthorizedAdmin"
404:
$ref: "#/components/responses/NotFound"
default:
$ref: "#/components/responses/Default"
/products:
get:
tags:
- Products
summary: Get list of all available products
description: Returns a list of products (does NOT list disabled products)
operationId: getProducts
parameters:
- name: search
in: query
description: Keywords to search for
schema:
type: string
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Products"
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
default:
$ref: "#/components/responses/Default"
post:
tags:
- Products
summary: Adds a product (only Admin)
description: Adds a product to database
operationId: addProduct
requestBody:
description: Keywords to search for
content:
application/json:
schema:
$ref: "#/components/schemas/Product"
required: true
responses:
200:
description: Product added succesfully
content:
application/json:
schema:
type: array
items:
type: integer
example: -2
400:
description: Error validating input data
401:
$ref: "#/components/responses/Unauthorized"
default:
$ref: "#/components/responses/Default"
/products/:id:
get:
tags:
- Products
summary: Gets product by Id
description: Returns a specific product detail, fetched by it's ID
parameters:
- name: id
in: path
description: The ID of the product that needs to be fetched.
required: true
schema:
type: string
operationId: getProductById
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Product"
400:
description: Error validating input data
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
default:
$ref: "#/components/responses/Default"
put:
tags:
- Products
summary: Edits product by Id (only Admin)
description: Edits a specific product fetching it by it's ID
parameters:
- name: id
in: path
description: The ID of the product that needs to be fetched.
required: true
schema:
type: string
operationId: editProduct
requestBody:
description: Modification data
content:
application/json:
schema:
$ref: "#/components/schemas/Product"
required: true
responses:
200:
description: "Product with id {productId} modified correctly"
400:
description: Error validating input data
401:
$ref: "#/components/responses/UnauthorizedAdmin"
404:
$ref: "#/components/responses/NotFound"
default:
$ref: "#/components/responses/Default"
delete:
tags:
- Products
summary: Disables product by Id (only Admin)
description: Disables a specific product, fetched by it's ID
parameters:
- name: id
in: path
description: The ID of the product that needs to be fetched.
required: true
schema:
type: string
operationId: deleteProduct
responses:
200:
description: "Product with id ${productId} was disabled correctly"
401:
$ref: "#/components/responses/UnauthorizedAdmin"
404:
$ref: "#/components/responses/NotFound"
default:
$ref: "#/components/responses/Default"
/orders:
get:
tags:
- Orders
summary: Get list of orders
description: Returns a list of products. If user is admin returns a list of all orders, if user is not admin returns a list of their orders only.
operationId: getOrders
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Orders"
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
default:
$ref: "#/components/responses/Default"
post:
tags:
- Orders
summary: Adds a product
description: Adds a product to database
operationId: addOrder
requestBody:
description: Order to create
content:
application/json:
schema:
$ref: "#/components/schemas/NewOrder"
required: true
responses:
200:
description: Order modified succesfully
400:
description: Error validating input data
401:
$ref: "#/components/responses/Unauthorized"
default:
$ref: "#/components/responses/Default"
/orders/:id:
get:
tags:
- Orders
summary: Gets product by Id (only Admin)
parameters:
- name: id
in: path
description: The ID of the order that needs to be fetched.
required: true
schema:
type: string
description: Returns a specific product detail, fetched by it's ID
operationId: getOrderById
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Orders"
401:
$ref: "#/components/responses/UnauthorizedAdmin"
404:
$ref: "#/components/responses/NotFound"
default:
$ref: "#/components/responses/Default"
put:
tags:
- Orders
summary: Gets product by Id (only Admin)
description: Edits a specific product
operationId: editOrder
parameters:
- name: id
in: path
description: The ID of the order that needs to be fetched.
required: true
schema:
type: string
requestBody:
description: Order to create
content:
application/json:
schema:
type: object
properties:
orderStatus:
type: string
example: delivered
required: true
responses:
200:
description: "Product with id {productId} modified correctly"
400:
description: Error validating input data
401:
$ref: "#/components/responses/UnauthorizedAdmin"
403:
description: The state given for the product is not valid
404:
$ref: "#/components/responses/NotFound"
default:
$ref: "#/components/responses/Default"
components:
schemas:
User:
type: object
properties:
id:
type: integer
format: int64
example: 100
username:
type: string
example: ghee_dough
password:
type: string
example: MySecretPass123
email:
type: string
example: gheedough@gmail.com
delivery_address:
type: string
example: Fake St. 123
full_name:
type: string
example: Guido Torres
phone:
type: integer
example: 5491122223333
UserInfo:
type: array
items:
type: object
properties:
user_id:
type: integer
example: 1
username:
type: string
example: ghee_dough
full_name:
type: string
example: Guido Torres
email:
type: string
example: gheedough@gmail.com
phone:
type: integer
example: 5491122223333
delivery_address:
type: string
example: Fake St. 123
is_admin:
type: boolean
example: 0
is_disabled:
type: boolean
example: 0
Product:
type: object
properties:
product_id:
type: integer
example: 1
name:
type: string
example: Avocado Toast
price:
type: number
example: 268.5
img_url:
type: string
example: https://via.placeholder.com/150
description:
type: string
example: A thick, crusty, toastd rye bread toast with an avocado mix on
top with spices
is_disabled:
type: boolean
example: 0
Products:
type: array
items:
$ref: "#/components/schemas/Product"
OrderProduct:
type: object
properties:
order_prod_id:
type: integer
example: 104
order_id:
type: integer
example: 5
product_id:
type: integer
example: 70
product_amount:
type: integer
example: 70
name:
type: string
example: Avocado Toast
price:
type: number
example: 268.5
img_url:
type: string
example: https://via.placeholder.com/150
description:
type: string
example: A thick, crusty, toastd rye bread toast with an avocado mix on
top with spices
is_disabled:
type: boolean
example: 0
OrderProducts:
type: array
items:
$ref: "#/components/schemas/OrderProduct"
Order:
type: object
properties:
order_id:
type: integer
example: 1
status:
type: string
example: new
date:
type: string
format: date-time
example: "2020-04-10T10:11:12Z"
description:
type: string
example: "1x AvoToast"
payment_method:
type: string
example: cash
total:
type: integer
example: 666
user_id:
type: integer
example: 1
username:
type: string
example: gheedough
full_name:
type: string
example: "Guido Torres"
email:
type: string
example: gheedough@gmail.com
phone:
type: integer
example: 1122223333
delivery_address:
type: string
example: Calle Falsa 123
products:
$ref: "#/components/schemas/OrderProducts"
Orders:
type: array
items:
$ref: "#/components/schemas/Order"
NewOrder:
type: object
properties:
payment_method:
type: string
example: cash
data:
type: array
items:
type: object
properties:
product_id:
type: integer
example: 1
amount:
type: integer
example: 3
Token:
type: object
properties:
token:
type: string
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Error:
type: object
properties:
error:
type: string
example: "An error has ocurred: <error>"
required:
- error
Send:
type: string
example: "Error message"
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
# Reused Responses
responses:
UnauthorizedError:
description: Invalid Token
Disabled:
description: Invalid request, user account is disabled
NotAdmin:
description: Operation forbidden, not an admin
NotFound:
description: The specified resource was not found
Default:
description: Unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/Send"
examples:
Token Invalidation:
summary: Unauthorized - Invalid Token
value: Unauthorized - Invalid Token
Disabled Account:
summary: Unauthorized - Account is Disabled
value: Unauthorized - User account is disabled
UnauthorizedAdmin:
description: Unauthorized
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/Send"
examples:
Token Invalidation:
summary: Unauthorized - Invalid Token
value: Unauthorized - Invalid Token
Disabled Account:
summary: Unauthorized - Account is Disabled
value: Unauthorized - User account is disabled
Not Admin:
summary: Unauthorized - Not an admin
value: Unauthorized - Not an admin
security:
- bearerAuth: []