-
Notifications
You must be signed in to change notification settings - Fork 52
/
openapi.yaml
1703 lines (1644 loc) · 46.4 KB
/
openapi.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
openapi: 3.0.1
info:
title: PrusaLink Web
description:
This is a printer webservice.
contact:
email: [email protected]
license:
name: AGPLv3
version: 1.0.0-draft
externalDocs:
description: Find out more about API
url: http://connect.prusa3d.cz
security:
- digestAuth: []
paths:
/api/version:
get:
summary: api version informations
responses:
200:
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/Version"
401:
$ref: "#/components/responses/Unauthorized"
/api/v1/info:
get:
summary: printer informations
responses:
200:
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/Info"
401:
$ref: "#/components/responses/Unauthorized"
/api/v1/status:
get:
summary: printer, job and transfer telemetry info
description: All values except printer are optional
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
job:
$ref: "#/components/schemas/StatusJob"
printer:
$ref: "#/components/schemas/StatusPrinter"
transfer:
$ref: "#/components/schemas/StatusTransfer"
storage:
$ref: "#/components/schemas/StatusStorage"
camera:
$ref: "#/components/schemas/StatusCamera"
required:
- printer
/api/v1/job:
get:
summary: job info
description: Returns info about current job
responses:
200:
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/Job"
204:
description: No Content
401:
$ref: "#/components/responses/Unauthorized"
/api/v1/job/{id}:
parameters:
- in: path
name: id
description: job id
required: true
schema:
type: integer
example: 42
delete:
summary: stop job
description: Stop job with given id
responses:
204:
description: No Content
No Error
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
409:
$ref: "#/components/responses/Conflict"
/api/v1/job/{id}/pause:
parameters:
- in: path
name: id
description: job id
required: true
schema:
type: integer
example: 42
put:
summary: pause job
description: Pause job with given id
responses:
204:
description: No Content
No Error
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
409:
$ref: "#/components/responses/Conflict"
/api/v1/job/{id}/resume:
parameters:
- in: path
name: id
description: job id
required: true
schema:
type: integer
example: 42
put:
summary: resume job
description: Resume job with given id
responses:
204:
description: No Content
No Error
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
409:
$ref: "#/components/responses/Conflict"
/api/v1/job/{id}/continue:
parameters:
- in: path
name: id
description: job id
required: true
schema:
type: integer
example: 42
put:
summary: continue job
description: Continue in job with given id after timelapse capture
responses:
204:
description: No Content
No Error
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
409:
$ref: "#/components/responses/Conflict"
/api/v1/storage:
parameters:
- in: header
name: Accept-Language
description: Defines a language of the response
schema:
type: string
example: "cs"
get:
summary: storage info
description: Returns info about each available file storage (e.g. SD Card or local storage)
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
storage_list:
type: array
items:
$ref: "#/components/schemas/Storage"
401:
$ref: "#/components/responses/Unauthorized"
/api/v1/transfer:
get:
summary: transfer info
description: Returns info about current transfer
responses:
200:
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/Transfer"
204:
description: No Content
401:
$ref: "#/components/responses/Unauthorized"
/api/v1/transfer/{id}:
parameters:
- in: path
name: id
description: transfer id
required: true
schema:
type: integer
example: 42
delete:
summary: stop transfer
description: Stop transfer with given id
responses:
204:
description: No Content
No Error
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
409:
$ref: "#/components/responses/Conflict"
/api/v1/files/{storage}/{path}:
parameters:
- in: header
name: Accept-Language
description: Defines a language of the response
schema:
type: string
example: "cs"
- in: header
name: Accept
description: Preferred content-type of response - application/json or text/html, all other are returned as text/plain
schema:
type: string
default: text/plain
- in: path
name: storage
description: The target storage
required: true
schema:
type: string
example: "/local"
- in: path
name: path
description: Path to the file
required: true
schema:
type: string
example: "/examples/Spice_Harvester_0.3mm_PLA_MK3S_12m.gcode"
get:
summary: File or folder metadata
responses:
200:
description: OK
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/FileInfo"
- $ref: "#/components/schemas/PrintFileInfo"
- $ref: "#/components/schemas/FirmwareFileInfo"
- $ref: "#/components/schemas/FolderInfo"
401:
$ref: "#/components/responses/Unauthorized"
put:
summary: upload file or create folder
requestBody:
content:
application/octet-stream:
schema:
type: string
format: binary
parameters:
- in: header
name: Content-Length
description: Length of file to upload
schema:
type: integer
example: 101342
- in: header
name: Content-Type
description: Type of uploaded media
schema:
type: string
default: application/octet-stream
- in: header
name: Print-After-Upload
description: Whether to start printing the file after upload
schema:
type: string
description: ?0=False, ?1=True, according RFC8941/3.3.6
enum: [ "?0", "?1" ]
default: "?0"
- in: header
name: Overwrite
description: Whether to overwrite already existing files
schema:
type: string
description: ?0=False, ?1=True, according RFC8941/3.3.6
enum: ["?0", "?1"]
default: "?0"
responses:
201:
description: Created
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
409:
$ref: "#/components/responses/Conflict"
post:
summary: Start print of file if there's no print job running
description: Body is ignored
requestBody:
required: false
content: {}
responses:
204:
description: No Content
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
409:
$ref: "#/components/responses/Conflict"
head:
summary: file presence and state check
responses:
200:
description: OK
headers:
Read-Only:
description: Whether the file or storage is read-only
required: true
schema:
type: boolean
example: true
Currently-Printed:
description: Whether this file is currently being printed
required: true
schema:
type: boolean
example: true
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
409:
$ref: "#/components/responses/Conflict"
delete:
summary: Delete a file or folder
parameters:
- in: header
name: Force
description: Whether to force delete non-empty folder
schema:
type: string
description: ?0=False, ?1=True, according RFC8941/3.3.6
enum: [ "?0", "?1" ]
default: "?0"
responses:
204:
description: No Content
No Error
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
409:
# If the file to be deleted is currently being printed
$ref: "#/components/responses/Conflict"
/api/v1/cameras:
get:
summary: Get a list of active cameras and its properties
responses:
200:
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Camera"
401:
$ref: "#/components/responses/Unauthorized"
403:
$ref: "#/components/responses/Forbidden"
503:
$ref: "#/components/responses/ServiceUnavailable"
put:
summary: List of cameras in intended order
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
description: Printer ID
example: "sh42arta"
responses:
200:
description: OK
401:
$ref: "#/components/responses/Unauthorized"
403:
$ref: "#/components/responses/Forbidden"
503:
$ref: "#/components/responses/ServiceUnavailable"
/api/v1/cameras/{id}:
parameters:
- in: path
name: id
description: ID of the camera
required: true
schema:
type: string
example: "Z42D4U2NqEX"
get:
summary: Get current settings and properties of specific camera
responses:
200:
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/CameraConfig"
401:
$ref: "#/components/responses/Unauthorized"
403:
$ref: "#/components/responses/Forbidden"
404:
$ref: "#/components/responses/NotFound"
503:
$ref: "#/components/responses/ServiceUnavailable"
post:
summary: Setup a new camera or fix a broken one
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CameraConfigSet"
responses:
200:
description: OK
400:
$ref: "#/components/responses/BadRequest"
401:
$ref: "#/components/responses/Unauthorized"
403:
$ref: "#/components/responses/Forbidden"
404:
$ref: "#/components/responses/NotFound"
409:
$ref: "#/components/responses/Conflict"
503:
$ref: "#/components/responses/ServiceUnavailable"
delete:
summary: Delete a camera
responses:
200:
description: OK
401:
$ref: "#/components/responses/Unauthorized"
403:
$ref: "#/components/responses/Forbidden"
404:
$ref: "#/components/responses/NotFound"
409:
$ref: "#/components/responses/Conflict"
503:
$ref: "#/components/responses/ServiceUnavailable"
/api/v1/cameras/snap:
get:
summary: Return a captured image from the default camera
responses:
200:
description: OK
content:
image/png:
schema:
type: string
format: binary
204:
description: No Content
No Error
304:
$ref: "#/components/responses/NotModified"
401:
$ref: "#/components/responses/Unauthorized"
403:
$ref: "#/components/responses/Forbidden"
404:
$ref: "#/components/responses/NotFound"
503:
$ref: "#/components/responses/ServiceUnavailable"
/api/v1/cameras/{id}/snap:
parameters:
- in: path
name: id
description: ID of the camera
required: true
schema:
type: string
example: "Z42D4U2NqEX"
get:
summary: Return a captured image from the camera with a given id
responses:
200:
description: OK
content:
image/png:
schema:
type: string
format: binary
204:
description: No Content
No Error
304:
$ref: "#/components/responses/NotModified"
401:
$ref: "#/components/responses/Unauthorized"
403:
$ref: "#/components/responses/Forbidden"
404:
$ref: "#/components/responses/NotFound"
503:
$ref: "#/components/responses/ServiceUnavailable"
post:
summary: Make a snapshot with the camera
description: Can be manually done only during camera initialization or in
manual mode
requestBody:
content:
application/json: {}
responses:
200:
description: OK
content:
image/png:
schema:
type: string
format: binary
401:
$ref: "#/components/responses/Unauthorized"
403:
$ref: "#/components/responses/Forbidden"
404:
$ref: "#/components/responses/NotFound"
408:
$ref: "#/components/responses/RequestTimeout"
409:
$ref: "#/components/responses/Conflict"
503:
$ref: "#/components/responses/ServiceUnavailable"
/api/v1/cameras/{id}/config:
parameters:
- in: path
name: id
description: ID of the camera
required: true
schema:
type: string
example: "Z42D4U2NqEX"
patch:
summary: Set new settings to a working camera
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CameraConfigSet"
responses:
200:
description: OK
401:
$ref: "#/components/responses/Unauthorized"
403:
$ref: "#/components/responses/Forbidden"
404:
$ref: "#/components/responses/NotFound"
503:
$ref: "#/components/responses/ServiceUnavailable"
delete:
summary: Reset settings of a camera
responses:
200:
description: OK
401:
$ref: "#/components/responses/Unauthorized"
403:
$ref: "#/components/responses/Forbidden"
404:
$ref: "#/components/responses/NotFound"
503:
$ref: "#/components/responses/ServiceUnavailable"
/api/v1/cameras/{id}/connection:
parameters:
- in: path
name: id
description: ID of the camera
required: true
schema:
type: string
example: "Z42D4U2NqEX"
post:
summary: Register a camera to Connect
responses:
200:
description: OK
401:
$ref: "#/components/responses/Unauthorized"
403:
$ref: "#/components/responses/Forbidden"
404:
$ref: "#/components/responses/NotFound"
408:
$ref: "#/components/responses/RequestTimeout"
409:
$ref: "#/components/responses/Conflict"
503:
$ref: "#/components/responses/ServiceUnavailable"
delete:
summary: Un-register a camera from Connect
responses:
200:
description: OK
401:
$ref: "#/components/responses/Unauthorized"
403:
$ref: "#/components/responses/Forbidden"
404:
$ref: "#/components/responses/NotFound"
409:
$ref: "#/components/responses/Conflict"
503:
$ref: "#/components/responses/ServiceUnavailable"
/api/v1/update/{env}:
parameters:
- in: path
name: env
description: The target environment (prusalink or system) for update
required: true
schema:
type: string
enum: ["prusalink"]
get:
summary: Retrieve information about available update of given environment
responses:
200:
description: OK
headers:
Update-Available:
schema:
type: boolean
description: Whether there's a package update available
example: true
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/PrusaLinkPackage"
204:
description: No Content
headers:
Update-Available:
schema:
type: boolean
description: Whether there's a package update available
example: false
401:
$ref: "#/components/responses/Unauthorized"
409:
$ref: "#/components/responses/BadRequest"
post:
summary: Update given environment
responses:
200:
description: OK
204:
description: No Content
401:
$ref: "#/components/responses/Unauthorized"
409:
$ref: "#/components/responses/BadRequest"
components:
schemas:
Version:
type: object
properties:
api:
type: string
example: "1.0.0"
version:
type: string
example: "0.7.0"
printer:
type: string
example: "1.3.1"
text:
type: string
example: "PrusaLink 0.7.0"
firmware:
type: string
example: "3.10.1-4697"
sdk:
type: string
example: "0.7.0"
capabilities:
description: |
Additional capabilities the printer has. The object is expected to
be extended in the future with more capabilities. The absence of a
capability in the object, or the complete absence of the object
means the printer doesn't support such capability (probably doesn't
even know such capability might exist).
type: object
default: {}
properties:
upload-by-put:
description: |
The printer supports uploading GCodes by the PUT method (as
described in this document). It is capable of doing the PUT and
HEAD to /api/v1/files/{storage}/{path} and it is capable of
answering the /api/v1/storage endpoint.
In absence of this capability, client MAY opt to try the legacy
"octoprint" POST to /api/files/{storage}.
type: boolean
default: false
required:
- api
- version
- printer
- text
- firmware
Storage:
type: object
properties:
name:
type: string
description: Name of the storage, based on selected language
example: "PrusaLink gcodes"
type:
type: string
description: Storage source
enum: ["LOCAL", "SDCARD", "USB"]
path:
type: string
description: Path to storage (not display path)
example: "/local"
print_files:
type: integer
description: Size of all print files in bytes
example: 19216842
system_files:
type: integer
description: Size of all system files in bytes
example: 4242
free_space:
type: integer
description: System free space in bytes
example: 1921681142
total_space:
type: integer
description: System total space in bytes
example: 8589934592
available:
type: boolean
description: Whether the storage is available or not
example: true
read_only:
type: boolean
description: Whether the storage is read only
example: false
required:
- available
- path
- type
Camera:
type: object
properties:
camera_id:
type: string
example: "sh42arta"
config:
type: object
properties:
path:
type: string
example: "/dev/video0"
name:
type: string
example: "Camera L4D"
driver:
type: string
example: "V4L2"
resolution:
type: string
example: "1280x720"
connected:
type: boolean
description: Camera is successfully connected to PrusaLink
detected:
type: boolean
description: Camera is detected by PrusaLink, but not saved yet
stored:
type: boolean
description: Camera configuration is saved in PrusaLink
linked:
type: boolean
description: Camera is linked to PrusaConnect
CameraConfig:
type: object
description: Camera configuration
properties:
name:
type: string
description: Name of the camera
example: "MuadDib_Camera_1"
trigger_scheme:
type: string
description: When the snapshot is taken
enum: [ TEN_SEC, THIRTY_SEC, SIXTY_SEC, EACH_LAYER, FIFTH_LAYER, MANUAL ]
available_resolutions:
type: array
items:
type: object
properties:
width:
type: integer
example: 640
height:
type: integer
example: 480
resolution:
type: object
properties:
width:
type: integer
example: 640
height:
type: integer
example: 480
focus:
type: number
description: Focus of the camera (0.0 - 1.0)
example: 0.5
capabilities:
type: array
items:
type: string
enum: [TRIGGER_SCHEME, IMAGING, RESOLUTION, ROTATION, EXPOSURE, FOCUS]
CameraConfigSet:
type: object
description: Camera configuration to set
properties:
name:
type: string
description: Name of the camera
example: "MuadDib_Camera_1"
trigger_scheme:
type: string
description: When the snapshot is taken
enum: [ TEN_SEC, THIRTY_SEC, SIXTY_SEC, EACH_LAYER, FIFTH_LAYER, MANUAL ]
resolution:
type: object
properties:
width:
type: integer
example: 640
height:
type: integer
example: 640
rotation:
type: integer
description: Current rotation of the output image
example: 180
focus:
type: number
description: Focus of the camera (0.0 - 1.0)
example: 0.5
exposure:
type: number
example: 4.2
send_to_connect:
type: boolean
example: true
GenericFileInfo:
description: Basic file info object, common for all files
type: object
required:
- name
- read_only
- type
- m_timestamp
properties:
name:
type: string
description: Short Filename
example: "SPICE~1.gco"
read_only:
type: boolean
example: False
size:
type: integer
description: Available for files only, not for folders
example: 424242
type:
type: string
description: File could be print file, firmware file, other (e.g. configuration) file, or folder
enum: [ PRINT_FILE, FIRMWARE, FILE, FOLDER ]
m_timestamp:
description: Timestamp in seconds
type: integer
example: 1648042843
display_name:
type: string
description: Long Filename
example: "Spice_Harvester_0.3mm_PLA_MK3S_12m.gcode"
FileInfo:
description: Other, not specified files info
allOf:
- $ref: '#/components/schemas/GenericFileInfo'
- type: object
properties:
refs:
type: object
properties:
download:
type: string
example: "/api/files/local/file.txt/raw"
PrintFileInfoBasic:
description: Simplified print file info within the folder's children
allOf:
- $ref: '#/components/schemas/GenericFileInfo'
- type: object
properties:
refs:
$ref: "#/components/schemas/PrintFileRefs"
PrintFileRefs:
description: Reference links for file thumbnail, icon and download
type: object
properties:
download:
type: string
example: "/api/files/local/examples/Spice_Harvester_0.3mm_PLA_MK3S_42m.gcode/raw"
icon:
type: string
example: "/api/thumbnails/local/examples/Spice_Harvester_0.3mm_PLA_MK3S_42m.gcode.small.png"
thumbnail:
type: string
example: "/api/thumbnails/local/examples/Spice_Harvester_0.3mm_PLA_MK3S_42m.gcode.orig.png"
PrintFileMetadata:
type: object
description: Print file metadata parsed from G-code or SL1, all data are optional
properties:
bed_temperature:
type: integer
description: Degrees Celsius
example: 60
bed_temperature per tool:
type: array
items:
type: integer
description: Degrees Celsius