Formatting changes to api/swagger/firecracker-beta.yaml
@@ -88,7 +88,7 @@ paths:
/boot-source:
put:
summary: Creates new boot source. If boot source already exists,
- updates its state based on new input. May fail if update is not possible.
+ updates its state based on new input. Will fail if update is not possible.
The only supported boot source is LocalImage.
operationId: putGuestBootSource
parameters:
@@ -114,8 +114,9 @@ paths:
/drives/{drive_id}:
put:
- summary: Creates new drive with ID specified by drive_id path parameter. If a drive with the specified ID
- already exists, updates its state based on new input. May fail if update is not possible.
+ summary: Creates new drive with ID specified by drive_id path parameter.
+ If a drive with the specified ID already exists, updates its state based on new input.
+ Will fail if update is not possible.
operationId: putGuestDriveByID
parameters:
- name: drive_id
@@ -184,7 +185,7 @@ paths:
put:
summary: Updates the Virtual Machine Configuration with the specified input.
The Machine Configuration has default values for the vCPU count (=1) and the memory size (=256 MiB).
- May fail if update is not possible.
+ Will fail if update is not possible.
operationId: putMachineConfiguration
parameters:
- name: body
@@ -210,7 +211,7 @@ paths:
put:
summary: Creates new network interface with ID specified by iface_id path parameter.
If network interface with specified ID already exists,
- updates its state based on new input. May fail if update is not possible.
+ updates its state based on new input. Will fail if update is not possible.
operationId: putGuestNetworkInterfaceByID
parameters:
- name: iface_id
@@ -321,9 +322,8 @@ definitions:
InstanceInfo:
properties:
state:
- description: |
- The current detailed state of the Firecracker instance. This value is
- read-only by the control-plane.
+ description: The current detailed state of the Firecracker instance.
+ This value is read-only for the control-plane.
type: string
enum:
- Uninitialized
@@ -362,9 +362,8 @@ definitions:
MachineConfiguration:
type: object
- description:
- Machine Configuration descriptor by which you can specify the number of vCPU of one machine with vcpu_count
- and the memory size in MiB with mem_size_mib
+ description: Machine Configuration descriptor by which you can specify the number of vCPU
+ of one machine with vcpu_count and the memory size in MiB with mem_size_mib.
properties:
vcpu_count:
type: integer
