Merge "api-ref: parameter verification for server-migrations"

api-ref/source/parameters.yaml

@@ -181,6 +181,12 @@ keypair_name_path:
   in: path
   required: true
   type: string
+migration_id_path:
+  description: |
+    The ID of the server migration.
+  in: path
+  required: true
+  type: integer
 network_id:
   description: |
     The UUID of the network.
@@ -2011,6 +2017,13 @@ force_live_migrate:
   required: false
   type: boolean
   min_version: 2.30
+force_migration_complete:
+  description: |
+    The action.
+  in: body
+  required: true
+  type: string
+  min_version: 2.22
 force_snapshot:
   description: |
     Indicates whether to create a snapshot, even if the volume is attached.
@@ -2941,6 +2954,96 @@ migrate:
   in: body
   required: true
   type: string
+migrate_dest_compute:
+  description: |
+    The target compute for a migration.
+  in: body
+  required: true
+  type: string
+migrate_dest_host:
+  description: |
+    The target host for a migration.
+  in: body
+  required: true
+  type: string
+migrate_dest_node:
+  description: |
+    The target node for a migration.
+  in: body
+  required: true
+  type: string
+migrate_disk_processed_bytes:
+  description: |
+    The amount of disk, in bytes, that has been processed during the migration.
+  in: body
+  required: true
+  type: integer
+migrate_disk_remaining_bytes:
+  description: |
+    The amount of disk, in bytes, that still needs to be migrated.
+  in: body
+  required: true
+  type: integer
+migrate_disk_total_bytes:
+  description: |
+    The total amount of disk, in bytes, that needs to be migrated.
+  in: body
+  required: true
+  type: integer
+migrate_memory_processed_bytes:
+  description: |
+    The amount of memory, in bytes, that has been processed during the migration.
+  in: body
+  required: true
+  type: integer
+migrate_memory_remaining_bytes:
+  description: |
+    The amount of memory, in bytes, that still needs to be migrated.
+  in: body
+  required: true
+  type: integer
+migrate_memory_total_bytes:
+  description: |
+    The total amount of memory, in bytes, that needs to be migrated.
+  in: body
+  required: true
+  type: integer
+migrate_source_compute:
+  description: |
+    The source compute for a migration.
+  in: body
+  required: true
+  type: string
+migrate_source_node:
+  description: |
+    The source node for a migration.
+  in: body
+  required: true
+  type: string
+migrate_status:
+  description: |
+    The current status of the migration.
+  in: body
+  required: true
+  type: string
+migration:
+  description: |
+    The server migration object.
+  in: body
+  required: true
+  type: object
+migration_id:
+  description: |
+    The ID of the server migration.
+  in: body
+  required: true
+  type: integer
+migrations:
+  description: |
+    The list of server migration objects.
+  in: body
+  required: true
+  type: array
 minDisk_body:
   description: |
     The minimum amount of disk space an image requires to boot, in GiB. For example, ``100``.

api-ref/source/server-migrations.inc

@@ -1,5 +1,4 @@
 .. -*- rst -*-
-.. needs:parameter_verification
 .. needs:example_verification
 .. needs:body_verification
 
@@ -14,17 +13,109 @@ List Migrations
 
 .. rest_method:: GET /servers/{server_id}/migrations
 
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+  - server_id: server_id_path
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+  - migrations: migrations
+  - created_at: created
+  - dest_compute: migrate_dest_compute
+  - dest_host: migrate_dest_host
+  - dest_node: migrate_dest_node
+  - disk_processed_bytes: migrate_disk_processed_bytes
+  - disk_remaining_bytes: migrate_disk_remaining_bytes
+  - disk_total_bytes: migrate_disk_total_bytes
+  - id: migration_id
+  - memory_processed_bytes: migrate_memory_processed_bytes
+  - memory_remaining_bytes: migrate_memory_remaining_bytes
+  - memory_total_bytes: migrate_memory_total_bytes
+  - server_uuid: server_id
+  - source_compute: migrate_source_compute
+  - source_node: migrate_source_node
+  - status: migrate_status
+  - updated_at: updated
+
+**Example List Migrations**
+
 Show Migration Details
 ======================
 
 .. rest_method:: GET /servers/{server_id}/migrations/{migration_id}
 
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+  - server_id: server_id_path
+  - migration_id: migration_id_path
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+  - migration: migration
+  - created_at: created
+  - dest_compute: migrate_dest_compute
+  - dest_host: migrate_dest_host
+  - dest_node: migrate_dest_node
+  - disk_processed_bytes: migrate_disk_processed_bytes
+  - disk_remaining_bytes: migrate_disk_remaining_bytes
+  - disk_total_bytes: migrate_disk_total_bytes
+  - id: migration_id
+  - memory_processed_bytes: migrate_memory_processed_bytes
+  - memory_remaining_bytes: migrate_memory_remaining_bytes
+  - memory_total_bytes: migrate_memory_total_bytes
+  - server_uuid: server_id
+  - source_compute: migrate_source_compute
+  - source_node: migrate_source_node
+  - status: migrate_status
+  - updated_at: updated
+
+**Example Show Migration Details**
+
 Force Migration Complete Action (force_complete Action)
 =======================================================
 
 .. rest_method:: POST /servers/{server_id}/migrations/{migration_id}/action
 
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+  - server_id: server_id_path
+  - migration_id: migration_id_path
+  - force_complete: force_migration_complete
+
+Response
+--------
+
+There is no body content for the response of a successful POST operation.
+
 Delete (Abort) Migration
 ========================
 
 .. rest_method:: DELETE /servers/{server_id}/migrations/{migration_id}
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+  - server_id: server_id_path
+  - migration_id: migration_id_path
+
+Response
+--------
+
+There is no body content for the response of a successful DELETE operation.