diff --git a/api-ref/source/v3/index.rst b/api-ref/source/v3/index.rst index 641f2411a72..68437db9ce7 100644 --- a/api-ref/source/v3/index.rst +++ b/api-ref/source/v3/index.rst @@ -27,6 +27,7 @@ Block Storage API V3 (CURRENT) .. include:: volumes-v3-snapshots-actions.inc .. include:: snapshot-manage.inc .. include:: os-vol-transfer-v3.inc +.. include:: vol-transfer-v3.inc .. Now the other random things in alphabetical order. .. include:: attachments.inc diff --git a/api-ref/source/v3/vol-transfer-v3.inc b/api-ref/source/v3/vol-transfer-v3.inc index db3ccb4237a..7eb532efb71 100644 --- a/api-ref/source/v3/vol-transfer-v3.inc +++ b/api-ref/source/v3/vol-transfer-v3.inc @@ -1,16 +1,16 @@ .. -*- rst -*- -Volume transfer -=============== +Volume transfer (3.55 or later) +=============================== Transfers a volume from one user to another user. -This is the new transfer APIs with microversion 3.53. +This is the new transfer APIs with microversion 3.55. Accept a volume transfer ~~~~~~~~~~~~~~~~~~~~~~~~ -.. rest_method:: POST /v3/{project_id}/volume_transfers/{transfer_id}/accept +.. rest_method:: POST /v3/{project_id}/volume-transfers/{transfer_id}/accept Accepts a volume transfer. @@ -24,9 +24,6 @@ Response codes .. rest_status_code:: error ../status.yaml - 400 - -.. rest_status_code:: error ../status.yaml - - 413 Request @@ -65,7 +62,7 @@ Response Example Create a volume transfer ~~~~~~~~~~~~~~~~~~~~~~~~ -.. rest_method:: POST /v3/{project_id}/volume_transfers +.. rest_method:: POST /v3/{project_id}/volume-transfers Creates a volume transfer. @@ -121,7 +118,7 @@ Response Example List volume transfers for a project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. rest_method:: GET /v3/{project_id}/volume_transfers +.. rest_method:: GET /v3/{project_id}/volume-transfers Lists volume transfers. @@ -163,7 +160,7 @@ Response Example Show volume transfer detail ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. rest_method:: GET /v3/{project_id}/volume_transfers/{transfer_id} +.. rest_method:: GET /v3/{project_id}/volume-transfers/{transfer_id} Shows details for a volume transfer. @@ -206,7 +203,7 @@ Response Example Delete a volume transfer ~~~~~~~~~~~~~~~~~~~~~~~~ -.. rest_method:: DELETE /v3/{project_id}/volume_transfers/{transfer_id} +.. rest_method:: DELETE /v3/{project_id}/volume-transfers/{transfer_id} Deletes a volume transfer. @@ -230,7 +227,7 @@ Request List volume transfers and details ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. rest_method:: GET /v3/{project_id}/volume_transfers/detail +.. rest_method:: GET /v3/{project_id}/volume-transfers/detail Lists volume transfers, with details. diff --git a/doc/source/cli/cli-manage-volumes.rst b/doc/source/cli/cli-manage-volumes.rst index b512dc82212..a751b819cb8 100644 --- a/doc/source/cli/cli-manage-volumes.rst +++ b/doc/source/cli/cli-manage-volumes.rst @@ -449,13 +449,15 @@ donor, or original owner, creates a transfer request and sends the created transfer ID and authorization key to the volume recipient. The volume recipient, or new owner, accepts the transfer by using the ID and key. -In Rocky, Cinder changes the API behavior for V2 and 3.x < 3.55, snapshots will -be transferred with volume by default. That means if the volume has some -snapshots, when a user transfers a volume from one owner to another, then those -snapshots will be transferred with the volume as well. After microversion 3.55, -Cinder supports the ability to transfer volume without snapshots. If users -don't want to transfer snapshots, they need to specify the new optional -argument `--no_snapshots`. +Starting with the Rocky release, Cinder changes the API behavior for the v2 and +v3 API up to microversion 3.55. Snapshots will be transferred with the volume +by default. That means if the volume has some snapshots, when a user transfers +a volume from one owner to another, then those snapshots will be transferred +with the volume as well. + +Starting with microversion 3.55 and later, Cinder supports the ability to +transfer volume without snapshots. If users don't want to transfer snapshots, +they need to specify the new optional argument `--no-snapshots`. .. note::