-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathswagger.yaml
375 lines (375 loc) · 8.68 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
basePath: /api/meal
definitions:
dto.AvgKcalPerMealTypeDto:
properties:
avgKcal:
type: number
mealType:
type: string
type: object
dto.BaseResponse-array_dto_FoodConsumptionDto:
properties:
body:
items:
$ref: '#/definitions/dto.FoodConsumptionDto'
type: array
errorMessage:
type: string
type: object
dto.BaseResponse-array_dto_MealDto:
properties:
body:
items:
$ref: '#/definitions/dto.MealDto'
type: array
errorMessage:
type: string
type: object
dto.BaseResponse-bool:
properties:
body:
type: boolean
errorMessage:
type: string
type: object
dto.BaseResponse-dto_FoodConsumptionDto:
properties:
body:
$ref: '#/definitions/dto.FoodConsumptionDto'
errorMessage:
type: string
type: object
dto.BaseResponse-dto_MealDto:
properties:
body:
$ref: '#/definitions/dto.MealDto'
errorMessage:
type: string
type: object
dto.BaseResponse-dto_MealStatisticsDto:
properties:
body:
$ref: '#/definitions/dto.MealStatisticsDto'
errorMessage:
type: string
type: object
dto.FoodConsumptionDto:
properties:
cost:
type: number
foodId:
type: string
foodName:
type: string
id:
type: string
kcal:
type: number
mealId:
type: string
quantityUsed:
type: number
quantityUsedStd:
type: number
transactionId:
type: string
unit:
type: string
type: object
dto.MealDto:
properties:
cost:
type: number
date:
type: string
description:
type: string
id:
type: string
kcal:
type: number
mealType:
$ref: '#/definitions/model.MealType'
name:
type: string
userId:
type: string
type: object
dto.MealStatisticsDto:
properties:
averageWeekCalories:
type: number
averageWeekCaloriesPerMealType:
items:
$ref: '#/definitions/dto.AvgKcalPerMealTypeDto'
type: array
averageWeekFoodCost:
type: number
mostConsumedFood:
$ref: '#/definitions/dto.MostConsumedFoodDto'
sumWeekFoodCost:
type: number
type: object
dto.MostConsumedFoodDto:
properties:
foodId:
type: string
foodName:
type: string
quantityUsed:
type: number
quantityUsedStd:
type: number
unit:
type: string
type: object
model.MealType:
enum:
- breakfast
- lunch
- dinner
- others
type: string
x-enum-varnames:
- Breakfast
- Lunch
- Dinner
- Others
host: localhost:8080
info:
contact:
email: [email protected]
name: Nicola Iacovelli
description: This is a sample server celler server.
title: Food track be API
version: "1.0"
paths:
/:
get:
description: get all the meals which satisfies the query parameters (startRange,
endRange) or all meals if no query parameters are provided
parameters:
- description: Start date of the range
in: query
name: startRange
type: string
- description: End date of the range
in: query
name: endRange
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.BaseResponse-array_dto_MealDto'
summary: Get all meals
tags:
- meal
post:
consumes:
- application/json
description: create a new meal
parameters:
- description: Meal to create
in: body
name: mealDto
required: true
schema:
$ref: '#/definitions/dto.MealDto'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.BaseResponse-dto_MealDto'
summary: Create meal
tags:
- meal
/{mealId}/:
delete:
consumes:
- application/json
description: delete the meal with the provided id
parameters:
- description: Meal ID
in: path
name: mealId
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.BaseResponse-bool'
summary: Delete meal
tags:
- meal
get:
description: get the meal with the provided id
parameters:
- description: Meal ID
in: path
name: mealId
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.BaseResponse-dto_MealDto'
summary: Get meal
tags:
- meal
patch:
consumes:
- application/json
description: update the meal with the provided id
parameters:
- description: Meal ID
in: path
name: mealId
required: true
type: string
- description: Meal to create
in: body
name: mealDto
required: true
schema:
$ref: '#/definitions/dto.MealDto'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.BaseResponse-dto_MealDto'
summary: Update meal
tags:
- meal
/{mealId}/consumption/:
delete:
consumes:
- application/json
description: delete consumption for the meal by mealId
parameters:
- description: Meal ID
in: path
name: mealId
required: true
type: string
- description: Food consumption ID
in: path
name: foodConsumptionId
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.BaseResponse-bool'
summary: Delete consumption for the meal
tags:
- food-consumption
get:
description: find all the consumption for the meal by mealId
parameters:
- description: Meal ID
in: path
name: mealId
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.BaseResponse-array_dto_FoodConsumptionDto'
summary: Get all consumption for the meal
tags:
- food-consumption
patch:
consumes:
- application/json
description: update consumption for the meal by mealId
parameters:
- description: Meal ID
in: path
name: mealId
required: true
type: string
- description: Food Consumption
in: body
name: foodConsumptionDto
required: true
schema:
$ref: '#/definitions/dto.FoodConsumptionDto'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.BaseResponse-dto_FoodConsumptionDto'
summary: Update consumption for the meal
tags:
- food-consumption
post:
consumes:
- application/json
description: add consumption for the meal by mealId
parameters:
- description: Meal ID
in: path
name: mealId
required: true
type: string
- description: Food Consumption
in: body
name: foodConsumptionDto
required: true
schema:
$ref: '#/definitions/dto.FoodConsumptionDto'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.BaseResponse-dto_FoodConsumptionDto'
summary: Add consumption for the meal
tags:
- food-consumption
/statistics/:
get:
description: get the meal statistics for the provided date range (default is
the past week)
parameters:
- description: Start date of the range
in: query
name: startRange
type: string
- description: End date of the range
in: query
name: endRange
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/dto.BaseResponse-dto_MealStatisticsDto'
summary: Get meal statistics
tags:
- meal
swagger: "2.0"