From 267a357b1c579703b20d909c23b162859ce16c35 Mon Sep 17 00:00:00 2001
From: Atsushi SAKAI <sakaia@jp.fujitsu.com>
Date: Fri, 2 Oct 2015 13:44:47 +0900
Subject: [PATCH] Add volume unmanage to cinder v2 API

  Volume manage is already documented.
  But little bit far from volume manage,
  since operation method is different.

  This patch just adds volume unmange.

(df) added code sample for os-unmanage

Partial-Bug: #1411724
Change-Id: I0e88244d389eb0e929d17ccf0f68b7a44dbf4982
---
 api-ref/src/docbkx/ch_blockstorage-api-v2.xml |  1 +
 .../manage_existing_request.json              |  2 +-
 .../manage_existing_response.json             |  2 +-
 .../os-unmanage/os-unmanage-request.json      |  3 ++
 .../src/wadls/volume-api/src/v2/common.ent    | 11 +++++++
 .../volume-api/src/v2/volume-api-v2.wadl      | 31 +++++++++++++++++++
 6 files changed, 48 insertions(+), 2 deletions(-)
 create mode 100644 api-ref/src/wadls/volume-api/src/v2/api_samples/os-unmanage/os-unmanage-request.json

diff --git a/api-ref/src/docbkx/ch_blockstorage-api-v2.xml b/api-ref/src/docbkx/ch_blockstorage-api-v2.xml
index ce6f2b657..99e5a5cb3 100644
--- a/api-ref/src/docbkx/ch_blockstorage-api-v2.xml
+++ b/api-ref/src/docbkx/ch_blockstorage-api-v2.xml
@@ -169,6 +169,7 @@
                 <wadl:method href="#setVolumeimagemetadata"/>
                 <wadl:method href="#unsetVolumeimagemetadata"/>
                 <wadl:method href="#attachVolume"/>
+                <wadl:method href="#unmanageVolume"/>
             </wadl:resource>
         </wadl:resources>
     </section>
diff --git a/api-ref/src/wadls/volume-api/src/v2/api_samples/os-manage-existing/manage_existing_request.json b/api-ref/src/wadls/volume-api/src/v2/api_samples/os-manage-existing/manage_existing_request.json
index 0cdc88cd0..39f60e87a 100644
--- a/api-ref/src/wadls/volume-api/src/v2/api_samples/os-manage-existing/manage_existing_request.json
+++ b/api-ref/src/wadls/volume-api/src/v2/api_samples/os-manage-existing/manage_existing_request.json
@@ -15,4 +15,4 @@
             "key2": "value2"
         }
     }
-}
\ No newline at end of file
+}
diff --git a/api-ref/src/wadls/volume-api/src/v2/api_samples/os-manage-existing/manage_existing_response.json b/api-ref/src/wadls/volume-api/src/v2/api_samples/os-manage-existing/manage_existing_response.json
index e696d15f1..343ca66bc 100644
--- a/api-ref/src/wadls/volume-api/src/v2/api_samples/os-manage-existing/manage_existing_response.json
+++ b/api-ref/src/wadls/volume-api/src/v2/api_samples/os-manage-existing/manage_existing_response.json
@@ -30,4 +30,4 @@
         "id": "23cf872b-c781-4cd4-847d-5f2ec8cbd91c",
         "size": 0
     }
-}
\ No newline at end of file
+}
diff --git a/api-ref/src/wadls/volume-api/src/v2/api_samples/os-unmanage/os-unmanage-request.json b/api-ref/src/wadls/volume-api/src/v2/api_samples/os-unmanage/os-unmanage-request.json
new file mode 100644
index 000000000..a75950bb9
--- /dev/null
+++ b/api-ref/src/wadls/volume-api/src/v2/api_samples/os-unmanage/os-unmanage-request.json
@@ -0,0 +1,3 @@
+{
+    "os-unmanage": {}
+}
diff --git a/api-ref/src/wadls/volume-api/src/v2/common.ent b/api-ref/src/wadls/volume-api/src/v2/common.ent
index 1ffdd2c04..d7501a19c 100644
--- a/api-ref/src/wadls/volume-api/src/v2/common.ent
+++ b/api-ref/src/wadls/volume-api/src/v2/common.ent
@@ -733,6 +733,17 @@
         </para>
     </wadl:doc>
 </param>'>
+<!ENTITY unmanageVolumeReqParameters '
+<param xmlns="http://wadl.dev.java.net/2009/02" name="os-unmanage" style="plain"
+    type="xsd:string" required="true">
+    <wadl:doc xmlns="http://docbook.org/ns/docbook"
+       xmlns:wadl="http://wadl.dev.java.net/2009/02"
+       xml:lang="EN">
+        <para>
+            The <code>os-unmanage</code> action.
+        </para>
+    </wadl:doc>
+</param>'>
 <!ENTITY backendParametersResponse '
 <param name="namespace" style="plain" required="true"
    xmlns="http://wadl.dev.java.net/2009/02"
diff --git a/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl b/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl
index 0c7d00423..5a5a30acb 100644
--- a/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl
+++ b/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl
@@ -68,6 +68,7 @@
                             <method href="#setVolumeimagemetadata"/>
                             <method href="#unsetVolumeimagemetadata"/>
                             <method href="#attachVolume"/>
+                            <method href="#unmanageVolume"/>
                         </resource>
                     </resource>
                 </resource>
@@ -644,6 +645,36 @@
         </request>
         <response status="202"/>
     </method>
+    <method name="POST" id="unmanageVolume">
+        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
+            title="Unmanage volume">
+            <para role="shortdesc">
+                Unmanages the specified volume.
+                Specify the <code>os-unmanage</code> action in the request body.
+            </para>
+            <para>
+                This calls removes the volume from Block Storage management
+                without actually removing the back-end storage object
+                associated with it.
+            </para>
+            <para>Preconditions</para>
+            <itemizedlist>
+                <listitem><para>Volume status must be <code>available</code>.</para></listitem>
+            </itemizedlist>
+        </wadl:doc>
+        <request>
+            <representation mediaType="application/json">
+                <wadl:doc xmlns="http://docbook.org/ns/docbook"
+                    xml:lang="EN">
+                    <xsdxt:code
+                        href="api_samples/os-unmanage/os-unmanage-request.json"
+                    />
+                </wadl:doc>
+                &unmanageVolumeReqParameters;
+            </representation>
+        </request>
+        <response status="202"/>
+    </method>
     <method name="GET" id="getVolumeTypes">
         <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
             title="List volume types">