firecracker-v0.1.yaml: updated

Update Swagger definition in firecracker-v0.1.yaml to include the
description of newly added GET /actions/{action_id} functionality.

Signed-off-by: Alexandru Agache <[email protected]>

Author: alexandruag

api/swagger/firecracker-v0.1.yaml

@@ -27,9 +27,9 @@ produces:
 paths:
   /boot-source:
     put:
-      summary: "Creates new boot source. If boot source already exists,
+      summary: Creates new boot source. If boot source already exists,
                 updates its state based on new input. May fail if update is not possible.
-                The only supported boot source is LocalImage."
+                The only supported boot source is LocalImage.
       operationId: "putGuestBootSource"
       parameters:
       - name: "body"
@@ -46,16 +46,16 @@ paths:
         400:
           description: Boot source cannot be created due to bad input.
           schema:
-            $ref: '#/definitions/Error'
+            $ref: "#/definitions/Error"
         default:
           description: Internal server error.
           schema:
-            $ref: '#/definitions/Error'
+            $ref: "#/definitions/Error"
 
   /machine-config:
     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."
+      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.
       operationId: "putMachineConfiguration"
       parameters:
       - name: "body"
@@ -71,13 +71,39 @@ paths:
         400:
           description: Machine Configuration cannot be updated due to bad input.
           schema:
-            $ref: '#/definitions/Error'
+            $ref: "#/definitions/Error"
         default:
           description: Internal server error.
           schema:
-            $ref: '#/definitions/Error'
+            $ref: "#/definitions/Error"
 
   /actions/{action_id}:
+    get:
+      summary: Return detailed information about an action.
+      operationId: describeInstanceAction
+      parameters:
+      - name: action_id
+        in: path
+        description: The action identifier.
+        required: true
+        type: string
+      responses:
+        200:
+          description: The instance action information.
+          schema:
+            $ref: "#/definitions/InstanceActionInfo"
+        404:
+          description: Action not found.
+          schema:
+            $ref: "#/definitions/Error"
+        409:
+          description: Action is still pending.
+          schema:
+            $ref: "#/definitions/Error"
+        default:
+          description: Unexpected error.
+          schema:
+            $ref: "#/definitions/Error"
     put:
       summary: Create an instance action.
       operationId: createInstanceAction
@@ -91,19 +117,19 @@ paths:
         in: body
         required: true
         schema:
-          $ref: '#/definitions/InstanceActionInfo'
+          $ref: "#/definitions/InstanceActionInfo"
       responses:
         201:
           description: No previous action existed so a new one was created.
         default:
           description: Unexpected error.
           schema:
-            $ref: '#/definitions/Error'
+            $ref: "#/definitions/Error"
 
   /drives/{drive_id}:
     put:
-      summary: "Creates new drive with ID specified by 'drive_id' path parameter. If drive with 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 drive with specified ID
+                already exists, updates its state based on new input. May fail if update is not possible.
       operationId: "putGuestDriveByID"
       parameters:
       - name: "drive_id"
@@ -125,17 +151,17 @@ paths:
         400:
           description: Drive cannot be created due to bad input.
           schema:
-            $ref: '#/definitions/Error'
+            $ref: "#/definitions/Error"
         default:
           description: Internal server error.
           schema:
-            $ref: '#/definitions/Error'
+            $ref: "#/definitions/Error"
 
   /network-interfaces/{iface_id}:
     put:
-      summary: "Creates new network interface with ID specified by 'iface_id' path parameter.
+      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. May fail if update is not possible.
       operationId: "putGuestNetworkInterfaceByID"
       parameters:
       - name: "iface_id"
@@ -157,16 +183,16 @@ paths:
         400:
           description: Network interface cannot be created due to bad input.
           schema:
-            $ref: '#/definitions/Error'
+            $ref: "#/definitions/Error"
         default:
           description: Internal server error.
           schema:
-            $ref: '#/definitions/Error'
+            $ref: "#/definitions/Error"
 
   /vsocks/{vsock_id}:
     put:
-      summary: "Creates new vsock with ID specified by 'vsock_id' path parameter. If vsock with specified ID
-                already exists, updates its state based on new input. May fail if update is not possible."
+      summary: Creates new vsock with ID specified by "vsock_id" path parameter. If vsock with specified ID
+                already exists, updates its state based on new input. May fail if update is not possible.
       operationId: "putGuestVsockByID"
       parameters:
       - name: "vsock_id"
@@ -188,11 +214,11 @@ paths:
         400:
           description: Vsock cannot be created due to bad input.
           schema:
-            $ref: '#/definitions/Error'
+            $ref: "#/definitions/Error"
         default:
           description: Internal server error.
           schema:
-            $ref: '#/definitions/Error'
+            $ref: "#/definitions/Error"
 
 
 definitions:
@@ -211,16 +237,16 @@ definitions:
         enum:
         - "LocalImage"
       local_image:
-        $ref: '#/definitions/LocalImage'
+        $ref: "#/definitions/LocalImage"
       boot_args:
         type: string
         description: "kernel boot arguments"
 
   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'.
+      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
@@ -285,7 +311,7 @@ definitions:
       is_root_device:
         type: boolean
       state:
-        $ref: '#/definitions/DeviceState'
+        $ref: "#/definitions/DeviceState"
 
   NetworkInterface:
     type: object
@@ -300,7 +326,7 @@ definitions:
         type: string
         description: "host level path for the guest network interface"
       state:
-        $ref: '#/definitions/DeviceState'
+        $ref: "#/definitions/DeviceState"
 
   Vsock:
     type: object
@@ -313,10 +339,11 @@ definitions:
         type: integer
         description: "Guest Vsock CID (should be an u32 value)"
       state:
-        $ref: '#/definitions/DeviceState'
+        $ref: "#/definitions/DeviceState"
 
   Error:
     properties:
       faultMessage:
         type: string
         description: A description of the error condition.
+