From dc0f396a05ef0b4cb7e717d024e0df99626c25f3 Mon Sep 17 00:00:00 2001
From: Diane Fleming <diflemin@cisco.com>
Date: Sun, 29 Nov 2015 16:33:59 -0600
Subject: [PATCH] Add information about optional "id" attribute for create
 image

Change-Id: I39c68f5b261cefa16e5c733579785bb0cc90e4f5
Closes-Bug: #1520542
---
 .../wadls/image-api/src/v2/os-image-v2.wadl   | 41 ++++++++++++-------
 .../src/v2/samples/image-create-req.json      | 13 ++----
 .../src/v2/samples/image-create-response.json | 29 ++++++-------
 3 files changed, 43 insertions(+), 40 deletions(-)

diff --git a/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl b/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl
index 613b6f54e..ec30b379b 100644
--- a/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl
+++ b/api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl
@@ -161,21 +161,21 @@
             on tags or anything defined as a <code>link</code> in the json-
             schema, such as self, file, or schema.
          </para>
-         <para>You can use the <code>size_min</code> and
-            <code>size_max</code> query parameters to perform
-            greater-than and less-than filtering of images based
-            on their <code>size</code> attribute. The size is
-            measured in bytes and refers to the size of an image
-            when it is stored on disk.
+         <para>
+            You can use the <code>size_min</code> and <code>size_max</code>
+            query parameters to perform greater-than and less-than filtering
+            of images based on their <code>size</code> attribute. The size is
+            measured in bytes and refers to the size of an image when it is
+            stored on disk.
          </para>
-         <para>For example, sending a <code>size_min</code> filter
-            of 1048576 and <code>size_max</code> of 4194304
-            filters the container to include only images that are
-            between 1 and 4 MB.
+         <para>
+            For example, sending a <code>size_min</code> filter of 1048576 and
+            <code>size_max</code> of 4194304 filters the container to include
+            only images that are between 1 and 4 MB.
          </para>
-         <para>You can see a list of VM images which status is in
-            <code>active</code>, <code>queued</code>, or
-            <code>saving</code>.
+         <para>
+            You can list VM images that have a status of <code>active</code>,
+            <code>queued</code>, or <code>saving</code>.
          </para>
          <para>
             You can use query parameters to sort the results of this operation.
@@ -292,7 +292,20 @@
                xmlns:wadl="http://wadl.dev.java.net/2009/02"
                xml:lang="EN">
                <para>
-                  The image ID.
+                  A unique, user-defined image UUID, in the format:
+               </para>
+<programlisting>nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn</programlisting>
+               <para>
+                  Where <emphasis>n</emphasis> is a hexadecimal digit from 0
+                  to f (or F).
+               </para>
+               <para>
+                  For example:
+               </para>
+               <programlisting>b2173dd3-7ad6-4362-baa6-a68bce3565cb</programlisting>
+               <para>
+                  If you omit this value, the API generates a UUID for the new
+                  image.
                </para>
             </wadl:doc>
             </param>
diff --git a/api-ref/src/wadls/image-api/src/v2/samples/image-create-req.json b/api-ref/src/wadls/image-api/src/v2/samples/image-create-req.json
index 0875af5a5..bcb480b68 100644
--- a/api-ref/src/wadls/image-api/src/v2/samples/image-create-req.json
+++ b/api-ref/src/wadls/image-api/src/v2/samples/image-create-req.json
@@ -1,13 +1,6 @@
 {
-    "name": "Ubuntu 12.10",
-    "tags": [
-        "ubuntu",
-        "quantal"
-    ],
     "container_format": "bare",
-    "disk_format": "qcow2",
-    "visibility": "private",
-    "min_disk": 0,
-    "protected": false,
-    "min_ram": 0
+    "disk_format": "raw",
+    "name": "Ubuntu",
+    "id": "b2173dd3-7ad6-4362-baa6-a68bce3565cb"
 }
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 2b362d3bb..868f7f044 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
@@ -1,24 +1,21 @@
 {
     "status": "queued",
-    "name": "Ubuntu 12.10",
-    "tags": [
-        "ubuntu",
-        "quantal"
-    ],
+    "name": "Ubuntu",
+    "tags": [],
     "container_format": "bare",
-    "created_at": "2014-11-11T20:47:55Z",
-    "disk_format": "qcow2",
-    "updated_at": "2014-11-11T20:47:55Z",
+    "created_at": "2015-11-29T22:21:42Z",
+    "size": null,
+    "disk_format": "raw",
+    "updated_at": "2015-11-29T22:21:42Z",
     "visibility": "private",
-    "self": "/v2/images/b2173dd3-7ad6-4362-baa6-a68bce3565ca",
+    "self": "/v2/images/b2173dd3-7ad6-4362-baa6-a68bce3565cb",
     "min_disk": 0,
     "protected": false,
-    "id": "b2173dd3-7ad6-4362-baa6-a68bce3565ca",
-    "file": "/v2/images/b2173dd3-7ad6-4362-baa6-a68bce3565ca/file",
-    "owner": "b4eedccc6fb74fa8a7ad6b08382b852b",
-    "min_ram": 0,
-    "schema": "/v2/schemas/image",
-    "size": null,
+    "id": "b2173dd3-7ad6-4362-baa6-a68bce3565cb",
+    "file": "/v2/images/b2173dd3-7ad6-4362-baa6-a68bce3565cb/file",
     "checksum": null,
-    "virtual_size": null
+    "owner": "bab7d5c60cd041a0a36f7c4b6e1dd978",
+    "virtual_size": null,
+    "min_ram": 0,
+    "schema": "/v2/schemas/image"
 }