openstack
/
api-site
Code Issues Proposed changes

[api-ref] Added response parameter tables for APIs. 

Change-Id: Ieda894a85c9593f07ce472d9b47ba842c0a4fc5f
Partial-Bug: #1572168
This commit is contained in:
sharat.sharma 2016-04-21 18:34:50 +05:30
parent 0ec6c87f43
commit 826f70f90a
1 changed files with 70 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl
View File

@ -783,6 +783,26 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/admin/user-show-response.json"/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" name="id" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">The user
ID.</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">The user
name.</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="email" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">The user
email.</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="enabled" style="plain"
type="xsd:boolean" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">Indicates whether
the user is enabled (true) or disabled (false).</wadl:doc>
</param>
</representation>
</response>
<response status="203"/>
@ -804,6 +824,31 @@
<xsdxt:code href="../samples/admin/roles-list-response.json"/>
</xsdxt:sample>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" name="roles" style="plain"
type="xsd:list" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">A roles
object.</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="id" style="plain"
type="csapi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">The role
id.</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">The user
name.</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="description" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">The description
of the role.</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="roles_links" style="plain"
type="xsd:list" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">A roles_links
object.</wadl:doc>
</param>
</representation>
</response>
<response status="203" />
@ -903,6 +948,31 @@
<xsdxt:code href="../samples/admin/roles-list-response.json"/>
</xsdxt:sample>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" name="roles" style="plain"
type="xsd:list" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">A roles
object.</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="id" style="plain"
type="csapi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">The role
id.</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">The user
name.</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="description" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">The description
of the role.</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="roles_links" style="plain"
type="xsd:list" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">A roles_links
object.</wadl:doc>
</param>
</representation>
</response>
<response status="203" />