-
Notifications
You must be signed in to change notification settings - Fork 1
/
swagger.yml
1310 lines (1307 loc) · 35.7 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
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
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: Restaurants Service API
description: Restaurants from GoOutSafe with Microservices
version: "0.1"
servers:
- url: /
paths:
/restaurants:
get:
tags:
- Restaurants
summary: Get all restaurants
operationId: app.get_restaurants
responses:
200:
description: Return all restaurants
content:
application/json:
schema:
type: object
properties:
restaurants:
type: array
items:
$ref: '#/components/schemas/Restaurant'
/restaurants/id/{owner_email}:
get:
tags:
- Restaurants
summary: Get the id of a restaurant
operationId: app.get_restaurant_id_by_owner_email
parameters:
- name: owner_email
in: path
description: Email of the owner of the restaurant
required: true
schema:
type: string
responses:
200:
description: Return the restaurant
content:
application/json:
schema:
$ref: '#/components/schemas/RestaurantId'
404:
description: Owner not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurants/{restaurant_id}:
get:
tags:
- Restaurants
summary: Get a single restaurant
operationId: app.get_restaurant
parameters:
- name: restaurant_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
responses:
200:
description: Return restaurant
content:
application/json:
schema:
$ref: '#/components/schemas/Restaurant'
404:
description: Restaurant not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
tags:
- Restaurants
summary: Delete a restaurant with all its info
operationId: app.delete_restaurant
parameters:
- name: restaurant_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
responses:
200:
description: "The operation is done"
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
400:
description: "The code returned if there is some error on server, e.g: param not specified"
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
404:
description: Restaurant not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurants/{restaurant_id}/name:
get:
tags:
- Restaurants
summary: Get the name of the restaurant
operationId: app.get_restaurant_name
parameters:
- name: restaurant_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
responses:
200:
description: Return restaurant
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
404:
description: Restaurant not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurants/{restaurant_id}/info:
get:
tags:
- Restaurants
summary: Get more info about the restaurant
operationId: app.get_restaurant_more_info
parameters:
- name: restaurant_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
responses:
200:
description: Return restaurant
content:
application/json:
schema:
type: object
properties:
Restaurant_info:
type: object
$ref: '#/components/schemas/Info'
404:
description: Restaurant not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurants/search/{name}:
get:
tags:
- Restaurants
summary: Get a restaurant restaurant with keyword name
operationId: app.get_restaurants_by_keyword
parameters:
- name: name
in: path
description: name to search
required: true
schema:
type: string
responses:
200:
description: Return all restaurants with keyword name
content:
application/json:
schema:
type: object
properties:
restaurants:
type: array
items:
$ref: '#/components/schemas/Restaurant'
/restaurants/{restaurant_id}/menu:
get:
tags:
- Menu
summary: Get the menu of a single restaurant
operationId: app.get_menus
parameters:
- name: restaurant_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
responses:
200:
description: Return the menus of the restaurant
content:
application/json:
schema:
type: object
properties:
menus:
type: array
items:
$ref: '#/components/schemas/Menus'
404:
description: Restaurant not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurants/menu/{menu_id}:
post:
tags:
- Menu
summary: Create a new photo for the menu
operationId: app.create_menu_photo
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/PhotoCreation"
parameters:
- name: menu_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
responses:
201:
description: "Photo added"
content:
application/json:
schema:
type: object
$ref: '#/components/schemas/MenuPhotos'
404:
description: Error restaurant not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
409:
description: Error URL already used
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurants/{restaurant_id}/dishes:
get:
tags:
- Dishes
summary: Get the dishes of a single restaurant
operationId: app.get_dishes
parameters:
- name: restaurant_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
responses:
200:
description: Return the dishes of the restaurant
content:
application/json:
schema:
type: object
properties:
dishes:
type: array
items:
$ref: '#/components/schemas/Dishes'
404:
description: Restaurant not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
tags:
- Dishes
summary: Create a new dish in the restaurant
operationId: app.create_dish
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DishCreation"
parameters:
- name: restaurant_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
responses:
201:
description: "Dish added"
content:
application/json:
schema:
type: object
$ref: '#/components/schemas/Dishes'
404:
description: Error restaurant not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurants/{restaurant_id}/openings:
get:
tags:
- Opening Hours
summary: Get the opening hours of a single restaurant
operationId: app.get_openings
parameters:
- name: restaurant_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
responses:
200:
description: Return the opening hours of the restaurant
content:
application/json:
schema:
type: object
properties:
openings:
type: array
items:
$ref: '#/components/schemas/Openings'
404:
description: Restaurant not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurants/table/{table_id}:
get:
tags:
- Tables
summary: Get the table with all restaurant info
operationId: app.get_table
parameters:
- name: table_id
in: path
description: Table's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
responses:
200:
description: Return the restaurant
content:
application/json:
schema:
$ref: '#/components/schemas/TotalTable'
404:
description: Owner not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurants/{restaurant_id}/tables:
get:
tags:
- Tables
summary: Get the tables of a single restaurant
operationId: app.get_tables
parameters:
- name: restaurant_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
responses:
200:
description: Return the tables of the restaurant
content:
application/json:
schema:
type: object
properties:
tables:
type: array
items:
$ref: '#/components/schemas/Tables'
404:
description: Restaurant not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
tags:
- Tables
summary: Create a table in the restaurant
operationId: app.create_table
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/TableCreation"
parameters:
- name: restaurant_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
responses:
201:
description: "Table added to restaurant"
content:
application/json:
schema:
type: object
$ref: '#/components/schemas/Tables'
404:
description: Generic error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurants/{restaurant_id}/photos:
get:
tags:
- Photos
summary: Get the photos of a single restaurant
operationId: app.get_photos
parameters:
- name: restaurant_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
responses:
200:
description: Return the photos of the restaurant
content:
application/json:
schema:
type: object
properties:
photos:
type: array
items:
$ref: '#/components/schemas/Photos'
404:
description: Restaurant not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
tags:
- Photos
summary: Create a new photo for the restaurant
operationId: app.create_photo
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/PhotoCreation"
parameters:
- name: restaurant_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
responses:
201:
description: "Photo added"
content:
application/json:
schema:
type: object
$ref: '#/components/schemas/Photos'
404:
description: Error restaurant not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
409:
description: Error URL already used
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurants/{restaurant_id}/reviews:
get:
tags:
- Reviews
summary: Get the reviews of a single restaurant
operationId: app.get_reviews
parameters:
- name: restaurant_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
responses:
200:
description: Return the reviews of the restaurant
content:
application/json:
schema:
type: object
properties:
Reviews:
type: array
items:
$ref: '#/components/schemas/Reviews'
404:
description: Restaurant not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
tags:
- Reviews
summary: Create a new review for the restaurant
operationId: app.create_review
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ReviewCreation"
parameters:
- name: restaurant_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
responses:
201:
description: "Review added"
content:
application/json:
schema:
type: object
$ref: '#/components/schemas/Reviews'
404:
description: Error restaurant not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurants/{restaurant_id}/reviews/{number}:
get:
tags:
- Reviews
summary: Get the a specified number of random reviews
operationId: app.get_random_reviews
parameters:
- name: restaurant_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
pattern: ^[a-zA-Z0-9-]+$
type: string
- name: number
in: path
description: number of reviews to get
required: true
schema:
type: integer
responses:
200:
description: Return the random reviews of the restaurant
content:
application/json:
schema:
type: object
properties:
Reviews:
type: array
items:
$ref: '#/components/schemas/Reviews'
404:
description: Restaurant not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurants/{restaurant_id}/avg_rating:
get:
tags:
- Reviews
summary: Get avg rating of a restaurant
operationId: app.get_avg_rating_restaurant
parameters:
- name: restaurant_id
in: path
description: Restaurant's Unique identifier
required: true
schema:
type: integer
responses:
200:
description: Return the avg reviews of the restaurant
content:
application/json:
schema:
type: number
500:
description: Generic error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurants/calculate_rating_for_all_restaurant:
get:
tags:
- Reviews
summary: Calculate rating for all restaurant (celery)
operationId: app.calculate_rating_for_all_restaurant
responses:
200:
description: "The operation is done"
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
500:
description: Generic error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurants/create:
post:
tags:
- Restaurants
summary: Create a restaurant
operationId: app.create_restaurant
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RestaurantModel"
responses:
201:
description: "Restaurant is been created"
content:
application/json:
schema:
$ref: "#/components/schemas/RestaurantId"
409:
description: Generic error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurants/update:
put:
tags:
- Restaurants
summary: Update a restaurant
operationId: app.update_restaurant_info
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RestaurantId"
responses:
200:
description: "Restaurant is been updated"
500:
description: Generic error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/restaurant/menu/{dish_id}:
delete:
tags:
- Dishes
summary: Delete a dish
operationId: app.delete_dish
parameters:
- in: path
name: dish_id
schema:
type: integer
required: true
description: The dish_id ID
responses:
200:
description: "The operation is done"
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
400:
description: "The code returned if there is some error on server, e.g: param not specified"
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
/restaurant/table/{table_id}:
delete:
tags:
- Tables
summary: Delete a table
operationId: app.delete_table
parameters:
- in: path
name: table_id
schema:
type: integer
required: true
description: The table_id ID
responses:
200:
description: "The operation is done"
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
400:
description: "The code returned if there is some error on server, e.g: param not specified"
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
components:
schemas:
Error:
required:
- code
- message
type: object
properties:
code:
type: string
message:
type: string
Result:
required:
- result
type: object
properties:
result:
type: string
default: Type of result
example: "Message to describe what happen on server"
Restaurant:
required:
- name
- lat
- lon
- phone
- covid_measures
- avg_time
- rating
- owner_email
type: object
properties:
name:
maxLength: 100
minLength: 1
type: string
description: Restaurant's name
example: "My Pizza Restaurant"
lat:
type: number
description: Restaurant Latitude
example: 42.42
lon:
type: number
description: Restaurant Longitude
example: 42.42
phone:
type: integer
minLength: 5
maxLength: 50
description: Restaurant Phone Number
example: 050123456
covid_measures:
type: string
maxLength: 500
description: Covid measures adopted in restaurant
example: "Distance between tables"
avg_time:
type: integer
description: Restaurant avg time
example: 42
rating:
type: number
description: Restaurant Rating
example: 0
owner_email:
type: string
description: Restaurant owner's email
example: "[email protected]"
RestaurantId:
required:
- id
- name
- lat
- lon
- phone
- covid_measures
- avg_time
- rating
- owner_email
type: object
properties:
id:
type: integer
description: Unique identifier
example: 123
name:
maxLength: 100
minLength: 1
type: string
description: Restaurant's name
example: "My Pizza Restaurant"
lat:
type: number
description: Restaurant Latitude
example: 42.42
lon:
type: number
description: Restaurant Longitude
example: 42.42
phone:
type: integer
minLength: 5
maxLength: 50
description: Restaurant Phone Number
example: 050123456
covid_measures:
type: string
maxLength: 500
description: Covid measures adopted in restaurant
example: "Distance between tables"
avg_time:
type: integer
description: Restaurant avg time
example: 42
rating:
type: number
description: Restaurant Rating
example: 0
owner_email:
type: string
description: Restaurant owner's email
example: "[email protected]"
RestaurantModel:
required:
- restaurant
- restaurant_tables
- menu
- opening
type: object
properties:
restaurant:
$ref: '#/components/schemas/Restaurant'
restaurant_tables:
type: integer
description: number of table for 6 people
example: 10
menu:
type: array
items:
type: string
maxLength: 100
minLength: 1
description: Cuisine type
example: 'Italian food'
opening:
type: array
items:
$ref: '#/components/schemas/OpeningsInsert'
OpeningsInsert:
required:
- week_day
- open_lunch
- close_lunch
- open_dinner
- close_dinner
type: object
properties:
week_day:
type: integer
minimum: 0
maximum: 6
description: Day of week
example: 3
open_lunch:
type: string
format: date-time
description: Time when the restaurant opens for lunch
example: "11:30"
close_lunch:
type: string
format: date-time
description: Time when the restaurant closes for lunch
example: "15:30"
open_dinner:
type: string
format: date-time
description: Time when the restaurant opens for dinner
example: "19:00"
close_dinner:
type: string
format: date-time
description: Time when the restaurant closes for dinner
example: "22:00"
TableCreation:
required:
- max_seats
- name
type: object
properties:
max_seats:
type: integer
minimum: 0
description: Max number of people at the table
example: 3
name:
type: string
maxLength: 100
description: name of the table
example: 'Red table'
DishCreation:
required:
- name
- price
type: object
properties:
name:
type: string
maxLength: 100
description: name of the dish
example: 'Pizza margherita'
price:
type: number
minimum: 0
description: price of the dish
example: 10.50
PhotoCreation:
required:
- caption
- url
type: object
properties:
caption:
type: string
maxLength: 200