Merge pull request #514 from bbiggerr/migration-queue

[New] Region Migrations List

Author: bbiggerr

openapi.yaml

@@ -14592,6 +14592,54 @@ paths:
       - lang: CLI
         source: >
           linode-cli regions view us-east
+  /regions/{regionId}/migrations:
+    x-linode-cli-command: regions
+    parameters:
+    - name: regionId
+      in: path
+      description: ID of the Region to look up.
+      required: true
+      schema:
+        type: string
+    get:
+      servers:
+      - url: https://api.linode.com/v4beta
+      tags:
+      - Regions
+      summary: Region Migrations List
+      description: |
+        Returns the number of queued migrations for the Region. Scheduled migrations that have not been placed on the
+        queue are not included in this count.
+
+        Only the Block Storage Volumes migration queue size is returned at this time.
+
+        **Beta**: This endpoint is in beta. Please make sure to prepend all requests with
+        `/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking
+        updates in the future. This notice will be removed when this endpoint is out of
+        beta.
+      operationId: getRegionMigrations
+      x-linode-cli-action: migrations
+      responses:
+        '200':
+          description: A Region Migrations object.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  volumes:
+                    type: integer
+                    description: The size of the Block Storage Volumes migration queue for the Region.
+                    example: 42
+        default:
+          $ref: '#/components/responses/ErrorResponse'
+      x-code-samples:
+      - lang: Shell
+        source: >
+          curl https://api.linode.com/v4/regions/us-east/migrations
+      - lang: CLI
+        source: >
+          linode-cli regions migrations us-east
   /support/tickets:
     x-linode-cli-command: tickets
     get: