openstack/cinder
Code Issues Proposed changes

api-ref: add preconditions for volume transfer APIs

Browse Source 
This adds the simple pre-conditions for the volume transfer
API (in its various forms) to the API reference. This came
up during discussions about nova server instance ownership
transfer and questioning whether or not in-use volumes could
be transferred and finding the API did not mention that case
at all.

Change-Id: I0bd42dd6a0e291979fb37bcab3823dfde369e7a9
This commit is contained in:
Matt Riedemann 2018-09-11 17:41:07 -04:00
parent 7eb4e1d0a8
commit 8f13d2e428
3 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api-ref/source/v2/os-vol-transfer-v2.inc
View File

@ -61,6 +61,12 @@ Create volume transfer
Creates a volume transfer.
**Preconditions**
* The volume ``status`` must be ``available``
* Transferring encrypted volumes is not supported
* If the volume has snapshots, those snapshots must be ``available``
Response codes
--------------

6
api-ref/source/v3/os-vol-transfer-v3.inc
View File

@ -61,6 +61,12 @@ Create a volume transfer
Creates a volume transfer.
**Preconditions**
* The volume ``status`` must be ``available``
* Transferring encrypted volumes is not supported
* If the volume has snapshots, those snapshots must be ``available``
Response codes
--------------

7
api-ref/source/v3/vol-transfer-v3.inc
View File

@ -66,6 +66,13 @@ Create a volume transfer
Creates a volume transfer.
**Preconditions**
* The volume ``status`` must be ``available``
* Transferring encrypted volumes is not supported
* If the volume has snapshots, those snapshots must be ``available`` unless
``no_snapshots=True``
Response codes
--------------