From 50c6ef20b2440b2585d119c02a224ff1656cf143 Mon Sep 17 00:00:00 2001
From: Steven Kaufer <kaufer@us.ibm.com>
Date: Mon, 2 Mar 2015 21:17:59 +0000
Subject: [PATCH] Sort query string param for GET volumes

Cinder supports passing a comma-separated list of sort keys and
optional directions on the v2 GET volumes and GET volumes/detail
queries. The details of the syntax are described in the sorting
section at:

http://specs.openstack.org/openstack/api-wg/guidelines/pagination_filter_sort.html

Change-Id: I63a86f8508422de5d28b5a2970547e37c46e318c
---
 api-ref/src/wadls/volume-api/src/v2/common.ent       | 12 ++++++++++++
 .../src/wadls/volume-api/src/v2/volume-api-v2.wadl   |  8 ++++++++
 2 files changed, 20 insertions(+)

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 b13f36938..ffb9f8908 100644
--- a/api-ref/src/wadls/volume-api/src/v2/common.ent
+++ b/api-ref/src/wadls/volume-api/src/v2/common.ent
@@ -513,6 +513,18 @@
                         xml:lang="EN">
                         <para>Number of VCPUs.</para></wadl:doc>
                 </param>'>
+<!ENTITY volumeListQueryParameters '
+                <param xmlns="http://wadl.dev.java.net/2009/02"
+                    name="sort" style="query" required="false"
+                    type="xsd:string">
+                    <wadl:doc xmlns="http://docbook.org/ns/docbook"
+                            xmlns:wadl="http://wadl.dev.java.net/2009/02"
+                            xml:lang="EN">
+                        <para>Comma-separated list of sort keys and optional sort
+                            directions in the form of &lt;key&gt;[:&lt;direction&gt;].
+                            Valid directions are <code>asc</code> (ascending) or
+                            <code>desc</code> (descending).</para></wadl:doc>
+                </param>'>
 <!ENTITY quotaSetsReqParameters '
 <param name="quota_set" 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 35fdcba64..48bbd565f 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
@@ -449,6 +449,10 @@
                 Block Storage volumes that the tenant who submits the
                 request can access.</para>
         </wadl:doc>
+        <request>
+            <representation mediaType="application/xml">
+                &volumeListQueryParameters; </representation>
+        </request>
         <response status="200">
             <representation mediaType="application/xml">
                 <wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -475,6 +479,10 @@
                 Block Storage volumes that the tenant who submits the
                 request can access.</para>
         </wadl:doc>
+        <request>
+            <representation mediaType="application/xml">
+                &volumeListQueryParameters; </representation>
+        </request>
         <response status="200">
             <representation mediaType="application/xml">
                 <wadl:doc xmlns="http://docbook.org/ns/docbook"