feat: updated swagger file with new block device fields

Updated swagger for `drive` api with new descriptions
and fields for vhost-user-block.

Signed-off-by: Egor Lazarchuk <[email protected]>

Author: ShadowCurse

src/api_server/swagger/firecracker.yaml

@@ -858,41 +858,54 @@ definitions:
     type: object
     required:
       - drive_id
-      - is_read_only
       - is_root_device
-      - path_on_host
     properties:
       drive_id:
         type: string
+      partuuid:
+        type: string
+        description:
+          Represents the unique id of the boot partition of this device. It is
+          optional and it will be taken into account only if the is_root_device
+          field is true.
+      is_root_device:
+        type: boolean
       cache_type:
         type: string
         description:
           Represents the caching strategy for the block device.
         enum: ["Unsafe", "Writeback"]
         default: "Unsafe"
+
+      # VirtioBlock specific parameters
       is_read_only:
         type: boolean
-      is_root_device:
-        type: boolean
-      partuuid:
-        type: string
         description:
-          Represents the unique id of the boot partition of this device. It is
-          optional and it will be taken into account only if the is_root_device
-          field is true.
+          Is block read only. 
+          This field is required for virtio-block config and should be omitted for vhost-user-block configuration.
       path_on_host:
         type: string
-        description: Host level path for the guest drive
+        description:
+          Host level path for the guest drive.
+          This field is required for virtio-block config and should be omitted for vhost-user-block configuration.
       rate_limiter:
         $ref: "#/definitions/RateLimiter"
       io_engine:
         type: string
         description:
           Type of the IO engine used by the device. "Async" is supported on
           host kernels newer than 5.10.51.
+          This field is optional for virtio-block config and should be omitted for vhost-user-block configuration.
         enum: ["Sync", "Async"]
         default: "Sync"
 
+      # VhostUserBlock specific parameters
+      socket:
+        type: string
+        description:
+          Path to the socket of vhost-user-block backend.
+          This field is required for vhost-user-block config should be omitted for virtio-block configuration.
+
   Error:
     type: object
     properties:
@@ -1151,6 +1164,7 @@ definitions:
     description:
       Defines an IO rate limiter with independent bytes/s and ops/s limits.
       Limits are defined by configuring each of the _bandwidth_ and _ops_ token buckets.
+      This field is optional for virtio-block config and should be omitted for vhost-user-block configuration.
     properties:
       bandwidth:
         $ref: "#/definitions/TokenBucket"