-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
890 lines (876 loc) · 26.2 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
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
openapi: 3.0.0
info:
title: Dailyfit API
description: Node.js API serving the [Dailyfit App](https://github.com/leonardorib/dailyfit-mobile).
version: 1.0.0
servers:
- url: https://api.dailyfit.leonardoribeiro.com
description: Main production server
- url: http://localhost:3334
description: Local development server
paths:
### Auth
/auth:
post:
summary: Authenticates with an user account.
tags: ["Auth"]
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
password:
type: string
example:
email: [email protected]
password: some-secure-password-123
responses:
'200':
description: Success. Returns user information and JWT token.
content:
application/json:
schema:
type: object
properties:
user:
$ref: '#/components/schemas/User'
token:
type: string
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoiNzIyZGY0MWUtMzA3NS00NjIwLWE4ZGItMDYxYWI0ZDcxNTBhIiwiZmlyc3RfbmFtZSI6IkpvaG4iLCJsYXN0X25hbWUiOiJEb2UiLCJlbWFpbCI6ImpvaG5kb2VAZ21haWwuY29tIiwiY3JlYXRlZF9hdCI6IjIwMjEtMTAtMjlUMDU6MDM6NDIuNzMxWiIsInVwZGF0ZWRfYXQiOiIyMDIxLTEwLTI5VDA1OjQ5OjUxLjE4N1oifSwiaWF0IjoxNjM1NTU5MTkxLCJleHAiOjE2MzYxNjM5OTF9.ZlKMaj2UGvdgntim6yMdzoF8cvdtYwCHAyg17a7DSvk
'400':
description: User does not exist, credentials are wrong or validation error.
content:
application/json:
schema:
oneOf:
- type: object
properties:
message:
type: string
example: User does not exist or credentials are wrong.
- $ref: '#/components/responses/400-Validation'
### Users
/users:
post:
summary: Creates a new user.
tags: ["Users"]
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
firstName:
type: string
lastName:
type: string
email:
type: string
password:
type: string
passwordConfirmation:
type: string
example:
firstName: John
lastName: Doe
email: [email protected]
password: some-secure-password-123
passwordConfirmation: some-secure-password-123
responses:
'200':
description: Success. Returns the created user.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'400':
description: Email already in use or validation error.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ValidationResponseData'
- type: object
properties:
message:
type: string
example: test
examples:
Validation:
$ref: '#/components/examples/ValidationResponseExample'
"Email in use":
$ref: '#/components/examples/EmailAlreadyInUseExample'
put:
summary: Updates user profile data.
description: The user is identified through the JWT token payload.
tags: ["Users"]
security:
- bearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
firstName:
type: string
example: John
lastName:
type: string
example: Doe
email:
type: string
example: [email protected]
password:
type: string
example: some-secure-password-123
responses:
'200':
description: Updated user.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'400':
description: Email already in use or validation error.
content:
application/json:
examples:
Validation:
$ref: '#/components/examples/ValidationResponseExample'
"Email in use":
$ref: '#/components/examples/EmailAlreadyInUseExample'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
/users/{userId}:
delete:
summary: Deletes an user by id.
tags:
- "Users"
security:
- bearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
password:
type: string
example: some-secure-password-123
parameters:
- in: path
name: userId
schema:
type: string
example: a20f9419-4e6e-4e42-90d4-737f889a43a1
required: true
description: ID (uuid) of the user to delete
responses:
'200':
description: Deleted sucessfully. Returns the deleted user.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
/users/forgotpassword:
post:
summary: Creates and sends a password reset token to a specified user email.
description: On production, check the email. On development mode, check the application logs.
tags: ["Users"]
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: [email protected]
responses:
'200':
description: Reset password token created and sent sucessfully.
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: "Password recovery email has been sent successfully"
'400':
$ref: '#/components/responses/400-Validation'
'404':
$ref: '#/components/responses/404'
/users/resetpassword:
post:
summary: Resets an user password if a reset password token is provided.
tags: ["Users"]
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: [email protected]
token:
type: string
example: e173013b01418260c75dceab78b8b0a80120c895
newPassword:
type: string
example: "10203040"
newPasswordConfirmation:
type: string
example: "10203040"
responses:
'200':
description: Password updated sucessfully. Returns the user that had password updated.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'400':
$ref: '#/components/responses/400-Validation'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
/users/password:
put:
summary: Updates user password.
description: The user is identified through the JWT token payload.
tags: ["Users"]
security:
- bearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
password:
type: string
newPassword:
type: string
newPasswordConfirmation:
type: string
example:
password: some-secure-password-123
newPassword: some-secure-password-123
newPasswordConfirmation: some-secure-password-123
responses:
'200':
description: User that had password updated.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'400':
$ref: '#/components/responses/400-Validation'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
### Foods
/foods:
get:
summary: Gets a list of foods filtered by name.
tags:
- "Foods"
parameters:
- in: query
name: foodName
schema:
type: string
example: arroz
security:
- bearerAuth: []
responses:
'200':
description: Search was sucessfull. Returns an array with the foods found.
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfFoods'
'400':
$ref: '#/components/responses/400-Validation'
'401':
$ref: '#/components/responses/401'
### Meals
/meals:
post:
summary: Creates a meal.
tags:
- "Meals"
security:
- bearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: "Breakfast"
date:
type: string
example: "2021-10-30T20:54:51.313Z"
description: ISO8601 Date string
responses:
'200':
description: Meal created successfully. Returns the Meal.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Meal'
'400':
$ref: '#/components/responses/400-Validation'
'401':
$ref: '#/components/responses/401'
get:
summary: List meals between two dates.
tags:
- "Meals"
parameters:
- in: query
name: startDate
required: true
schema:
type: string
example: "2021-02-27T02:14:07.968Z"
description: ISO8601 Date string
- in: query
name: endDate
required: true
schema:
type: string
example: "2021-03-01T23:14:07.968Z"
description: ISO8601 Date string
security:
- bearerAuth: []
responses:
'200':
description: Success. Returns an array of meals and total nutrients quantity.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ArrayOfMealsWithNutrients'
'400':
$ref: '#/components/responses/400-Validation'
'401':
$ref: '#/components/responses/401'
/meals/{mealId}:
get:
summary: Gets a meal by ID.
tags:
- "Meals"
security:
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/mealId'
responses:
'200':
description: Meal found successfully. Returns the Meal data, list of meal food items on it, and the total nutrients quantity.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Meal'
- type: object
properties:
mealFoods:
$ref: '#/components/schemas/ArrayOfMealFoodsWithFoodData'
- $ref: '#/components/schemas/Nutrients'
'400':
$ref: '#/components/responses/400-Validation'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
put:
summary: Updates meal name.
tags:
- "Meals"
security:
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/mealId'
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: "Breakfast"
responses:
'200':
description: Meal updated successfully. Returns the meal.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Meal'
- type: object
properties:
mealFoods:
$ref: '#/components/schemas/ArrayOfMealFoodsWithFoodData'
'400':
$ref: '#/components/responses/400-Validation'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
delete:
summary: Deletes meal.
tags:
- "Meals"
security:
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/mealId'
responses:
'200':
description: Meal deleted successfully. Returns the deleted Meal data, list of meal food items on it, and the total nutrients quantity.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Meal'
- type: object
properties:
mealFoods:
$ref: '#/components/schemas/ArrayOfMealFoodsWithFoodData'
- $ref: '#/components/schemas/Nutrients'
'400':
$ref: '#/components/responses/400-Validation'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
### Meal Foods
/mealfoods/{mealFoodId}:
get:
summary: Gets a meal food by ID.
tags:
- "Meal Foods"
security:
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/mealFoodId'
responses:
'200':
description: Meal food found successfully. Returns the Meal Food.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/MealFood'
- type: object
properties:
food:
$ref: '#/components/schemas/Food'
'400':
$ref: '#/components/responses/400-Validation'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
delete:
summary: Deletes a meal food by ID.
tags:
- "Meal Foods"
security:
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/mealFoodId'
responses:
'200':
description: Meal food deleted successfully. Returns the Meal Food.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/MealFood'
- type: object
properties:
food:
$ref: '#/components/schemas/Food'
'400':
$ref: '#/components/responses/400-Validation'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
put:
summary: Updated a meal food item with new quantity or food type.
tags:
- "Meal Foods"
security:
- bearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
foodId:
type: string
example: 4644d4ae-20f9-4e12-aaff-105dfa49ab2e
quantity:
type: number
example: 100
parameters:
- $ref: '#/components/parameters/mealFoodId'
responses:
'200':
description: Meal food updated successfully. Returns the Meal Food.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/MealFood'
- type: object
properties:
food:
$ref: '#/components/schemas/Food'
'400':
$ref: '#/components/responses/400-Validation'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
/mealfoods:
post:
summary: Adds food item (meal food) to a meal.
tags:
- "Meal Foods"
security:
- bearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
mealId:
type: string
example: 47826e94-b64a-4931-b280-0dd73a92ec0a
foodId:
type: string
example: 4644d4ae-20f9-4e12-aaff-105dfa49ab2e
quantity:
type: number
example: 350
quantity_unit:
type: string
example: g
default: g
description: For now, does not make a difference. In future releases it will be compatible with other units.
responses:
'200':
description: Meal food added successfully. Returns the Meal Food.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/MealFood'
- type: object
properties:
food:
$ref: '#/components/schemas/Food'
'400':
$ref: '#/components/responses/400-Validation'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
components:
parameters:
mealId:
in: path
name: mealId
schema:
type: string
example: c20f9417-1e6g-2e45-70d2-337f889a43a2
required: true
description: ID (uuid) of the meal.
mealFoodId:
in: path
name: mealFoodId
schema:
type: string
example: a20f9419-4e6e-4e42-90d4-737f889a43a1
required: true
description: ID (uuid) of the meal food.
schemas:
CreatedAtAndUpdatedAt:
allOf:
- type: object
properties:
created_at:
type: string
example: "2021-10-29T04:44:44.857Z"
updated_at:
type: string
example: "2021-10-29T04:44:44.857Z"
Nutrients:
allOf:
- type: object
properties:
energy_kcal:
type: number
example: 124
energy_kj:
type: number
example: 517
carbs:
type: number
example: 25.8
proteins:
type: number
example: 2.6
fats:
type: number
example: 1
User:
allOf:
- type: object
properties:
id:
type: string
example: "a20g9419-4e7e-4h42-91d4-737f899a42a1"
first_name:
type: string
example: Leonardo
last_name:
type: string
example: Ribeiro
email:
type: string
example: [email protected]
- $ref: '#/components/schemas/CreatedAtAndUpdatedAt'
Food:
allOf:
- type: object
properties:
id:
type: string
example: bf025758-6074-4986-b350-464866d5e3da
name:
type: string
example: "Arroz, integral, cozido"
standard_quantity:
type: integer
example: 100
standard_quantity_unit:
type: string
example: g
- $ref: '#/components/schemas/Nutrients'
- $ref: '#/components/schemas/CreatedAtAndUpdatedAt'
ArrayOfFoods:
allOf:
- type: array
items:
$ref: '#/components/schemas/Food'
Meal:
allOf:
- type: object
properties:
id:
type: string
example: faeff764-9c02-4f0a-9b11-881976a130e3
user_id:
type: string
example: 40aa3be3-30a4-43c3-afe8-c71edf967107
name:
type: string
example: "Breakfast"
date:
type: string
example: "2021-10-30T20:54:51.313Z"
description: ISO8601 Date string
- $ref: '#/components/schemas/CreatedAtAndUpdatedAt'
MealWithNutrientsAndMealFoods:
allOf:
- type: object
properties:
id:
type: string
example: faeff764-9c02-4f0a-9b11-881976a130e3
user_id:
type: string
example: 40aa3be3-30a4-43c3-afe8-c71edf967107
name:
type: string
example: "Breakfast"
date:
type: string
example: "2021-10-30T20:54:51.313Z"
description: ISO8601 Date string
mealFoods:
$ref: '#/components/schemas/ArrayOfMealFoodsWithFoodData'
- $ref: '#/components/schemas/Nutrients'
- $ref: '#/components/schemas/CreatedAtAndUpdatedAt'
ArrayOfMealsWithNutrients:
allOf:
- type: object
properties:
meals:
type: array
items:
$ref: '#/components/schemas/MealWithNutrientsAndMealFoods'
- $ref: '#/components/schemas/Nutrients'
MealFood:
allOf:
- type: object
properties:
id:
type: string
example: bf025758-6074-4986-b350-464866d5e3da
name:
type: string
example: "Arroz, integral, cozido"
food_id:
type: string
example: kf025750-5073-3985-e351-364866d5e3dc
meal_id:
type: string
example: af225659-6084-4886-c351-364866d5e3db
quantity:
type: number
example: 100
quantity_unit:
type: string
example: g
- $ref: '#/components/schemas/Nutrients'
- $ref: '#/components/schemas/CreatedAtAndUpdatedAt'
MealFoodWithFoodData:
allOf:
- $ref: '#/components/schemas/MealFood'
- type: object
properties:
food:
$ref: '#/components/schemas/Food'
ArrayOfMealFoodsWithFoodData:
allOf:
- type: array
items:
$ref: '#/components/schemas/MealFoodWithFoodData'
ValidationResponseData:
type: object
properties:
statusCode:
type: integer
example: 400
error:
type: string
example: Bad Request
message:
type: string
example: Request validation failed.
validation:
type: object
example:
body:
source: body
keys:
- quantity
message: quantity must be a number
responses:
'404':
description: The specified resource was not found.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
example: The specified resource was not found.
'401':
description: You didn't provided a token or are not allowed to see this resource or perform this action.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
example: You are not allowed to see this resource or perform this action.
'401-WrongPassword':
description: Password is wrong.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
example: Password does not match.
'401-NoTokenOrWrongPassword':
description: Password is wrong or bearer token was not provided.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
example: Password does not match.
'400-Validation':
description: Request validation failed. One or more parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponseData'
examples:
ValidationResponseExample:
value:
statusCode: 400
error: Bad Request
message: You are not allowed to see this resource or perform this action
validation:
body:
source: body
keys:
- quantity
message: quantity must be a number
EmailAlreadyInUseExample:
value:
message: Email already in use
401PasswordExample:
value:
message: Password does not match
404Example:
value:
message: The specified resource was not found
401Example:
value:
message: You are not allowed to see this resource or perform this action.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT