forked from dikaeinstein/book-a-meal
-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yml
679 lines (679 loc) · 19.4 KB
/
swagger.yml
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
swagger: '2.0'
info:
description: API for book-a-meal
version: 1.0.0
title: book-a-meal
contact:
email: solozyokwa@gmail.com
license:
name: MIT (2018)
host: dikaeinstein-book-a-meal.herokuapp.com
basePath: /api/v1
tags:
- name: auth
description: Operations about user accounts
- name: meal
description: Operations about meals
- name: order
description: Operations about orders
- name: menu
description: Operations about menus
schemes:
- https
paths:
/auth/signup:
post:
tags:
- auth
summary: Create user
description: Creates a new user account.
consumes:
- application/json
- application/x-www-form-urlencoded
produces:
- application/json
parameters:
- name: user
in: body
description: user to sign up
schema:
type: object
required:
- name
- email
- password
- confirmPassword
- role
properties:
name:
type: string
email:
type: string
password:
type: string
confirmPassword:
type: string
role:
type: string
responses:
201:
description: User successfully created
examples:
application/json:
message: User successfully created
user:
id: 1
name: Uchiha Itachi
email: itachi@email.com
role: caterer
token: >-
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiaWF0IjoxNTI1NTI5MjU3LCJleHAiOjE1MjU2MTU2NTd9.WqI-bayENIvde4UIkUWqVW3ZdMHtyVyY4RwOVx2gP4Y
status: success
400:
description: Invalid input
/auth/signin:
post:
tags:
- auth
summary: sign in a user
description: Sign in user into the application
consumes:
- application/json
- application/x-www-form-urlencoded
produces:
- application/json
parameters:
- name: user
in: body
description: user to sign in
schema:
type: object
required:
- email
- password
properties:
email:
type: string
password:
type: string
responses:
200:
description: User signed in
examples:
application/json:
message: User successfully signed in
user:
id: 1
name: Uchiha Itachi
email: itachi@email.com
role: caterer
token: >-
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiaWF0IjoxNTI1NTI5MjU3LCJleHAiOjE1MjU2MTU2NTd9.WqI-bayENIvde4UIkUWqVW3ZdMHtyVyY4RwOVx2gP4Y
status: success
400:
description: Invalid Input
/meals:
get:
tags:
- meal
summary: List all meals
description: List all meals in the application
produces:
- application/json
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
responses:
200:
description: Meals found
examples:
application/json:
meals:
- id: 1
name: Efo riro with cow head
description: Very tasty and yummy
imageUrl: https://testimage.com/meal.jpg
price: 2000
- id: 2
name: Vegetable soup
description: Very tasty and yummy
imageUrl: https://testimage.com/meal.jpg
price: 2000
message: Meals found
status: success
404:
description: No meal found
examples:
application/json:
error: true
status: error
message: There is currently no meal!
post:
tags:
- meal
summary: Posts a new meal
description: Add meal to app
consumes:
- application/x-www-form-urlencoded
- application/json
produces:
- application/json
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
- name: name
in: formData
description: Name of meal to post
required: true
type: string
- name: description
in: formData
description: Describes the meal
required: true
type: string
- name: price
in: formData
description: Price of the meal in Naira
required: true
type: number
- name: imageUrl
in: formData
description: Url to image of the meal
type: string
responses:
201:
description: Meal was added successfully
examples:
application/json:
message: Successfully added meal
meal:
id: 1
name: Vegetable Soup
description: Tasty and yummy
price: 2000
imageUrl: https://dummyimage.com/meal.jpg
status: success
400:
description: Invalid input
examples:
application/json:
error: true
message: Meal name is required
status: error
401:
description: Unauthorized, invalid token or session have expired
403:
description: Forbidden, you don't have the priviledge to perform this operation
/meals/{mealId}:
put:
tags:
- meal
summary: Update an existing meal
description: Update an existing meal in the application
consumes:
- application/json
- application/x-www-form-urlencoded
produces:
- application/json
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
- in: path
name: mealId
description: Meal object that needs to be updated
required: true
type: string
- in: formData
name: name
description: Meal name that needs to be updated
type: string
- in: formData
name: description
description: Meal description that needs to be updated
type: string
- in: formData
name: price
description: Meal price that needs to be updated
type: string
- in: formData
name: imageUrl
description: Meal image url that needs to be updated
type: string
responses:
200:
description: Successful update operation
examples:
application/json:
message: Sucessfully updated meal
meal:
id: 1
name: Vegetable Soup
description: Tasty and yummy
price: 2000
imageUrl: https://dummyimage.com/meal.jpg
status: success
400:
description: Invalid input
401:
description: >-
Unauthorized, invalid token, no token provided or session have
expired
403:
description: Forbidden, you don't have the priviledge to perform this operation
404:
description: Meal not found
delete:
tags:
- meal
summary: Deletes a meal
description: Deletes a meal from the application
produces:
- application/json
parameters:
- name: Authorization
in: header
required: true
type: string
- name: mealId
in: path
description: Meal id used to identify meal to delete
required: true
type: integer
responses:
200:
description: Meal successfully deleted
400:
description: Meal id is required
401:
description: >-
Unauthorized, invalid token, no token provided or session have
expired
403:
description: Forbidden, you don't have the priviledge to perform this operation
404:
description: Meal does not exists
/menu/:
get:
tags:
- menu
summary: Get menu
description: Get menu for specific day
produces:
- application/json
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
responses:
200:
description: Successfully retrieved menu
examples:
application/json:
menu:
id: 1
name: Menu for today
meals:
- id: 1
name: Vegetable Soup
description: Yummy and tasty
price: 2000
imageUrl: https://imageurl.com/meals.jpg
- id: 2
name: Efo riro with cow head
description: Yummy and tasty
price: 2000
imageUrl: https://imageurl.com/meals.jpg
status: success
message: Successfully retrieved menu
post:
tags:
- menu
summary: Post menu
description: Setup menu for specific day
consumes:
- application/x-www-form-urlencoded
- application/json
produces:
- application/json
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
- name: name
in: formData
description: Name of menu
required: true
type: string
- name: mealIds
in: formData
description: Array of meal ids
required: true
type: array
items:
type: string
responses:
201:
description: Successfully setup menu
examples:
application/json:
message: Successfully setup menu for today
menu:
name: Menu for today
meals:
- id: 1
name: Vegetable Soup
description: Yummy and tasty
price: 2000
imageUrl: https://imageurl.com/meal.jpg
- id: 2
name: Vegetable Soup
description: Yummy and tasty
price: 2000
imageUrl: https://imageurl.com/meal.jpg
status: success
400:
description: Invalid input
examples:
application/json:
error: true
message: Meal name is required
status: error
401:
description: Unauthorized, invalid token or session have expired
403:
description: Forbidden, you don't have the priviledge to perform this operation
/menu/{menuId}:
put:
tags:
- menu
summary: Update menu
description: Update menu for current day or a specific menu
consumes:
- application/x-www-form-urlencoded
- application/json
produces:
- application/json
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
- name: menuId
in: path
description: Menu id used to identify menu to update
required: true
type: number
- name: name
in: formData
description: Name of menu
required: true
type: string
- name: mealIds
in: formData
description: Array of meal ids
required: true
type: array
items:
type: string
responses:
200:
description: Successfully update menu
examples:
application/json:
message: Successfully update menu for today
menu:
name: Menu for today
meals:
- id: 1
name: Vegetable Soup
description: Yummy and tasty
price: 2000
imageUrl: https://imageurl.com/meal.jpg
- id: 2
name: Vegetable Soup
description: Yummy and tasty
price: 2000
imageUrl: https://imageurl.com/meal.jpg
status: success
400:
description: Invalid input
examples:
application/json:
error: true
message: Meal name is required
status: error
401:
description: Unauthorized, invalid token or session have expired
403:
description: Forbidden, you don't have the priviledge to perform this operation
404:
description: Menu not found or have not been setup
/orders:
get:
tags:
- order
summary: Get all orders
description: Get all orders made
produces:
- application/json
parameters:
- name: Authorization
in: header
description: an authorization header
required: true
type: string
responses:
200:
description: Orders succesfully retrieved
examples:
application/json:
message: Orders succesfully retrieved
orders:
- id: 1
mealId: 1
amount: 2000
quantity: 1
total: 2000
userId: 1
- id: 2
mealId: 1
amount: 2000
quantity: 1
total: 2000
userId: 1
status: success
400:
description: Invalid input
examples:
application/json:
error: true
message: Meal name is required
status: error
401:
description: Unauthorized, invalid token or session have expired
403:
description: Forbidden, you don't have the priviledge to perform this operation
404:
description: No order have been placed
post:
tags:
- order
summary: Posts a new order
description: make an order
consumes:
- application/x-www-form-urlencoded
- application/json
produces:
- application/json
parameters:
- name: Authorization
in: header
required: true
type: string
- name: userId
in: formData
description: User id of customer
required: true
type: number
- name: mealId
in: formData
description: Id of meal to be ordered
required: true
type: number
- name: amount
in: formData
description: Amount of meal being ordered
required: true
type: number
- name: quantity
in: formData
description: Quantity of meal
required: true
type: number
- name: total
in: formData
description: Total amount of meal being ordered
required: true
type: number
responses:
201:
description: Order placed
examples:
application/json:
message: Order placed
order:
id: 1
mealId: Vegetable Soup
userId: 1
status: pending
amount: 2000
quantity: 2
total: 4000
status: success
400:
description: Invalid input
examples:
application/json:
error: true
message: Meal name is required
status: error
401:
description: Unauthorized, invalid token or session have expired
403:
description: Forbidden, you dont have the priviledge to perform this operation
/orders/{orderId}:
put:
tags:
- order
summary: Update an existing order
description: Update an existing order placed
consumes:
- application/json
- application/x-www-form-urlencoded
produces:
- application/json
parameters:
- name: Authorization
in: header
required: true
type: string
- name: orderId
in: path
description: Order id used to identify order to update
required: true
type: number
- name: userId
in: formData
description: User id of customer
required: true
type: number
- name: mealId
in: formData
description: Id of meal to be ordered
required: true
type: number
- name: amount
in: formData
description: Amount of meal being ordered
required: true
type: number
- name: quantity
in: formData
description: Quantity of meal
required: true
type: number
- name: total
in: formData
description: Total amount of meal being ordered
required: true
type: number
responses:
200:
description: Order Updated
examples:
application/json:
message: Successfully updated order
order:
id: 1
mealId: Vegetable Soup
userId: 1
amount: 2000
status: pending
quantity: 2
total: 4000
status: success
400:
description: Invalid input
examples:
application/json:
error: true
message: Order id is required
status: error
401:
description: Unauthorized, invalid token or session have expired
403:
description: Forbidden, you don't have the priviledge to perform this operation
404:
description: Order does not exist
delete:
tags:
- order
summary: Deletes an order
description: Deletes an order
produces:
- application/json
parameters:
- name: Authorization
in: header
required: true
type: string
- name: orderId
in: path
description: Order id used to identify order to delete
required: true
type: number
responses:
200:
description: Order successfully deleted
400:
description: Order id is required
401:
description: Unauthorized, invalid token or session have expired
403:
description: Forbidden, you don't have the priviledge to perform this operation
404:
description: Order does not exist