generated from peter-evans/swagger-github-pages
-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
434 lines (434 loc) · 12.6 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
basePath: /v1/tcpl
definitions:
CalculationOrder:
properties:
machines:
items:
$ref: '#/definitions/Machine'
type: array
order:
example: Order_ID
type: string
type: object
CalculationTime:
properties:
from:
example: "2021-10-11T10:50:00+02:00"
type: string
machines:
items:
$ref: '#/definitions/Machine'
type: array
orders:
items:
$ref: '#/definitions/Order'
type: array
until:
example: "2021-10-11T14:50:00+02:00"
type: string
type: object
CreateOrder:
properties:
id:
example: '#123AB'
type: string
machineId:
example: BF007
type: string
plannedStart:
example: "2021-10-11T10:00:00+02:00"
type: string
type: object
Error:
properties:
code:
example: 400
type: integer
message:
example: descriptive error message
type: string
type: object
Machine:
properties:
id:
example: BF007
type: string
totals:
$ref: '#/definitions/Totals'
type: object
MachineIndex:
properties:
id:
example: BF007
type: string
type: object
Material:
properties:
materialname:
example: 32.27
type: number
type: object
Order:
properties:
id:
example: '#123AB'
type: string
machineId:
example: BF007
type: string
plannedStart:
example: "2021-10-11T10:00:00+02:00"
type: string
startedAt:
example: "2021-10-11T10:50:04+02:00"
type: string
type: object
Totals:
properties:
energy:
example: 115
type: number
energyUnit:
example: kWh
type: string
length:
example: 2124
type: number
lengthUnit:
example: m
type: string
materialConsumption:
example: 355
type: number
materialConsumptionExtruder1:
example: 32.27
type: number
materialConsumptionExtruder1Component1:
$ref: '#/definitions/Material'
materialConsumptionExtruder1Component2:
$ref: '#/definitions/Material'
materialConsumptionExtruder1Component3:
$ref: '#/definitions/Material'
materialConsumptionExtruder1Component4:
$ref: '#/definitions/Material'
materialConsumptionExtruder1Component5:
$ref: '#/definitions/Material'
materialConsumptionExtruder1Component6:
$ref: '#/definitions/Material'
materialConsumptionExtruder2:
example: 32.27
type: number
materialConsumptionExtruder2Component1:
$ref: '#/definitions/Material'
materialConsumptionExtruder2Component2:
$ref: '#/definitions/Material'
materialConsumptionExtruder2Component3:
$ref: '#/definitions/Material'
materialConsumptionExtruder2Component4:
$ref: '#/definitions/Material'
materialConsumptionExtruder2Component5:
$ref: '#/definitions/Material'
materialConsumptionExtruder2Component6:
$ref: '#/definitions/Material'
materialConsumptionExtruder3:
example: 32.27
type: number
materialConsumptionExtruder3Component1:
$ref: '#/definitions/Material'
materialConsumptionExtruder3Component2:
$ref: '#/definitions/Material'
materialConsumptionExtruder3Component3:
$ref: '#/definitions/Material'
materialConsumptionExtruder3Component4:
$ref: '#/definitions/Material'
materialConsumptionExtruder3Component5:
$ref: '#/definitions/Material'
materialConsumptionExtruder3Component6:
$ref: '#/definitions/Material'
materialConsumptionExtruder4:
example: 32.27
type: number
materialConsumptionExtruder4Component1:
$ref: '#/definitions/Material'
materialConsumptionExtruder4Component2:
$ref: '#/definitions/Material'
materialConsumptionExtruder4Component3:
$ref: '#/definitions/Material'
materialConsumptionExtruder4Component4:
$ref: '#/definitions/Material'
materialConsumptionExtruder4Component5:
$ref: '#/definitions/Material'
materialConsumptionExtruder4Component6:
$ref: '#/definitions/Material'
materialConsumptionExtruder5:
example: 32.27
type: number
materialConsumptionExtruder5Component1:
$ref: '#/definitions/Material'
materialConsumptionExtruder5Component2:
$ref: '#/definitions/Material'
materialConsumptionExtruder5Component3:
$ref: '#/definitions/Material'
materialConsumptionExtruder5Component4:
$ref: '#/definitions/Material'
materialConsumptionExtruder5Component5:
$ref: '#/definitions/Material'
materialConsumptionExtruder5Component6:
$ref: '#/definitions/Material'
materialConsumptionExtruder6:
example: 32.27
type: number
materialConsumptionExtruder6Component1:
$ref: '#/definitions/Material'
materialConsumptionExtruder6Component2:
$ref: '#/definitions/Material'
materialConsumptionExtruder6Component3:
$ref: '#/definitions/Material'
materialConsumptionExtruder6Component4:
$ref: '#/definitions/Material'
materialConsumptionExtruder6Component5:
$ref: '#/definitions/Material'
materialConsumptionExtruder6Component6:
$ref: '#/definitions/Material'
materialConsumptionExtruder7:
example: 32.27
type: number
materialConsumptionExtruder7Component1:
$ref: '#/definitions/Material'
materialConsumptionExtruder7Component2:
$ref: '#/definitions/Material'
materialConsumptionExtruder7Component3:
$ref: '#/definitions/Material'
materialConsumptionExtruder7Component4:
$ref: '#/definitions/Material'
materialConsumptionExtruder7Component5:
$ref: '#/definitions/Material'
materialConsumptionExtruder7Component6:
$ref: '#/definitions/Material'
materialConsumptionExtruder8:
example: 32.27
type: number
materialConsumptionExtruder8Component1:
$ref: '#/definitions/Material'
materialConsumptionExtruder8Component2:
$ref: '#/definitions/Material'
materialConsumptionExtruder8Component3:
$ref: '#/definitions/Material'
materialConsumptionExtruder8Component4:
$ref: '#/definitions/Material'
materialConsumptionExtruder8Component5:
$ref: '#/definitions/Material'
materialConsumptionExtruder8Component6:
$ref: '#/definitions/Material'
materialConsumptionExtruder9:
example: 32.27
type: number
materialConsumptionExtruder9Component1:
$ref: '#/definitions/Material'
materialConsumptionExtruder9Component2:
$ref: '#/definitions/Material'
materialConsumptionExtruder9Component3:
$ref: '#/definitions/Material'
materialConsumptionExtruder9Component4:
$ref: '#/definitions/Material'
materialConsumptionExtruder9Component5:
$ref: '#/definitions/Material'
materialConsumptionExtruder9Component6:
$ref: '#/definitions/Material'
materialConsumptionExtruder10:
example: 32.27
type: number
materialConsumptionExtruder10Component1:
$ref: '#/definitions/Material'
materialConsumptionExtruder10Component2:
$ref: '#/definitions/Material'
materialConsumptionExtruder10Component3:
$ref: '#/definitions/Material'
materialConsumptionExtruder10Component4:
$ref: '#/definitions/Material'
materialConsumptionExtruder10Component5:
$ref: '#/definitions/Material'
materialConsumptionExtruder10Component6:
$ref: '#/definitions/Material'
materialConsumptionExtruder11:
example: 32.27
type: number
materialConsumptionExtruder11Component1:
$ref: '#/definitions/Material'
materialConsumptionExtruder11Component2:
$ref: '#/definitions/Material'
materialConsumptionExtruder11Component3:
$ref: '#/definitions/Material'
materialConsumptionExtruder11Component4:
$ref: '#/definitions/Material'
materialConsumptionExtruder11Component5:
$ref: '#/definitions/Material'
materialConsumptionExtruder11Component6:
$ref: '#/definitions/Material'
materialConsumptionUnit:
example: kg
type: string
runTime:
example: 4
type: number
runTimeUnit:
example: h
type: string
type: object
host: localhost:1323
info:
contact:
email: [email protected]
name: Robert Sliwinski
url: http://r-ecosystem.de
description: API for the ERP system to query the c.Hub for production parameters
of each machine.
termsOfService: http://r-ecosystem.de
title: TCPL API
version: "0.1"
paths:
/calculation/time:
get:
consumes:
- application/json
description: Returns an object of calculations for a certain time period
operationId: get-calculations
parameters:
- example: "2021-10-11T10:50:00+02:00"
in: query
name: from
type: string
- example: "2021-10-11T14:50:00+02:00"
in: query
name: until
type: string
produces:
- application/json
responses:
"200":
description: Calculation for a time period
schema:
$ref: '#/definitions/CalculationTime'
"400":
description: Bad request
schema:
$ref: '#/definitions/Error'
"404":
description: Not found
schema:
$ref: '#/definitions/Error'
summary: Get calculations for a specific time period
tags:
- CalculationsTime
/calculations/order:
get:
consumes:
- application/json
description: Returns an object of calculations for a certain time period
operationId: get-calculations_order
parameters:
- example: Order_ID
in: query
name: order
type: string
produces:
- application/json
responses:
"200":
description: Calculation for a time period
schema:
$ref: '#/definitions/CalculationOrder'
"400":
description: Bad request
schema:
$ref: '#/definitions/Error'
"404":
description: Not found
schema:
$ref: '#/definitions/Error'
summary: Get calculations for a specific time period
tags:
- CalculationsOrder
/machines:
get:
consumes:
- application/json
description: Returns an array of all known machines from the time-series database
operationId: get-machines
produces:
- application/json
responses:
"200":
description: An collection of machines
schema:
items:
$ref: '#/definitions/MachineIndex'
type: array
"400":
description: Bad request
schema:
$ref: '#/definitions/Error'
"404":
description: Not found
schema:
$ref: '#/definitions/Error'
summary: Get all machines
tags:
- Machines
/order:
post:
consumes:
- application/json
description: Create an order inside the machines HMI
operationId: post-order
parameters:
- description: Create an Order Object
in: body
name: data
required: true
schema:
$ref: '#/definitions/CreateOrder'
produces:
- application/json
responses:
"201":
description: Inserted Order
schema:
$ref: '#/definitions/CreateOrder'
"400":
description: Bad request
schema:
$ref: '#/definitions/Error'
"404":
description: Not found
schema:
$ref: '#/definitions/Error'
summary: Create order in machines HMI
tags:
- Order
/roll:
get:
consumes:
- application/json
description: Get Roll from DB as CSV
operationId: get-rolls
produces:
- text/csv
responses:
"201":
description: CSV Response
"400":
description: Bad request
schema:
$ref: '#/definitions/Error'
"404":
description: Not found
schema:
$ref: '#/definitions/Error'
summary: Get Roll from DB
tags:
- Roll
securityDefinitions:
BasicAuth:
type: basic
swagger: "2.0"