From ce40b9cb71104e9e0fbbe3723883fdeb8a552b33 Mon Sep 17 00:00:00 2001
From: Ha Van Tu <tuhv@vn.fujitsu.com>
Date: Mon, 29 Feb 2016 09:44:35 +0700
Subject: [PATCH] Missing Response Parameters table of "GET /v2.0/tenants"

This patch adds Response Parameter tables to the api-site documentation as
below:
 + tenants: One or more tenants objects.
 + id: the tenant ID.
 + name: the tenant name.
 + description: Description about the tenant.
 + enabled: Indicates whether the tenant is enabled or disabled.
 + tenants_links: Links of the tenants.

Change-Id: I007b5ff9813fc73390c5d75288ac62f621c7e7a3
Co-Authored-by: Cao Xuan Hoang <hoangcx@vn.fujitsu.com>
Closes-Bug: #1549215
---
 .../wadls/identity-api/src/v2.0/common.ent    | 69 +++++++++++++++++--
 .../identity-api/src/v2.0/wadl/identity.wadl  |  1 +
 2 files changed, 66 insertions(+), 4 deletions(-)

diff --git a/api-ref/src/wadls/identity-api/src/v2.0/common.ent b/api-ref/src/wadls/identity-api/src/v2.0/common.ent
index 80051147e..cd881f357 100644
--- a/api-ref/src/wadls/identity-api/src/v2.0/common.ent
+++ b/api-ref/src/wadls/identity-api/src/v2.0/common.ent
@@ -142,7 +142,7 @@
     <wadl:doc xmlns="http://docbook.org/ns/docbook"
         xmlns:wadl="http://wadl.dev.java.net/2009/02"
         xml:lang="EN">
-        <para>                
+        <para>
             The user name. Required if you include the
             <code>passwordCredentials</code> object. If you do not provide a
             password credentials, you must provide a token.
@@ -178,7 +178,7 @@
 </param>'>
 <!ENTITY tenantIdRequestParameter '
 <param xmlns="http://wadl.dev.java.net/2009/02" name="tenantId" style="plain"
-    required="false" type="capi:UUID">
+    required="false" type="csapi:UUID">
     <wadl:doc xmlns="http://docbook.org/ns/docbook"
         xmlns:wadl="http://wadl.dev.java.net/2009/02"
         xml:lang="EN">
@@ -190,13 +190,74 @@
         </para>
     </wadl:doc>
 </param>'>
+<!ENTITY tenantsResponseParameter '
+<param xmlns="http://wadl.dev.java.net/2009/02" name="tenants" style="plain"
+    required="true" type="xsd:list">
+    <wadl:doc xmlns="http://docbook.org/ns/docbook"
+        xmlns:wadl="http://wadl.dev.java.net/2009/02"
+        xml:lang="EN">
+        <para>
+            One or more tenant Objects.
+        </para>
+    </wadl:doc>
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02" name="id" 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 tenant ID.
+        </para>
+    </wadl:doc>
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="plain"
+    required="true" type="xsd:string">
+    <wadl:doc xmlns="http://docbook.org/ns/docbook"
+        xmlns:wadl="http://wadl.dev.java.net/2009/02"
+        xml:lang="EN">
+        <para>
+            The tenant name.
+        </para>
+    </wadl:doc>
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02" name="description" style="plain"
+    required="true" type="xsd:string">
+    <wadl:doc xmlns="http://docbook.org/ns/docbook"
+        xmlns:wadl="http://wadl.dev.java.net/2009/02"
+        xml:lang="EN">
+        <para>
+            Description about the tenant.
+        </para>
+    </wadl:doc>
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02" name="enabled" style="plain"
+    required="true" type="xsd:boolean">
+    <wadl:doc xmlns="http://docbook.org/ns/docbook"
+        xmlns:wadl="http://wadl.dev.java.net/2009/02"
+        xml:lang="EN">
+        <para>
+            Indicates whether the tenant is enabled or disabled.
+        </para>
+    </wadl:doc>
+</param>
+<param xmlns="http://wadl.dev.java.net/2009/02" name="tenants_links"
+    style="plain" required="true" type="xsd:list">
+    <wadl:doc xmlns="http://docbook.org/ns/docbook"
+        xmlns:wadl="http://wadl.dev.java.net/2009/02"
+        xml:lang="EN">
+        <para>
+            Links of the tenants.
+        </para>
+    </wadl:doc>
+</param>'>
 <!ENTITY tokenIdTemplateParameter '
 <param xmlns="http://wadl.dev.java.net/2009/02" name="tokenId" style="template"
     type="capi:UUID" required="true">
     <wadl:doc xmlns="http://docbook.org/ns/docbook"
         xmlns:wadl="http://wadl.dev.java.net/2009/02"
         xml:lang="EN">
-        <para>                   
+        <para>
             The authentication token for which to perform the operation.
         </para>
     </wadl:doc>
@@ -221,7 +282,7 @@
     <wadl:doc xmlns="http://docbook.org/ns/docbook"
         xmlns:wadl="http://wadl.dev.java.net/2009/02"
         xml:lang="EN">
-        <para>                       
+        <para>
             A <code>token</code> object. Required if you do not
             provide password credentials.
         </para>
diff --git a/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity.wadl b/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity.wadl
index 2ac41a6ca..549024fa5 100644
--- a/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity.wadl
+++ b/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity.wadl
@@ -506,6 +506,7 @@
                         <xsdxt:code href="../samples/admin/tenants-list-response.json"/>
                     </xsdxt:sample>
                 </wadl:doc>
+            &tenantsResponseParameter;
             </representation>
         </response>
         <response status="203"/>