From 5553f4f219d381d6bf420dd6cfc3a2bbc7bfcf38 Mon Sep 17 00:00:00 2001
From: wangxiyuan <wangxiyuan@huawei.com>
Date: Wed, 27 Jan 2016 14:56:24 +0800
Subject: [PATCH] Fix some error in Cinder v2

This patch fixed some error in Cinder v2:
1. There are more than one "created_at" in volume request.
2. The links's name is "metadata" which is wrong.
3. The request for "Create Volume" should include "scheduler_hints".
4. The volume update request is wrong and is missing in pdf.
5. When create a snapshot, the volume_id is required and size can't
be changed.

Closes-bug: #1517065
Change-Id: Iaae6a9cf717f8f989eb7ce9def1d6eee56eb5c3a
---
 api-ref/src/wadls/volume-api/src/common.ent   | 51 +++++++++++++++++--
 .../volume-api/src/v2/wadl/volumes-v2.wadl    | 24 ++-------
 2 files changed, 51 insertions(+), 24 deletions(-)

diff --git a/api-ref/src/wadls/volume-api/src/common.ent b/api-ref/src/wadls/volume-api/src/common.ent
index ccd29709d..b14016d9d 100644
--- a/api-ref/src/wadls/volume-api/src/common.ent
+++ b/api-ref/src/wadls/volume-api/src/common.ent
@@ -2375,9 +2375,55 @@
       The UUID of the consistency group.
     </para>
   </wadl:doc>
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02"
+  name="scheduler_hints" style="plain" type="xsd:dict"
+  required="false">
+  <wadl:doc xmlns="http://docbook.org/ns/docbook"
+    xmlns:wadl="http://wadl.dev.java.net/2009/02"
+    xml:lang="EN">
+    <para>
+      The dictionary of data to send to the scheduler.
+    </para>
+  </wadl:doc>
+</param>'>
+<!ENTITY updateVolumeRequestParameters '
+<param xmlns="http://wadl.dev.java.net/2009/02"
+  name="name" style="plain"
+  type="xsd:string" required="false">
+  <wadl:doc xmlns="http://docbook.org/ns/docbook"
+    xmlns:wadl="http://wadl.dev.java.net/2009/02"
+    xml:lang="EN">
+    <para>
+      The volume name.
+    </para>
+  </wadl:doc>
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02"
+  name="description" style="plain"
+  type="xsd:string" required="false">
+  <wadl:doc xmlns="http://docbook.org/ns/docbook"
+    xmlns:wadl="http://wadl.dev.java.net/2009/02"
+    xml:lang="EN">
+    <para>
+      The volume description.
+    </para>
+  </wadl:doc>
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02"
+  name="metadata" style="plain" type="xsd:dict"
+  required="false">
+  <wadl:doc xmlns="http://docbook.org/ns/docbook"
+    xmlns:wadl="http://wadl.dev.java.net/2009/02"
+    xml:lang="EN">
+    <para>
+      One or more metadata key and value pairs that are associated with the
+      volume.
+    </para>
+  </wadl:doc>
 </param>'>
 <!-- **************************************** -->
-<!-- VOLUME REQUEST PARAMETERS                -->
+<!-- VOLUME RESPONSE PARAMETERS               -->
 <!-- **************************************** -->
 <!ENTITY createVolumeResponseParameters '
 <param xmlns="http://wadl.dev.java.net/2009/02"
@@ -2538,8 +2584,7 @@
     </para>
   </wadl:doc>
 </param>
-&created_at-ResponseParameter;
-<param xmlns="http://wadl.dev.java.net/2009/02" name="metadata" style="plain" type="dict"
+<param xmlns="http://wadl.dev.java.net/2009/02" name="links" style="plain" type="dict"
   required="true">
   <wadl:doc xmlns="http://docbook.org/ns/docbook"
     xmlns:wadl="http://wadl.dev.java.net/2009/02"
diff --git a/api-ref/src/wadls/volume-api/src/v2/wadl/volumes-v2.wadl b/api-ref/src/wadls/volume-api/src/v2/wadl/volumes-v2.wadl
index a0e46a597..7093fe509 100644
--- a/api-ref/src/wadls/volume-api/src/v2/wadl/volumes-v2.wadl
+++ b/api-ref/src/wadls/volume-api/src/v2/wadl/volumes-v2.wadl
@@ -416,6 +416,8 @@
                     <xsdxt:code
                         href="../samples/volumes/volume-update-request.xml"/>
                 </wadl:doc>
+                &volumeObjectParameter;
+                &updateVolumeRequestParameters;
             </representation>
             <representation mediaType="application/json"
                 json:ref="http://docs.openstack.org/api/openstack-block-storage/v2/volumes#put/volume">
@@ -425,8 +427,6 @@
                         href="../samples/volumes/volume-update-request.json"
                     />
                 </wadl:doc>
-                &volumeObjectParameter;
-                &createVolumeRequestParameters;
             </representation>
         </request>
         <response status="200">
@@ -1188,17 +1188,8 @@
                         </para>
                     </wadl:doc>
                 </param>
-                <param name="new_size" style="plain"
-                    type="xsd:int" required="false">
-                    <wadl:doc xmlns="http://docbook.org/ns/docbook"
-                        xml:lang="EN">
-                        <para>
-                            The size for the volume, in gibibytes (GiB).
-                        </para>
-                    </wadl:doc>
-                </param>
                 <param name="volume_id" style="plain" type="csapi:UUID"
-                    required="false">
+                    required="true">
                     <wadl:doc xmlns="http://docbook.org/ns/docbook"
                         xml:lang="EN">
                         <para>
@@ -1430,15 +1421,6 @@
                         </para>
                     </wadl:doc>
                 </param>
-                <param name="new_size" style="plain"
-                    type="xsd:int" required="false">
-                    <wadl:doc xmlns="http://docbook.org/ns/docbook"
-                        xml:lang="EN">
-                        <para>
-                            The size for the volume, in gibibytes (GiB).
-                        </para>
-                    </wadl:doc>
-                </param>
             </representation>
         </request>
         <response status="200">