From 486258732df8121d82e410c9680aceacb712653e Mon Sep 17 00:00:00 2001
From: wangxiyuan <wangxiyuan@huawei.com>
Date: Thu, 17 Dec 2015 15:21:36 +0800
Subject: [PATCH] Fix some description of image-create in Glance v2

This patch fixed some description error in Glance v2:

1. V2 doesn't support create an image with location header.
2. Name is optional when create an image.
3. Whether return direct_url depends on the show_image_direct_url
option in the config file.
4. Glance return 'locations', not 'url'.

Closes-bug: #1527423

Change-Id: Icbd08ed305e989966cf2c23a601bc2553b27d6f0
---
 api-ref/src/wadls/image-api/src/v2/common.ent | 30 ++++++++++++-------
 .../src/v2/samples/image-create-response.json |  1 +
 .../image-api/src/v2/wadl/images-v2.wadl      |  9 +-----
 3 files changed, 21 insertions(+), 19 deletions(-)

diff --git a/api-ref/src/wadls/image-api/src/v2/common.ent b/api-ref/src/wadls/image-api/src/v2/common.ent
index 2efb13b99..157e3cbf1 100644
--- a/api-ref/src/wadls/image-api/src/v2/common.ent
+++ b/api-ref/src/wadls/image-api/src/v2/common.ent
@@ -293,7 +293,9 @@
    style="plain" required="true" type="csapi:UUID">
 <wadl:doc xmlns="http://docbook.org/ns/docbook"
    xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
-   <para>The UUID of the image.</para>
+   <para>
+      The UUID of the image.
+   </para>
 </wadl:doc>
 </param>'>
 <!ENTITY min_ramParameter '
@@ -301,9 +303,12 @@
    style="plain" required="true" type="csapi:UUID">
 <wadl:doc xmlns="http://docbook.org/ns/docbook"
    xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
-   <para>The minimum amount of RAM in MB that is required to boot the image.</para>
    <para>
-      If this field has no value, its value is <code>null</code> (JSON null data type).
+      The minimum amount of RAM in MB that is required to boot the image.
+   </para>
+   <para>
+      If this field has no value, its value is <code>null</code> (JSON null
+      data type).
    </para>
 </wadl:doc>
 </param>'>
@@ -557,15 +562,15 @@
 </param>'>
 <!ENTITY location_urlParameter '
 <param xmlns="http://wadl.dev.java.net/2009/02"
-   name="url" style="plain" type="xsd:string"
+   name="locations" style="plain" type="xsd:list"
    required="true">
 <wadl:doc xmlns="http://docbook.org/ns/docbook"
    xmlns:wadl="http://wadl.dev.java.net/2009/02"
    xml:lang="EN">
-   <para>URL to access the image file kept in external store. It
-      appears when you set the <code>show_multiple_locations</code> option
-      to <code>True</code> in the Image service&apos;s configuration
-      file.
+   <para>
+      A list of URLs to access the image file in external store. This list
+      appears if the <code>show_multiple_locations</code> option is set to
+      <code>True</code> in the Image service&apos;s configuration file.
    </para>
 </wadl:doc>
 </param>'>
@@ -577,7 +582,7 @@
    xmlns:wadl="http://wadl.dev.java.net/2009/02"
    xml:lang="EN">
    <para>URL to access the image file kept in external store. It
-      appears when you set the <code>show_multiple_locations</code> option
+      appears when you set the <code>show_image_direct_url</code> option
       to <code>True</code> in the Image service&apos;s configuration
       file.
    </para>
@@ -747,7 +752,9 @@
 <wadl:doc xmlns="http://docbook.org/ns/docbook"
    xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
    title="Namespace">
-   <para>Unique namespace.</para>
+   <para>
+      The UUID of the namespace.
+   </para>
 </wadl:doc>
 </param>' >
 <!ENTITY metadefNamespaceParameter '
@@ -1258,7 +1265,8 @@
    style="plain" required="true" type="csapi:UUID" default="ALL">
 <wadl:doc xmlns="http://docbook.org/ns/docbook"
    xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
-   <para>The UUID of the task.
+   <para>
+      The UUID of the task.
    </para>
 </wadl:doc>
 </param>'>
diff --git a/api-ref/src/wadls/image-api/src/v2/samples/image-create-response.json b/api-ref/src/wadls/image-api/src/v2/samples/image-create-response.json
index 868f7f044..dd2289ee2 100644
--- a/api-ref/src/wadls/image-api/src/v2/samples/image-create-response.json
+++ b/api-ref/src/wadls/image-api/src/v2/samples/image-create-response.json
@@ -8,6 +8,7 @@
     "disk_format": "raw",
     "updated_at": "2015-11-29T22:21:42Z",
     "visibility": "private",
+    "locations": [],
     "self": "/v2/images/b2173dd3-7ad6-4362-baa6-a68bce3565cb",
     "min_disk": 0,
     "protected": false,
diff --git a/api-ref/src/wadls/image-api/src/v2/wadl/images-v2.wadl b/api-ref/src/wadls/image-api/src/v2/wadl/images-v2.wadl
index 7cd0f2bca..e486c3227 100644
--- a/api-ref/src/wadls/image-api/src/v2/wadl/images-v2.wadl
+++ b/api-ref/src/wadls/image-api/src/v2/wadl/images-v2.wadl
@@ -236,13 +236,6 @@
                   calls.
                </para>
             </listitem>
-            <listitem>
-               <para>
-                  If you create the image with the <code>Location</code>
-                  header and you have correct permissions, you can use API
-                  calls to see the image status as <code>active</code>.
-               </para>
-            </listitem>
          </itemizedlist>
       </wadl:doc>
       <request>
@@ -254,7 +247,7 @@
             </wadl:doc>
             <param xmlns="http://wadl.dev.java.net/2009/02"
                name="name" style="plain" type="xsd:string"
-               required="true">
+               required="false">
             <wadl:doc xmlns="http://docbook.org/ns/docbook"
                xmlns:wadl="http://wadl.dev.java.net/2009/02"
                xml:lang="EN">