-
Notifications
You must be signed in to change notification settings - Fork 67
/
Copy pathresponse-media-type-base.yaml
490 lines (453 loc) · 11.4 KB
/
response-media-type-base.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
openapi: 3.0.0
info:
title: SmartChef API
version: 1.0.0
paths:
/products:
get:
summary: Returns a list of all products
tags:
- Products
parameters:
- $ref: '#/components/parameters/takeParam'
- $ref: '#/components/parameters/skipParam'
- in: query
name: gtin
schema:
type: string
maxLength: 13
- in: query
name: name
schema:
type: string
- in: query
name: beschreibung
schema:
type: string
responses:
'200':
description: JSON Array of products
content:
application/javascript:
schema:
type: string
application/json:
schema:
$ref: '#/components/schemas/ProductDto'
post:
summary: Creates a new product
tags:
- Products
responses:
'201':
description: Returns the created product as JSON
content:
application/json:
schema:
$ref: '#/components/schemas/ProductDto'
'409':
description: GTIN already taken
/products/{productId}:
get:
summary: Gets the product with the specified productId
parameters:
- in: path
name: productId
schema:
type: string
format: uuid
required: true
description: The UUID of the requested product
tags:
- Products
responses:
'200':
description: Returns the requested product
content:
application/json:
schema:
$ref: '#/components/schemas/ProductDto'
'404':
description: Product with provided ID does not exist
/products/{productId}/categories:
get:
summary: Gets the categories of the specified product
parameters:
- in: path
name: productId
schema:
type: string
format: uuid
required: true
description: The UUID of the requested product
tags:
- Products
responses:
'200':
description: Returns the categories of the requested product
content:
application/json:
schema:
$ref: '#/components/schemas/ProductDto'
'404':
description: Product with provided ID does not exist
'500':
description: Internal Server Error
'400':
description: Bad Request
/users:
get:
tags:
- Users
summary: Gets all users
parameters:
- $ref: '#/components/parameters/takeParam'
- $ref: '#/components/parameters/skipParam'
- in: query
name: vorname
schema:
type: string
- in: query
name: nachname
schema:
type: string
responses:
'200':
description: Returns public users
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PublicUserDto'
post:
tags:
- Users
summary: Creates a new user
requestBody:
description: Data for the new user
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserDto'
responses:
'201':
description: The created user
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateUserDto'
'409':
description: Email already taken
/users/{userId}:
get:
tags:
- Users
summary: Gets the requested user
parameters:
- in: path
name: userId
schema:
type: string
format: uuid
required: true
description: The UUID of the requested user
responses:
'200':
description: Returns the requested user
content:
application/json:
schema:
$ref: '#/components/schemas/PublicUserDto'
put:
tags:
- Users
summary: Updates a user
parameters:
- in: path
name: userId
schema:
type: string
format: uuid
required: true
description: The UUID of the user to be updated
requestBody:
description: User update data
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserDto'
responses:
'200':
description: Returns the updated user
content:
application/json:
schema:
$ref: '#/components/schemas/PublicUserDto'
/auth/login:
post:
tags:
- Auth
summary: Logs in the user
requestBody:
description: User credentials
content:
application/json:
schema:
$ref: '#/components/schemas/LoginDto'
responses:
'201':
description: Returns the created token pair
content:
application/json:
schema:
$ref: '#/components/schemas/TokenResponse'
'403':
description: Wrong email and/or password
/auth/refresh:
post:
tags:
- Auth
summary: Gets a new access token using the provided refresh token
requestBody:
description: Refresh token
content:
application/json:
schema:
type: object
properties:
refreshToken:
type: string
format: jwt
responses:
'201':
description: Returns a new token pair
content:
application/json:
schema:
$ref: '#/components/schemas/TokenResponse'
components:
securitySchemes:
bearerAuth: # arbitrary name for the security scheme
type: http
scheme: bearer
bearerFormat: JWT
schemas:
ResourceDto:
type: object
properties:
id:
type: string
format: uuid
createdAt:
type: string
format: datetime
updatedAt:
type: string
format: datetime
ProductDto:
type: object
allOf:
- $ref: '#/components/schemas/ResourceDto'
- type: object
properties:
gtin:
type: string
name:
type: string
beschreibung:
type: string
menge:
type: number
minimum: 0
einheit:
type: string
kategorieId:
type: string
format: uuid
herstellerId:
type: string
format: uuid
TokenResponse:
type: object
properties:
accessToken:
type: string
format: jwt
refreshToken:
type: string
format: jwt
PublicUserDto:
type: object
properties:
id:
type: string
format: uuid
vorname:
type: string
maxLength: 255
nachname:
type: string
maxLength: 255
PrivateUserDto:
type: object
allOf:
- $ref: '#/components/schemas/PublicUserDto'
- type: object
properties:
email:
type: string
format: email
maxLength: 255
LoginDto:
type: object
properties:
email:
type: string
format: email
maxLength: 255
password:
type: string
maxLength: 255
HaushaltDto:
type: object
allOf:
- $ref: '#/components/schemas/ResourceDto'
- type: object
properties:
name:
type: string
maxLength: 255
HaushaltProduktDto:
type: object
allOf:
- $ref: '#/components/schemas/ResourceDto'
- $ref: '#/components/schemas/ProductDto'
- type: object
properties:
haushaltId:
type: string
format: uuid
ist:
type: number
soll:
type: number
HerstellerDto:
type: object
allOf:
- $ref: '#/components/schemas/ResourceDto'
- type: object
properties:
name:
type: string
ProduktKategorieDto:
type: object
allOf:
- $ref: '#/components/schemas/ResourceDto'
- type: object
properties:
name:
type: string
maxLength: 255
parentId:
type: string
format: uuid
RezeptDto:
type: object
allOf:
- $ref: '#/components/schemas/ResourceDto'
- type: object
properties:
name:
type: string
maxLength: 255
beschreibung:
type: string
maxLength: 255
anleitungText:
type: string
maxLength: 4000
url:
type: string
format: url
maxLength: 1024
kategorieId:
type: string
format: string
RezeptKategorieDto:
type: object
allOf:
- $ref: '#/components/schemas/ResourceDto'
- type: object
properties:
name:
type: string
parentId:
type: string
format: uuid
ZutatenDto:
type: object
allOf:
- $ref: '#/components/schemas/ResourceDto'
- type: object
properties:
produktKategorieId:
type: string
maxLength: 255
menge:
type: number
minimum: 0
einheit:
type: string
maxLength: 255
rezeptId:
type: string
format: uuid
CreateUserDto:
type: object
required:
- password
- vorname
- nachname
properties:
password:
type: string
minLength: 8
maxLength: 255
vorname:
type: string
maxLength: 255
nachname:
type: string
maxLength: 255
UpdateUserDto:
type: object
properties:
password:
type: string
maxLength: 255
vorname:
type: string
maxLength: 255
nachname:
type: string
maxLength: 255
parameters:
takeParam:
in: query
name: take
schema:
type: integer
minimum: 1
maximum: 50
description: The amount of users to return
skipParam:
in: query
name: skip
schema:
type: integer
minimum: 1
maximum: 50
description: The amount of users to skip
security:
- bearerAuth: []