From 598cb71012cee325d4256494d51311ae98b2a9bf Mon Sep 17 00:00:00 2001
From: Diane Fleming <diflemin@cisco.com>
Date: Fri, 13 Nov 2015 09:08:24 -0600
Subject: [PATCH] Add workaround for show user details by name

Change-Id: Id100de2b0689004ef7d8f79dc067e0bce403e868
Closes-Bug: #1515402
---
 api-ref/src/docbkx/ch_identity-admin-v2.xml   |  8 +--
 .../src/v2.0/wadl/identity-admin.wadl         | 56 +++++++++++++------
 .../identity-api/src/v2.0/wadl/identity.wadl  |  5 +-
 .../src/v3/wadl/OS-INHERIT-v3.wadl            |  2 +-
 .../identity-api/src/v3/wadl/OS-KDS-v3.wadl   |  4 +-
 .../src/v3/wadl/OS-OAUTH1-v3.wadl             |  2 +-
 .../src/v3/wadl/identity-admin-v3.wadl        |  7 ++-
 7 files changed, 53 insertions(+), 31 deletions(-)

diff --git a/api-ref/src/docbkx/ch_identity-admin-v2.xml b/api-ref/src/docbkx/ch_identity-admin-v2.xml
index 026a010b9..b065cc539 100644
--- a/api-ref/src/docbkx/ch_identity-admin-v2.xml
+++ b/api-ref/src/docbkx/ch_identity-admin-v2.xml
@@ -49,11 +49,9 @@
                 <wadl:method href="#admin-listUsers"/>
             </wadl:resource>
             <wadl:resource href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#admin-userId">
-                    <wadl:method href="#admin-updateUser"/>
-                    <wadl:method href="#admin-deleteUser"/>
-            </wadl:resource>
-            <wadl:resource href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#admin-userid">
-                <wadl:method href="#admin-getUserById"/>
+                <wadl:method href="#admin-updateUser"/>
+                <wadl:method href="#admin-deleteUser"/>
+                <wadl:method href="#admin-showUser"/>
             </wadl:resource>
             <wadl:resource href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#admin-userRoles">
                 <wadl:method href="#admin-listUserGlobalRoles"/>
diff --git a/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl b/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl
index 9d237f3af..8a6e7d0ed 100644
--- a/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl
+++ b/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl
@@ -19,7 +19,8 @@
     xmlns:xsd="http://www.w3.org/2001/XMLSchema"
     xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
     xmlns:wadl="http://wadl.dev.java.net/2009/02"
-    xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:db="http://docbook.org/ns/docbook">
+    xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:db="http://docbook.org/ns/docbook">
     <grammars>
         <include href="../xsd/api.xsd"/>
         <include href="../xsd/api-common.xsd"/>
@@ -196,17 +197,7 @@
                     </param>
                     <method href="#admin-updateUser"/>
                     <method href="#admin-deleteUser"/>
-                </resource>
-                <resource id="admin-userid" path="{user_id}">
-                    <param xmlns="http://wadl.dev.java.net/2009/02" name="user_id" style="template"
-                        type="xsd:string" required="true">
-                        <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
-                            <para>
-                                The user ID.
-                            </para>
-                        </wadl:doc>
-                    </param>
-                    <method href="#admin-getUserById"/>
+                    <method href="#admin-showUser"/>
                     <resource id="admin-userRoles" path="roles">
                         <method href="#admin-listUserGlobalRoles"/>
                     </resource>
@@ -991,12 +982,43 @@
                     <xsdxt:code href="../samples/user.json"/>
                 </wadl:doc>
             </representation>
-        </response>&commonFaults; &getFaults; </method>
-    <method name="GET" id="admin-getUserById">
+        </response>&commonFaults; &getFaults;
+    </method>
+    <method name="GET" id="admin-showUser">
         <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
-            title="Get user information by ID">
-            <para role="shortdesc">Gets detailed information about a user by user
-                ID.</para>
+            title="Show user details">
+            <para role="shortdesc">
+                Shows details for a user by ID.
+            </para>
+            <para>
+                The <link
+                xlink:href="http://docs.openstack.org/cli-reference/content/openstackclient_commands.html#openstackclient_subcommand_user_show_with_identity_api_v2">openstack
+                user show</link> command supports showing user details by name or ID. However, the
+                command actually looks up the user ID for a user name and queries the user by ID.
+            </para>
+            <para>
+                As a workaround, complete these steps to show details for a
+                user by name:
+            </para>
+            <orderedlist>
+                <listitem>
+                    <para>
+                        <link xlink:href="#admin-listUsers">List all users</link>.
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>
+                        In the response, find the user name for which you want
+                        to show details and note its corresponding user ID.
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>
+                        Issue the <link xlink:href="#admin-showUser">show
+                        details for user</link> call.
+                    </para>
+                </listitem>
+            </orderedlist>
         </wadl:doc>
         <response status="200">
             <representation mediaType="application/json" element="identity:user">
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 edbecdc38..389cb398c 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
@@ -20,7 +20,8 @@
     xmlns:xsd="http://www.w3.org/2001/XMLSchema"
     xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
     xmlns:wadl="http://wadl.dev.java.net/2009/02"
-    xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:db="http://docbook.org/ns/docbook">
+    xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:db="http://docbook.org/ns/docbook">
     <grammars>
         <include href="../xsd/api.xsd"/>
         <include href="../xsd/api-common.xsd"/>
@@ -28,7 +29,7 @@
     <!--*******************************************************-->
     <!--             All Resources                             -->
     <!--*******************************************************-->
-    <resources base="http://localhost:5000" xml:id="identity-v2.0">
+    <resources base="http://localhost:35357" xml:id="identity-v2.0">
         <resource id="versions" path="//">
             <method href="#getVersions-v2"/>
         </resource>
diff --git a/api-ref/src/wadls/identity-api/src/v3/wadl/OS-INHERIT-v3.wadl b/api-ref/src/wadls/identity-api/src/v3/wadl/OS-INHERIT-v3.wadl
index ed50ac169..04304a908 100644
--- a/api-ref/src/wadls/identity-api/src/v3/wadl/OS-INHERIT-v3.wadl
+++ b/api-ref/src/wadls/identity-api/src/v3/wadl/OS-INHERIT-v3.wadl
@@ -35,7 +35,7 @@
     <!--             All Resources                             -->
     <!--*******************************************************-->
     <!-- We should use SSL in production -->
-    <resources base="http://localhost:35357" xml:id="OS-INHERIT-v3">
+    <resources base="http://localhost:5000" xml:id="OS-INHERIT-v3">
         <!-- FYI: double slash needed in path to get a single slash to display -->
         <resource id="v3" path="//v3">
             <resource id="role_assignments" path="role_assignments">
diff --git a/api-ref/src/wadls/identity-api/src/v3/wadl/OS-KDS-v3.wadl b/api-ref/src/wadls/identity-api/src/v3/wadl/OS-KDS-v3.wadl
index 43a7e83ec..4e85dcedd 100644
--- a/api-ref/src/wadls/identity-api/src/v3/wadl/OS-KDS-v3.wadl
+++ b/api-ref/src/wadls/identity-api/src/v3/wadl/OS-KDS-v3.wadl
@@ -34,8 +34,8 @@
     <!--*******************************************************-->
     <!--             All Resources                             -->
     <!--*******************************************************-->
-    <!-- We should use SSL in production                       -->
-    <resources base="http://localhost:35357" xml:id="OS-KDS-v3">
+    <!-- We should use SSL in production -->
+    <resources base="http://localhost:5000" xml:id="OS-KDS-v3">
         <!-- FYI: double slash needed in path to get a single slash to display -->
         <resource id="v1" path="//v1">
             <resource id="keys" path="keys">
diff --git a/api-ref/src/wadls/identity-api/src/v3/wadl/OS-OAUTH1-v3.wadl b/api-ref/src/wadls/identity-api/src/v3/wadl/OS-OAUTH1-v3.wadl
index 5bd02e41a..38a551cbc 100644
--- a/api-ref/src/wadls/identity-api/src/v3/wadl/OS-OAUTH1-v3.wadl
+++ b/api-ref/src/wadls/identity-api/src/v3/wadl/OS-OAUTH1-v3.wadl
@@ -35,7 +35,7 @@
     <!--             All Resources                             -->
     <!--*******************************************************-->
     <!-- We should use SSL in production -->
-    <resources base="http://localhost:35357" xml:id="OS-OAUTH1-v3">
+    <resources base="http://localhost:5000" xml:id="OS-OAUTH1-v3">
         <!-- FYI: double slash needed in path to get a single slash to display -->
         <resource id="v3" path="//v3">
             <resource id="oauth1" path="OS-OAUTH1">
diff --git a/api-ref/src/wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl b/api-ref/src/wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl
index 9a28ffe60..cc246b0f6 100644
--- a/api-ref/src/wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl
+++ b/api-ref/src/wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl
@@ -33,9 +33,10 @@
     </grammars>
     <!-- ***************************************************** -->
     <!--             All Resources                             -->
-    <!-- ***************************************************** -->
-    <!-- We should use SSL in production                       -->
-    <resources base="http://localhost:35357" xml:id="os-identity-admin-v3">
+    <!--*******************************************************-->
+    <!-- We should use SSL in production -->
+    <resources base="http://localhost:5000"
+        xml:id="os-identity-admin-v3">
         <!-- FYI: double slash needed in path to get a single slash to display -->
         <resource id="versions" path="//">
             <method href="#listIdentityVersions"/>