From 8f13d2e42807332d766058e059462d2efa5a4829 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Tue, 11 Sep 2018 17:41:07 -0400 Subject: [PATCH] api-ref: add preconditions for volume transfer APIs 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 --- api-ref/source/v2/os-vol-transfer-v2.inc | 6 ++++++ api-ref/source/v3/os-vol-transfer-v3.inc | 6 ++++++ api-ref/source/v3/vol-transfer-v3.inc | 7 +++++++ 3 files changed, 19 insertions(+) diff --git a/api-ref/source/v2/os-vol-transfer-v2.inc b/api-ref/source/v2/os-vol-transfer-v2.inc index e02e558cdd0..58d2bafa024 100644 --- a/api-ref/source/v2/os-vol-transfer-v2.inc +++ b/api-ref/source/v2/os-vol-transfer-v2.inc @@ -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 -------------- diff --git a/api-ref/source/v3/os-vol-transfer-v3.inc b/api-ref/source/v3/os-vol-transfer-v3.inc index 2b17f5d5ce0..3fd8e2089b3 100644 --- a/api-ref/source/v3/os-vol-transfer-v3.inc +++ b/api-ref/source/v3/os-vol-transfer-v3.inc @@ -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 -------------- diff --git a/api-ref/source/v3/vol-transfer-v3.inc b/api-ref/source/v3/vol-transfer-v3.inc index 7eb532efb71..716a5dbe52a 100644 --- a/api-ref/source/v3/vol-transfer-v3.inc +++ b/api-ref/source/v3/vol-transfer-v3.inc @@ -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 --------------