summaryrefslogtreecommitdiff
path: root/api-ref/source/parameters.yaml
diff options
context:
space:
mode:
authorzhangbailin <zhangbailin@inspur.com>2019-11-12 20:00:54 +0800
committerDan Smith <dansmith@redhat.com>2020-04-02 09:26:55 -0700
commit733d4133df8d0e13c48f45416658ec71ffff5f04 (patch)
tree639c6f02f9beddfe9ffb0a27db22e0b6d864c105 /api-ref/source/parameters.yaml
parentacc0dc31c3793b6783345c9abea644bbe8ec56e3 (diff)
downloadnova-733d4133df8d0e13c48f45416658ec71ffff5f04.tar.gz
Allow PUT volume attachments API to modify delete_on_termination
Allow PUT /servers/{server_id}/os-volume_attachments/{volume_id}`` to support specifying ``delete_on_termination`` field in the request body. This allows updating the attached volume's flag that controls whether or not it is automatically deleted when the instance is deleted. When we request 'volumeId' and 'delete_on_termination' in the requst body to swap volume, since the new microversion it will be support updating the swapping volume's delete flag. Co-Authored-By: Dan Smith <dansmith@redhat.com> Blueprint: destroy-instance-with-datavolume Change-Id: I6ccac4e17f56b40e67c79d40f32558ef414685ea
Diffstat (limited to 'api-ref/source/parameters.yaml')
-rw-r--r--api-ref/source/parameters.yaml39
1 files changed, 38 insertions, 1 deletions
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 4dff3fcf2b..263835d848 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -1776,12 +1776,26 @@ associate_host:
in: body
required: true
type: string
+attachment_device_put_req:
+ description: |
+ Name of the device in the attachment object, such as, ``/dev/vdb``.
+ in: body
+ required: false
+ type: string
+ min_version: 2.85
attachment_device_resp:
description: |
Name of the device in the attachment object, such as, ``/dev/vdb``.
in: body
required: false
type: string
+attachment_id_put_req:
+ description: |
+ The UUID of the attachment.
+ in: body
+ required: false
+ type: string
+ min_version: 2.85
attachment_id_required:
description: |
The UUID of the attachment.
@@ -1794,6 +1808,13 @@ attachment_id_resp:
in: body
required: false
type: string
+attachment_server_id_put_req:
+ description: |
+ The UUID of the server.
+ in: body
+ required: false
+ type: string
+ min_version: 2.85
attachment_server_id_resp:
description: |
The UUID of the server.
@@ -2294,6 +2315,14 @@ delete_on_termination_attachments_resp:
required: true
type: boolean
min_version: 2.79
+delete_on_termination_put_req:
+ description: |
+ A flag indicating if the attached volume will be deleted when the server is
+ deleted.
+ in: body
+ required: false
+ type: boolean
+ min_version: 2.85
deleted:
description: |
A boolean indicates whether this aggregate is deleted or not, if it has
@@ -2384,6 +2413,13 @@ device_tag_bdm_attachment:
required: false
type: string
min_version: 2.49
+device_tag_bdm_attachment_put_req:
+ description: |
+ The device tag applied to the volume block device or ``null``.
+ in: body
+ required: true
+ type: string
+ min_version: 2.85
device_tag_bdm_attachment_resp:
description: |
The device tag applied to the volume block device or ``null``.
@@ -7370,7 +7406,8 @@ volumeAttachment_post:
volumeAttachment_put:
description: |
A dictionary representation of a volume attachment containing the field
- ``volumeId`` which is the UUID of the replacement volume.
+ ``volumeId`` which is the UUID of the replacement volume, and other fields
+ to update in the attachment.
in: body
required: true
type: object