You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/firecracker/swagger/firecracker.yaml
+49-82Lines changed: 49 additions & 82 deletions
Original file line number
Diff line number
Diff line change
@@ -85,12 +85,12 @@ paths:
85
85
Will fail if update is not possible.
86
86
operationId: putBalloon
87
87
parameters:
88
-
- name: body
89
-
in: body
90
-
description: Balloon properties
91
-
required: true
92
-
schema:
93
-
$ref: "#/definitions/Balloon"
88
+
- name: body
89
+
in: body
90
+
description: Balloon properties
91
+
required: true
92
+
schema:
93
+
$ref: "#/definitions/Balloon"
94
94
responses:
95
95
204:
96
96
description: Balloon device created/updated
@@ -109,12 +109,12 @@ paths:
109
109
Will fail if update is not possible.
110
110
operationId: patchBalloon
111
111
parameters:
112
-
- name: body
113
-
in: body
114
-
description: Balloon properties
115
-
required: true
116
-
schema:
117
-
$ref: "#/definitions/BalloonUpdate"
112
+
- name: body
113
+
in: body
114
+
description: Balloon properties
115
+
required: true
116
+
schema:
117
+
$ref: "#/definitions/BalloonUpdate"
118
118
responses:
119
119
204:
120
120
description: Balloon device updated
@@ -151,12 +151,12 @@ paths:
151
151
Will fail if update is not possible.
152
152
operationId: patchBalloonStatsInterval
153
153
parameters:
154
-
- name: body
155
-
in: body
156
-
description: Balloon properties
157
-
required: true
158
-
schema:
159
-
$ref: "#/definitions/BalloonStatsUpdate"
154
+
- name: body
155
+
in: body
156
+
description: Balloon properties
157
+
required: true
158
+
schema:
159
+
$ref: "#/definitions/BalloonStatsUpdate"
160
160
responses:
161
161
204:
162
162
description: Balloon statistics interval updated
@@ -220,7 +220,6 @@ paths:
220
220
schema:
221
221
$ref: "#/definitions/Error"
222
222
223
-
224
223
/drives/{drive_id}:
225
224
put:
226
225
summary: Creates or updates a drive. Pre-boot only.
@@ -488,8 +487,7 @@ paths:
488
487
/entropy:
489
488
put:
490
489
summary: Creates an entropy device. Pre-boot only.
491
-
description:
492
-
Enables an entropy device that provides high-quality random data to the guest.
490
+
description: Enables an entropy device that provides high-quality random data to the guest.
493
491
operationId: putEntropyDevice
494
492
parameters:
495
493
- name: body
@@ -506,12 +504,10 @@ paths:
506
504
schema:
507
505
$ref: "#/definitions/Error"
508
506
509
-
510
507
/network-interfaces/{iface_id}:
511
508
put:
512
509
summary: Creates a network interface. Pre-boot only.
513
-
description:
514
-
Creates new network interface with ID specified by iface_id path parameter.
510
+
description: Creates new network interface with ID specified by iface_id path parameter.
515
511
operationId: putGuestNetworkInterfaceByID
516
512
parameters:
517
513
- name: iface_id
@@ -538,8 +534,7 @@ paths:
538
534
$ref: "#/definitions/Error"
539
535
patch:
540
536
summary: Updates the rate limiters applied to a network interface. Post-boot only.
541
-
description:
542
-
Updates the rate limiters applied to a network interface.
537
+
description: Updates the rate limiters applied to a network interface.
543
538
operationId: patchGuestNetworkInterfaceByID
544
539
parameters:
545
540
- name: iface_id
@@ -594,8 +589,7 @@ paths:
594
589
/snapshot/load:
595
590
put:
596
591
summary: Loads a snapshot. Pre-boot only.
597
-
description:
598
-
Loads the microVM state from a snapshot.
592
+
description: Loads the microVM state from a snapshot.
599
593
Only accepted on a fresh Firecracker process (before configuring
600
594
any resource other than the Logger and Metrics).
601
595
operationId: loadSnapshot
@@ -635,8 +629,7 @@ paths:
635
629
/vm:
636
630
patch:
637
631
summary: Updates the microVM state.
638
-
description:
639
-
Sets the desired state (Paused or Resumed) for the microVM.
632
+
description: Sets the desired state (Paused or Resumed) for the microVM.
640
633
operationId: patchVm
641
634
parameters:
642
635
- name: body
@@ -707,8 +700,7 @@ definitions:
707
700
required:
708
701
- amount_mib
709
702
- deflate_on_oom
710
-
description:
711
-
Balloon device descriptor.
703
+
description: Balloon device descriptor.
712
704
properties:
713
705
amount_mib:
714
706
type: integer
@@ -724,17 +716,15 @@ definitions:
724
716
type: object
725
717
required:
726
718
- amount_mib
727
-
description:
728
-
Balloon device descriptor.
719
+
description: Balloon device descriptor.
729
720
properties:
730
721
amount_mib:
731
722
type: integer
732
723
description: Target balloon size in MiB.
733
724
734
725
BalloonStats:
735
726
type: object
736
-
description:
737
-
Describes the balloon device statistics.
727
+
description: Describes the balloon device statistics.
738
728
required:
739
729
- target_pages
740
730
- actual_pages
@@ -798,8 +788,7 @@ definitions:
798
788
type: object
799
789
required:
800
790
- stats_polling_interval_s
801
-
description:
802
-
Update the statistics polling interval, with the first statistics update scheduled immediately. Statistics cannot be turned on/off after boot.
791
+
description: Update the statistics polling interval, with the first statistics update scheduled immediately. Statistics cannot be turned on/off after boot.
803
792
properties:
804
793
stats_polling_interval_s:
805
794
type: integer
@@ -809,8 +798,7 @@ definitions:
809
798
type: object
810
799
required:
811
800
- kernel_image_path
812
-
description:
813
-
Boot source descriptor.
801
+
description: Boot source descriptor.
814
802
properties:
815
803
boot_args:
816
804
type: string
@@ -879,21 +867,18 @@ definitions:
879
867
type: boolean
880
868
cache_type:
881
869
type: string
882
-
description:
883
-
Represents the caching strategy for the block device.
870
+
description: Represents the caching strategy for the block device.
884
871
enum: ["Unsafe", "Writeback"]
885
872
default: "Unsafe"
886
873
887
874
# VirtioBlock specific parameters
888
875
is_read_only:
889
876
type: boolean
890
-
description:
891
-
Is block read only.
877
+
description: Is block read only.
892
878
This field is required for virtio-block config and should be omitted for vhost-user-block configuration.
893
879
path_on_host:
894
880
type: string
895
-
description:
896
-
Host level path for the guest drive.
881
+
description: Host level path for the guest drive.
897
882
This field is required for virtio-block config and should be omitted for vhost-user-block configuration.
898
883
rate_limiter:
899
884
$ref: "#/definitions/RateLimiter"
@@ -909,8 +894,7 @@ definitions:
909
894
# VhostUserBlock specific parameters
910
895
socket:
911
896
type: string
912
-
description:
913
-
Path to the socket of vhost-user-block backend.
897
+
description: Path to the socket of vhost-user-block backend.
914
898
This field is required for vhost-user-block config should be omitted for virtio-block configuration.
915
899
916
900
Error:
@@ -955,8 +939,7 @@ definitions:
955
939
956
940
InstanceActionInfo:
957
941
type: object
958
-
description:
959
-
Variant wrapper containing the real action.
942
+
description: Variant wrapper containing the real action.
0 commit comments