-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
1209 lines (1209 loc) · 29.4 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
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
swagger: '2.0'
info:
description: The REST API of Production Manager
version: 1.0.0
title: ProductionManager
basePath: /api/
tags:
- name: machines
description: Gets the machines connected or available
- name: shopping cart
description: The articles collected for purchase
- name: orders
description: The orders at the marketplace
- name: objects
description: marketplace objects
- name: local objects
description: the local objects
- name: materials
description: the material information from the marketplace
- name: machine types
description: the machine types known by the marketplace
schemes:
- http
paths:
/machines:
get:
tags:
- machines
summary: returns all local available and connected machines
operationId: getMachines
produces:
- application/json
responses:
'200':
description: here it comes
schema:
type: array
items:
$ref: '#/definitions/Machine'
'/machines/{machineId}':
delete:
tags:
- machines
summary: deletes the machine by id
operationId: deleteMachineById
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- application/json
responses:
'200':
description: deleted
get:
tags:
- machines
summary: returns the machine by id
operationId: getMachineById
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- application/json
responses:
'200':
description: here it comes
schema:
$ref: '#/definitions/Machine'
'/machines/{machineId}/authentication':
post:
tags:
- machines
summary: authenticates the pm at the given machien
operationId: requestMachineAuthenticationById
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- application/json
responses:
'201':
description: seems to be authenticated
'500':
description: seems not to be authenticated
get:
tags:
- machines
summary: gives information about the authenticaton status
operationId: getMachineAuthenticationById
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- application/json
responses:
'200':
description: the status in the body
schema:
type: object
properties:
message:
type: string
'/machines/{machineId}/authentication/verify':
get:
tags:
- machines
summary: verifies authentication of pm
operationId: verifyMachineAuthenticationById
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- application/json
responses:
'200':
description: the status in the body
schema:
type: object
properties:
message:
type: string
'/machines/{machineId}/hsm':
get:
tags:
- machines
summary: gets all hsm ids for machine
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- application/json
responses:
'200':
description: a list of hsm ids
schema:
type: array
items:
type: string
'/machines/{machineId}/hsm/all/licenses':
get:
tags:
- machines
summary: gets all licenses
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- application/json
responses:
'200':
description: a list of hsm ids
schema:
type: array
items:
$ref: '#/definitions/License'
'/machines/{machineId}/hsm/{hsmId}/licenses':
get:
tags:
- machines
summary: gets all licenses of a hsm
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
- name: hsmId
in: path
description: ID of the hsm
required: true
type: string
produces:
- application/json
responses:
'200':
description: a list of hsm ids
schema:
type: array
items:
$ref: '#/definitions/License'
'/machines/{machineId}/hsm/{hsmId}/productcodes/{productcode}':
get:
tags:
- machines
summary: get license count for product code
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
- name: hsmId
in: path
description: ID of the hsm
required: true
type: string
- name: productcode
in: path
description: productcode
required: true
type: string
produces:
- text/plain
responses:
'200':
description: the count of licenses
schema:
type: integer
'/machines/{machineId}/materials/active':
get:
tags:
- machines
summary: gets the loaded materials in the machine
operationId: getActiveMaterialinMachineById
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- application/json
responses:
'200':
description: the materials
schema:
type: array
items:
$ref: '#/definitions/LoadedMaterial'
'/machines/{machineId}/materials/active/{extruderId}':
get:
tags:
- machines
summary: gets the loaded materials in the machine for the given extruder
operationId: getActiveMaterialinMachineByIdAndExtruder
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
- name: extruderId
in: path
description: ID of extruder to return
required: true
type: integer
minimum: 0
maximum: 0
produces:
- application/json
responses:
'200':
description: the material
schema:
$ref: '#/definitions/LoadedMaterial'
'/machines/{machineId}/materials/{materialId}':
get:
tags:
- machines
summary: gets a material information from the machine (as XML)
operationId: getMaterialDetailFromMachineByIds
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
- name: materialId
in: path
description: ID of extruder to return
required: true
type: string
produces:
- application/xml
responses:
'200':
description: the material
'/machines/{machineId}/materials/{materialId}/short':
get:
tags:
- machines
summary: gets a shorted material information from the machine
operationId: getMaterialShortFromMachineByIds
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
- name: materialId
in: path
description: ID of extruder to return
required: true
type: string
produces:
- application/json
responses:
'200':
description: the material
schema:
$ref: '#/definitions/MaterialInfo'
'/machines/{machineId}/materials/{materialId}/name':
get:
tags:
- machines
summary: gets material name from the machine
operationId: getMaterialShortNameFromMachineByIds
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
- name: materialId
in: path
description: ID of extruder to return
required: true
type: string
produces:
- text/html
responses:
'200':
description: the name
'/machines/{machineId}/status':
get:
tags:
- machines
summary: gets the machines status
operationId: getMachineStatusById
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- text/html
responses:
'200':
description: the status
'/machines/{machineId}/printjob':
get:
tags:
- machines
summary: gets the machines current printjob
operationId: getMachinePrintjobById
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- application/json
responses:
'200':
description: the printjob
'/machines/{machineId}/printjob/state':
get:
tags:
- machines
summary: gets the machines current printjobs state
operationId: getMachinePrintjobStateById
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- text/html
responses:
'200':
description: the printjob state
'/machines/{machineId}/printjob/progress':
get:
tags:
- machines
summary: gets the machines current printjobs progress
operationId: getMachinePrintjobProgressById
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- text/html
responses:
'200':
description: the printjob progress
'/machines/{machineId}/printjob/time/total':
get:
tags:
- machines
summary: gets the machines current printjobs total time
operationId: getMachinePrintjobTimeTotalById
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- text/html
responses:
'200':
description: the printjobs total time
'/machines/{machineId}/printjob/time/elapsed':
get:
tags:
- machines
summary: gets the machines current printjobs elapsed time
operationId: getMachinePrintjobTimeElapsedById
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- text/html
responses:
'200':
description: the printjobs total time
'/machines/{machineId}/printjob/time/remaining':
get:
tags:
- machines
summary: gets the machines current printjobs remaining time
operationId: getMachinePrintjobTimeRemainingById
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- text/html
responses:
'200':
description: the printjobs remaining time
'/machines/{machineId}/camera/stream':
get:
tags:
- machines
summary: the mjpeg stream
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- video/x-motion-jpeg
responses:
'200':
description: the stream
'/machines/{machineId}/camera/snapshot':
get:
tags:
- machines
summary: the snapshot from the camera
parameters:
- name: machineId
in: path
description: ID of machine to return
required: true
type: string
produces:
- image/jpeg
responses:
'200':
description: the snapshot
/machinetypes:
get:
tags:
- machine types
summary: Gets the machinetypes defined in the TDM
parameters:
- name: lang
in: query
description: defines the language the texts should be returned
required: true
type: string
produces:
- application/json
responses:
'200':
description: an array of machine types
schema:
type: array
items:
$ref: '#/definitions/Component'
/materials:
get:
tags:
- materials
summary: Gets the materials defined in the TDM
parameters:
- name: lang
in: query
description: defines the language the texts should be returned
required: true
type: string
produces:
- application/json
responses:
'200':
description: an array of material types
schema:
type: array
items:
$ref: '#/definitions/Component'
/materials/hierarchical:
get:
tags:
- materials
summary: Gets the materials defined in the TDM in a hierarchical layout
parameters:
- name: lang
in: query
description: defines the language the texts should be returned
required: true
type: string
produces:
- application/json
responses:
'200':
description: a hierarchy of material types
schema:
type: array
items:
$ref: '#/definitions/Component'
/shopping_cart/items:
post:
tags:
- shopping cart
summary: adds a item to the shopping cart
description: 'if an item with this objectid exists, the item is updated in the amount'
parameters:
- name: item
in: body
description: the item
required: true
schema:
$ref: '#/definitions/Item'
produces:
- application/json
responses:
'200':
description: the item in the shopping cart
schema:
$ref: '#/definitions/Item'
get:
tags:
- shopping cart
summary: returns all items in the shopping cart
produces:
- application/json
responses:
'200':
description: the items in the shopping cart
schema:
type: array
items:
$ref: '#/definitions/Item'
delete:
tags:
- shopping cart
summary: deletes all items in the shopping cart
responses:
'200':
description: the items in the shopping cart
'/shopping_cart/items/{itemId}':
get:
tags:
- shopping cart
summary: returns a item in the shopping cart
parameters:
- name: itemId
in: path
description: ID of item to return
required: true
type: string
produces:
- application/json
responses:
'200':
description: the item in the shopping cart
schema:
$ref: '#/definitions/Item'
put:
tags:
- shopping cart
summary: updates a item in the shopping cart
parameters:
- name: itemId
in: path
description: ID of item to update
required: true
type: string
- name: item
in: body
description: the item
required: true
schema:
$ref: '#/definitions/Item'
produces:
- application/json
responses:
'200':
description: the item in the shopping cart
schema:
$ref: '#/definitions/Item'
delete:
tags:
- shopping cart
summary: deletes a item in the shopping cart
parameters:
- name: itemId
in: path
description: ID of item to delete
required: true
type: string
produces:
- application/json
responses:
'200':
description: the item in the shopping cart
schema:
$ref: '#/definitions/Item'
/shopping_cart/order:
post:
tags:
- shopping cart
- orders
summary: creates an order out of a shopping cart
produces:
- application/json
responses:
'200':
description: the resulting order
schema:
$ref: '#/definitions/Order'
/orders:
get:
tags:
- orders
summary: get all orders
produces:
- application/json
responses:
'200':
description: all order
schema:
type: array
items:
$ref: '#/definitions/Order'
delete:
tags:
- orders
summary: delete all orders
produces:
- application/json
responses:
'200':
description: all orders deleted
'/orders/{orderId}':
get:
tags:
- orders
summary: get all orders
parameters:
- name: orderId
in: path
description: ID of order
required: true
type: string
produces:
- application/json
responses:
'200':
description: all order
schema:
$ref: '#/definitions/Order'
delete:
tags:
- orders
summary: delete all orders
parameters:
- name: orderId
in: path
description: ID of order
required: true
type: string
produces:
- application/json
responses:
'200':
description: order deleted
'/orders/{orderId}/licenseupdate':
get:
tags:
- orders
summary: trigger licenseupdate
parameters:
- name: orderId
in: path
description: ID of order
required: true
type: string
produces:
- application/json
responses:
'200':
description: triggered licenseupdate
/objects:
get:
tags:
- objects
summary: gets a list of objects from TDM
parameters:
- name: filter
in: query
description: the filter created before
required: false
type: string
produces:
- application/json
responses:
'200':
description: the objects
schema:
type: array
items:
$ref: '#/definitions/Object'
'/objects/{objectId}/image':
get:
tags:
- objects
summary: gets the image of a object
parameters:
- name: objectId
in: path
description: ID of object to return
required: true
type: string
produces:
- image/svg+xml
- image/png
responses:
'200':
description: the image
'/objects/{objectId}/binary':
get:
tags:
- objects
summary: gets the binary of a object
description: 'only available, if this article was purchased once'
parameters:
- name: objectId
in: path
description: ID of object to return
required: true
type: string
responses:
'200':
description: the image
'/objects/{objectId}/print':
post:
tags:
- objects
summary: prints this object
parameters:
- name: objectId
in: path
description: ID of object to return
required: true
type: string
responses:
'200':
description: triggered print
/objects/filters:
post:
tags:
- objects
summary: creates a filter
parameters:
- name: filter
in: body
description: the filter to create
required: true
schema:
$ref: '#/definitions/Filter'
responses:
'201':
description: object created
headers:
Location:
type: string
description: the path to the created object
'/objects/filters/{filterId}':
get:
tags:
- objects
summary: gets a filter
parameters:
- name: filterId
in: path
description: the filterid
required: true
type: string
responses:
'200':
description: the filter
schema:
$ref: '#/definitions/Filter'
/localobjects:
post:
tags:
- local objects
summary: uplaod a new object
consumes:
- application/x-www-form-urlencoded
- multipart/form-data
parameters:
- name: file
description: The ufp containing gcode and image
in: formData
type: file
- name: title
in: formData
type: string
responses:
'201':
description: object created
headers:
Location:
type: string
description: the path to the created object
get:
tags:
- local objects
summary: gets a list of local objects
parameters:
- name: materials
in: query
description: 'the materialIds to filter the results, none equals all'
required: false
type: array
items:
type: string
- name: machines
in: query
description: 'the machinetypeIds to filter the results, none equals all'
required: false
type: array
items:
type: string
- name: lang
in: query
description: defines the language the texts should be returned
required: true
type: string
produces:
- application/json
responses:
'200':
description: the local objects
schema:
type: array
items:
$ref: '#/definitions/LocalObject'
'/localobjects/{localObjectId}':
get:
tags:
- local objects
summary: gets a local objects
parameters:
- name: localObjectId
in: path
description: ID of object to return
required: true
type: string
produces:
- application/json
responses:
'200':
description: the local object
schema:
$ref: '#/definitions/LocalObject'
delete:
tags:
- local objects
summary: delete a local objects
parameters:
- name: localObjectId
in: path
description: ID of object to delete
required: true
type: string
produces:
- application/json
responses:
'200':
description: deleted
patch:
tags:
- local objects
summary: can be used to update title or description of a local object
parameters:
- name: localObjectId
in: path
description: ID of object to delete
required: true
type: string
- name: patch
in: body
description: the properties of the local object to patch
required: true
schema:
$ref: '#/definitions/LocalObjectPatch'
produces:
- application/json
responses:
'200':
description: the local object
schema:
$ref: '#/definitions/LocalObject'
'/localobjects/{localObjectId}/image':
get:
tags:
- local objects
summary: gets the image of a local object
parameters:
- name: localObjectId
in: path
description: ID of object to return
required: true
type: string
produces:
- image/png
responses:
'200':
description: the image
'/localobjects/{localObjectId}/publish':
post:
tags:
- local objects
- objects
summary: starts upload process to tdm
parameters:
- name: localObjectId
in: path
description: ID of object to return
required: true
type: string
- name: publishInfo
in: body
description: the information for publish
required: true
schema:
$ref: '#/definitions/PublishInfo'
responses:
'201':
description: published
'/localobjects/{localObjectId}/publish/retry':
post:
tags:
- local objects
- objects
summary: retries upload process to tdm
parameters:
- name: localObjectId
in: path
description: ID of object to return
required: true
type: string