openstack/api-site
Code Issues Proposed changes

Update to clouddocs-maven-plugin 2.1.1

Browse Source 
Updated files to try to fix build issue

Change-Id: I5ca8f84a1e77776e27e37044fc5a86b0787788be
This commit is contained in:
Andreas Jaeger 2014-07-02 21:21:44 +02:00 committed by Diane Fleming
parent 6a27eaaded
commit e5db9bdfbe
8 changed files with 413 additions and 583 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
api-ref/src/docbkx/ch_identity-admin-v2.xml
View File

@ -1,24 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="identity-admin-v2"
xlink:href="#identity-admin-v2" role="api-reference">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="identity-admin-v2" xlink:href="#identity-admin-v2"
role="api-reference">
<title>Identity admin API v2.0 (STABLE)</title>
<para>Get an authentication token that permits access to the
Compute API.</para>
<wadl:resources
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>Get an authentication token that permits access to the Compute API.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#tokenById">
<wadl:method href="#validateToken-admin"/>
<wadl:method href="#checkToken-admin"/>
</wadl:resource>
<wadl:resource href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#name">
<wadl:method href="#getUserByName"/>
</wadl:resource>
<wadl:resource href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#user_id">
<wadl:method href="#getUserById"/>
</wadl:resource>
<wadl:resource href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#userRoles">
<wadl:method href="#listUserGlobalRoles"/>
</wadl:resource>
<wadl:resource href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#tenants">
<wadl:method href="#listTenants"/>
<wadl:method href="#getTenantByName"/>
</wadl:resource>
<wadl:resource href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#tenantById">
<wadl:method href="#getTenantById"/>
</wadl:resource>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#tokenById"/>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#users"/>
<wadl:resource
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#tenants"
/>
href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#userRolesForTenant">
<wadl:method href="#listRolesForUserOnTenant"/>
</wadl:resource>
</wadl:resources>
</chapter>

113
api-ref/src/docbkx/ch_identity-v3.xml
View File

@ -1,25 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="identity-v3"
xlink:href="#identity-v3" role="api-reference">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="identity-v3" xlink:href="#identity-v3"
role="api-reference">
<title>Identity API v3 (STABLE)</title>
<para>Get an authentication token that permits access to the
Compute API.</para>
<para>Get an authentication token that permits access to the Compute API.</para>
<section xml:id="versions-identity-v3">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#versions">
<wadl:resource href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#versions">
<wadl:method href="#getVersions-identity-v3"/>
</wadl:resource>
<!-- list version -->
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#version">
<wadl:resource href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#version">
<wadl:method href="#showVersionDetails-identity-v3"/>
</wadl:resource>
</wadl:resources>
@ -30,8 +24,7 @@
<para>Manage tokens.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- authenticate token -->
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#tokens">
<wadl:resource href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#tokens">
<wadl:method href="#authenticate"/>
<wadl:method href="#validateTokens"/>
<wadl:method href="#checkTokens"/>
@ -45,8 +38,7 @@
<para>Manage the catalog of services.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create service -->
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#services">
<wadl:resource href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#services">
<wadl:method href="#createService"/>
<wadl:method href="#listServices"/>
</wadl:resource>
@ -64,58 +56,50 @@
<para>Manage endpoints.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create endpoint -->
<wadl:resource href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#endpoints"/>
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#endpoints"/>
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#endpoint_id"
/>
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#endpoint_id"/>
</wadl:resources>
</section>
<!-- Domains -->
<section xml:id="domains-v3">
<title>Domains</title>
<para>Manage domains.</para>
<para>Domains represent collections of users, groups, and
projects. Each is owned by exactly one domain. Users,
however, can be associated with multiple projects by
granting roles to the user on a project, including
projects owned by other domains.</para>
<para>Each domain defines a namespace where certain
API-visible name attributes exist, which affects whether
those names must be globally unique or unique within that
domain. In the Identity API, the uniqueness of the
following attributes is as follows:</para>
<para>Domains represent collections of users, groups, and projects. Each is owned by exactly
one domain. Users, however, can be associated with multiple projects by granting roles
to the user on a project, including projects owned by other domains.</para>
<para>Each domain defines a namespace where certain API-visible name attributes exist, which
affects whether those names must be globally unique or unique within that domain. In the
Identity API, the uniqueness of the following attributes is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis role="italic">Domain Name</emphasis>.
Globally unique across all domains.</para>
<para><emphasis role="italic">Domain Name</emphasis>. Globally unique across all
domains.</para>
</listitem>
<listitem>
<para><emphasis role="italic">Role Name</emphasis>.
Globally unique across all domains.</para>
<para><emphasis role="italic">Role Name</emphasis>. Globally unique across all
domains.</para>
</listitem>
<listitem>
<para><emphasis role="italic">User Name</emphasis>.
Unique within the owning domain.</para>
<para><emphasis role="italic">User Name</emphasis>. Unique within the owning
domain.</para>
</listitem>
<listitem>
<para><emphasis role="italic">Project Name</emphasis>.
Unique within the owning domain.</para>
<para><emphasis role="italic">Project Name</emphasis>. Unique within the owning
domain.</para>
</listitem>
<listitem>
<para><emphasis role="italic">Group Name</emphasis>.
Unique within the owning domain.</para>
<para><emphasis role="italic">Group Name</emphasis>. Unique within the owning
domain.</para>
</listitem>
</itemizedlist>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create domain -->
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#domains">
<wadl:resource href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#domains">
<wadl:method href="#createDomain"/>
<wadl:method href="#listDomains"/>
</wadl:resource>
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#domain_id">
<wadl:resource href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#domain_id">
<wadl:method href="#getDomain"/>
<wadl:method href="#updateDomain"/>
<wadl:method href="#deleteDomain"/>
@ -143,29 +127,29 @@
</wadl:resources>
</section>
<!-- Projects -->
<section xml:id="projects-v3">
<!--<section xml:id="projects-v3">
<title>Projects</title>
<para>Manage projects.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create project -->
<!-\- create project -\->
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#projects">
<wadl:method href="#createProject"/>
<wadl:method href="#listProjects"/>
</wadl:resource>
<!-- get project -->
<!-\- get project -\->
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#project_id">
<wadl:method href="#getProject"/>
<wadl:method href="#updateProject"/>
<wadl:method href="#deleteProject"/>
</wadl:resource>
<!-- list project users -->
<!--<wadl:resource
<!-\- list project users -\->
<!-\-<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#users">
<wadl:method href="#listProjectUsers"/>
</wadl:resource>-->
<!-- list project user roles -->
</wadl:resource>-\->
<!-\- list project user roles -\->
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#user_id_roles">
<wadl:method href="#grantProjectGroupRole"/>
@ -174,7 +158,7 @@
</wadl:resource>
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#project-user-role_id"/>
<!-- check project user role -->
<!-\- check project user role -\->
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#project-groups-roles"/>
<wadl:resource
@ -183,7 +167,7 @@
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#roles"
/>
</wadl:resources>
</section>
</section>-->
<!-- Users -->
<section xml:id="users-v3">
<title>Users</title>
@ -191,18 +175,16 @@
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create user -->
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#users">
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#create-users">
<wadl:method href="#createUser"/>
<wadl:method href="#listUsers"/>
</wadl:resource>
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#user_id">
<wadl:resource href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#user_id">
<wadl:method href="#getUser"/>
<wadl:method href="#updateUser"/>
<wadl:method href="#deleteUser"/>
</wadl:resource>
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#groups">
<wadl:resource href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#groups">
<wadl:method href="#listUserGroups"/>
</wadl:resource>
<wadl:resource
@ -210,8 +192,9 @@
<wadl:method href="#listUserProjects"/>
</wadl:resource>
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#user-roles"
/>
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#user-roles">
<wadl:method href="#listUserRoles"/>
</wadl:resource>
</wadl:resources>
</section>
<!-- Groups -->
@ -291,13 +274,11 @@
<para>Manage policies.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create policy -->
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#policies">
<wadl:resource href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#policies">
<wadl:method href="#createPolicy"/>
<wadl:method href="#listPolicies"/>
</wadl:resource>
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#policy_id">
<wadl:resource href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#policy_id">
<wadl:method href="#getPolicy"/>
<wadl:method href="#updatePolicy"/>
<wadl:method href="#deletePolicy"/>

3
api-ref/src/docbkx/ch_netconn-ext-v2.xml
View File

@ -30,9 +30,6 @@
<wadl:resource
href="../wadls/netconn-api/src/os-quotas.wadl#Quotas">
<wadl:method href="#listQuotas"/>
</wadl:resource>
<wadl:resource
href="../wadls/netconn-api/src/os-quotas.wadl#tenant_id">
<wadl:method href="#showQuota"/>
<wadl:method href="#updateQuota"/>
<wadl:method href="#resetQuota"/>

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

@ -26,68 +26,54 @@
<!-- All Resources -->
<!--*******************************************************-->
<!-- We should use SSL in production -->
<resources base="http://localhost:35357"
xml:id="identity-admin-v2.0">
<resources base="http://localhost:35357" xml:id="identity-admin-v2.0">
<resource id="version" path="//v2.0">
<method href="#getVersionInfo"/>
<resource id="extensions" path="extensions">
<method href="#listExtensions"/>
<resource id="extension" path="{alias}">
<param name="alias" style="template"
type="xsd:string"/>
<param name="alias" style="template" type="xsd:string"/>
<method href="#getExtension"/>
</resource>
</resource>
<resource id="tokens" path="tokens">
<param xmlns="http://wadl.dev.java.net/2009/02"
name="username" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>Required. The user
name.</para></wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" name="username" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<para>Required. The user name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="password" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>Required. The password of the
user.</para></wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" name="password" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<para>Required. The password of the user.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="tenantName" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>Optional. The tenant
name.</para></wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" name="tenantName" style="plain"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<para>Optional. The tenant name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="tenantId" style="plain" required="false"
type="capi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>Optional. The tenant
ID.</para></wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" name="tenantId" style="plain"
required="false" type="capi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<para>Optional. The tenant ID.</para>
</wadl:doc>
</param>
<method href="#authenticate"/>
<resource id="tokenById" path="{tokenId}">
<param name="tokenId" style="template"
type="capi:UUID" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">Required. The token
ID.</wadl:doc>
<param name="tokenId" style="template" type="capi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">Required. The
token ID.</wadl:doc>
</param>
<param name="belongsTo" style="query"
required="false" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Validates that a token
has the specified tenant in scope, for
performance. Valid tokens are in the
<code>/tokens/{tokenId}</code>
path. An itemNotFound
(<code>404</code>) fault is
returned for a token that is not
valid.</para></wadl:doc>
<param name="belongsTo" style="query" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Validates that a token has the specified tenant in scope, for
performance. Valid tokens are in the <code>/tokens/{tokenId}</code>
path. An itemNotFound (<code>404</code>) fault is returned for a
token that is not valid.</para>
</wadl:doc>
</param>
<method href="#validateToken-admin"/>
<method href="#checkToken-admin"/>
@ -97,27 +83,21 @@
</resource>
</resource>
<resource id="users" path="users">
<param name="X-Auth-Token" style="header"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">A valid authentication token for
an administrative user.</wadl:doc>
<param name="X-Auth-Token" style="header" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">A valid
authentication token for an administrative user.</wadl:doc>
</param>
<resource id="name">
<param name="name" style="query" type="xsd:string"
required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The user name.</wadl:doc>
<resource id="name" path="{name}">
<param name="name" style="query" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">The user
name.</wadl:doc>
</param>
<method href="#getUserByName"/>
</resource>
<resource id="userid" path="{user_id}">
<param name="user_id" style="template"
type="xsd:string" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The user ID.</wadl:doc>
<param name="user_id" style="template" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">The user
ID.</wadl:doc>
</param>
<method href="#getUserById"/>
<resource id="userRoles" path="roles">
@ -126,46 +106,34 @@
</resource>
</resource>
<resource id="tenants" path="tenants">
<param name="X-Auth-Token" style="header"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">A valid authentication token for
an administrative user.</wadl:doc>
<param name="X-Auth-Token" style="header" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">A valid
authentication token for an administrative user.</wadl:doc>
</param>
<param name="marker" style="query" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The ID of the last item in the
previous list.</wadl:doc>
<param name="marker" style="query" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">The ID of the last
item in the previous list.</wadl:doc>
</param>
<param name="limit" style="query" required="false"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The page size. </wadl:doc>
<param name="limit" style="query" required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">The page size.
</wadl:doc>
</param>
<method href="#listTenants"/>
<method href="#getTenantByName"/>
<resource id="tenantById" path="{tenantId}">
<param name="tenantId" style="template"
type="xsd:string" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The tenant ID.</wadl:doc>
<param name="tenantId" style="template" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">The tenant
ID.</wadl:doc>
</param>
<method href="#getTenantById"/>
<resource id="usersForTenant" path="users">
<resource id="getTenantUser" path="{userId}">
<param name="userId" style="template"
type="xsd:string" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The user
ID.</wadl:doc>
<param name="userId" style="template" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">The
user ID.</wadl:doc>
</param>
<resource id="userRolesForTenant"
path="roles">
<method
href="#listRolesForUserOnTenant"/>
<resource id="userRolesForTenant" path="roles">
<method href="#listRolesForUserOnTenant"/>
</resource>
</resource>
</resource>
@ -177,13 +145,11 @@
<!--*******************************************************-->
<!-- Resource Types -->
<!--*******************************************************-->
<resource_type id="VersionDetails">
<method href="#getVersionInfo"/>
</resource_type>
<resource_type id="ExtensionList">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Extension List">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Extension List">
<para>A list of supported extensions.</para>
</wadl:doc>
<method href="#listExtensions"/>
@ -193,31 +159,23 @@
<!--*******************************************************-->
<!-- Version -->
<method name="GET" id="getVersionInfo">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get version details">
<para>Gets detailed information about a specified version
of the Identity API.</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Get version details">
<para>Gets detailed information about a specified version of the Identity API.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<response status="200 203"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Get version information: JSON response">
<xsdxt:sample title="Get version information: JSON response">
<xsdxt:code href="../samples/version.json"/>
</xsdxt:sample>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="capi:version">
<representation mediaType="application/xml" element="capi:version">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Get version information: XML response">
<xsdxt:sample title="Get version information: XML response">
<xsdxt:code href="../samples/version.xml"/>
</xsdxt:sample>
</wadl:doc>
<param name="location" style="plain" type="xsd:anyURI"
required="true"
<param name="location" style="plain" type="xsd:anyURI" required="true"
path="/capi:version/atom:link[@rel='self']/@href">
<link resource_type="#VersionDetails" rel="self"/>
</param>
@ -225,35 +183,27 @@
</response> &commonFaults; &getFaults; </method>
<!-- Extensions -->
<method name="GET" id="listExtensions">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List extensions">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List extensions">
<para>Lists available extensions.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json"
<response status="200 203"> <representation mediaType="application/json"
element="capi:extensions">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="List extensions: JSON response">
<xsdxt:code href="../samples/extensions.json"
/>
<xsdxt:sample title="List extensions: JSON response">
<xsdxt:code href="../samples/extensions.json"/>
</xsdxt:sample>
</wadl:doc>
<param name="next" style="plain" type="xsd:anyURI"
path="/capi:extensions/atom:link[@rel='next']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">Moves to the next item in the
list.</wadl:doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">Moves to the next
item in the list.</wadl:doc>
<link resource_type="#ExtensionList" rel="next"/>
</param>
<param name="previous" style="plain" type="xsd:anyURI"
path="/capi:extensions/atom:link[@rel='previous']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">Moves to the previous item in
the list.</wadl:doc>
<link resource_type="#ExtensionList"
rel="previous"/>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">Moves to the
previous item in the list.</wadl:doc>
<link resource_type="#ExtensionList" rel="previous"/>
</param>
</representation>
<!-- <representation mediaType="application/xml"
@ -267,16 +217,13 @@
</representation>-->
</response> &commonFaults; &getFaults; </method>
<method name="GET" id="getExtension">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get extension details">
<para>Gets detailed information for a specified
extension.</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Get extension details">
<para>Gets detailed information for a specified extension.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Get extension details: JSON response">
<xsdxt:sample title="Get extension details: JSON response">
<xsdxt:code href="../samples/extension.json"/>
</xsdxt:sample>
</wadl:doc>
@ -295,339 +242,230 @@
<method name="POST" id="authenticate">
<wadl:doc xml:lang="EN" title="Authenticate for Admin API"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Authenticates and generates a
token.</para>
<para>Client authentication is provided through a ReST
interface by using the POST method with v2.0/tokens
supplied as the path. Include a payload of credentials
in the body.</para>
<para>The Identity API is a ReSTful web service. It is the
entry point to all service APIs. To access the
Identity API, you must know its URL.</para>
<para>Each ReST request against the Identity Service
requires the <code>X-Auth-Token</code> header. Clients
obtain this token, along with the URL to other service
APIs, by first authenticating against Identity with
valid credentials.</para>
<para>If the authentication token has expired, a
<errorcode>401</errorcode> response code is
returned.</para>
<para>If the token specified in the request body has
expired, this call returns a
<para role="shortdesc">Authenticates and generates a token.</para>
<para>Client authentication is provided through a ReST interface by using the POST
method with v2.0/tokens supplied as the path. Include a payload of credentials in
the body.</para>
<para>The Identity API is a ReSTful web service. It is the entry point to all service
APIs. To access the Identity API, you must know its URL.</para>
<para>Each ReST request against the Identity Service requires the
<code>X-Auth-Token</code> header. Clients obtain this token, along with the URL
to other service APIs, by first authenticating against Identity with valid
credentials.</para>
<para>If the authentication token has expired, a <errorcode>401</errorcode> response
code is returned.</para>
<para>If the token specified in the request body has expired, this call returns a
<errorcode>404</errorcode> response code.</para>
<para>Identity treats expired tokens as invalid
tokens.</para>
<para>The deployment determines how long expired tokens
are stored.</para>
<para>Identity treats expired tokens as invalid tokens.</para>
<para>The deployment determines how long expired tokens are stored.</para>
</wadl:doc>
<request>
<representation mediaType="application/json"
element="identity:auth">
<request> <representation mediaType="application/json" element="identity:auth">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Authenticate with credentials: JSON request">
<xsdxt:code
href="../samples/auth_credentials_admin.json"
/>
<xsdxt:sample title="Authenticate with credentials: JSON request">
<xsdxt:code href="../samples/auth_credentials_admin.json"/>
</xsdxt:sample>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="identity:auth">
<representation mediaType="application/xml" element="identity:auth">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Authenticate with credentials: XML request">
<xsdxt:code
href="../samples/auth_credentials_admin.xml"
/>
<xsdxt:sample title="Authenticate with credentials: XML request">
<xsdxt:code href="../samples/auth_credentials_admin.xml"/>
</xsdxt:sample>
</wadl:doc>
<param name="tenantName" style="plain"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The tenant name. Both the
<code>tenantId</code> and
<code>tenantName</code> attributes are
optional, but should not be specified
together. If both attributes are
specified, the server responds with a
<code>400</code>
<code>Bad
Request</code>.</para></wadl:doc>
<param name="tenantName" style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>The tenant name. Both the
<code>tenantId</code> and <code>tenantName</code> attributes are
optional, but should not be specified together. If both attributes are
specified, the server responds with a <code>400</code>
<code>Bad Request</code>.</para></wadl:doc>
</param>
<param name="tenantId" style="plain" required="false"
type="capi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The tenant ID. Both the
<code>tenantId</code> and
<code>tenantName</code> attributes are
optional, but should not be specified
together. If both attributes are
specified, the server responds with a
<code>400</code>
<code>Bad
Request</code>.</para></wadl:doc>
<param name="tenantId" style="plain" required="false" type="capi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>The tenant ID. Both the
<code>tenantId</code> and <code>tenantName</code> attributes are
optional, but should not be specified together. If both attributes are
specified, the server responds with a <code>400</code>
<code>Bad Request</code>.</para></wadl:doc>
</param>
<param name="passwordCredentials" style="plain"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A <code>passwordCredentials</code>
object. To authenticate, you must provide
either a user ID and password or a
<param name="passwordCredentials" style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>A
<code>passwordCredentials</code> object. To authenticate, you must
provide either a user ID and password or a token.</para></wadl:doc>
</param>
<param name="username" style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><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.</para></wadl:doc>
</param>
<param name="username" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><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
<param name="password" style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>The password of the user.
Required if you include the <code>passwordCredentials</code> object. If
you do not provide a password credentials, you must provide a
token.</para></wadl:doc>
</param>
<param name="password" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The password of the user. Required
if you include the
<code>passwordCredentials</code>
object. If you do not provide a password
credentials, you must provide a
token.</para></wadl:doc>
</param>
<param name="token" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A <code>token</code> object.
Required if you do not provide password
<param name="token" style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>A <code>token</code>
object. Required if you do not provide password
credentials.</para></wadl:doc>
</param>
<param name="id" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The token ID. This is a required
field in the <code>token</code>
object.</para></wadl:doc>
<param name="id" style="plain" required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>The token ID. This is a
required field in the <code>token</code> object.</para></wadl:doc>
</param>
</representation>
<representation mediaType="application/json"
element="identity:auth">
<representation mediaType="application/json" element="identity:auth">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Authenticate with token: JSON request">
<xsdxt:code
href="../samples/auth_token_request.json"
/>
<xsdxt:sample title="Authenticate with token: JSON request">
<xsdxt:code href="../samples/auth_token_request.json"/>
</xsdxt:sample>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="identity:auth">
<representation mediaType="application/xml" element="identity:auth">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Authenticate with token: XML request">
<xsdxt:code
href="../samples/auth_token_request.xml"/>
<xsdxt:sample title="Authenticate with token: XML request">
<xsdxt:code href="../samples/auth_token_request.xml"/>
</xsdxt:sample>
</wadl:doc>
</representation>
</request>
<response status="200 203">
<representation mediaType="application/json"
<response status="200 203"> <representation mediaType="application/json"
element="identity:access">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Authenticate with credentials: JSON response">
<xsdxt:code href="../samples/auth_admin.json"
/>
<xsdxt:sample title="Authenticate with credentials: JSON response">
<xsdxt:code href="../samples/auth_admin.json"/>
</xsdxt:sample>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="identity:access">
<representation mediaType="application/xml" element="identity:access">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Authenticate with credentials: XML response">
<xsdxt:sample title="Authenticate with credentials: XML response">
<xsdxt:code href="../samples/auth_admin.xml"/>
</xsdxt:sample>
</wadl:doc>
<param name="access" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>An <code>access</code>
<param name="access" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>An <code>access</code>
object.</para></wadl:doc>
</param>
<param name="token" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A <code>token</code>
<param name="token" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>A <code>token</code>
object.</para></wadl:doc>
</param>
<param name="issued_at" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A timestamp that indicates when the
token was issued.</para></wadl:doc>
<param name="issued_at" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>A timestamp that indicates
when the token was issued.</para></wadl:doc>
</param>
<param name="expires" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A timestamp that indicates when the
token expires.</para></wadl:doc>
<param name="expires" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>A timestamp that indicates
when the token expires.</para></wadl:doc>
</param>
<param name="id" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The authentication token. In the
example, the token is
<code>my_id</code>.</para></wadl:doc>
<param name="id" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>The authentication token.
In the example, the token is <code>my_id</code>.</para></wadl:doc>
</param>
<param name="tenant" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A <code>tenant</code>
<param name="tenant" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>A <code>tenant</code>
object.</para></wadl:doc>
</param>
<param name="description" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The description of the tenant. If
not set, this value is
<code>null</code>.</para></wadl:doc>
<param name="description" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>The description of the
tenant. If not set, this value is <code>null</code>.</para></wadl:doc>
</param>
<param name="enabled" style="plain" required="true"
type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>Indicates whether the tenant is
enabled or disabled.</para></wadl:doc>
<param name="enabled" style="plain" required="true" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>Indicates whether the
tenant is enabled or disabled.</para></wadl:doc>
</param>
<param name="id" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The tenant ID.</para></wadl:doc>
<param name="id" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>The tenant
ID.</para></wadl:doc>
</param>
<param name="name" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>The tenant name.</para></wadl:doc>
<param name="name" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>The tenant
name.</para></wadl:doc>
</param>
<param name="serviceCatalog" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A <code>serviceCatalog</code>
object.</para></wadl:doc>
<param name="serviceCatalog" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>A
<code>serviceCatalog</code> object.</para></wadl:doc>
</param>
<param name="endpoints" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>One or more <code>endpoints</code>
objects. Each object shows the
<code>adminURL</code>,
<code>region</code>,
<code>internalURL</code>,
<code>id</code>, and
<code>publicURL</code> for the
<param name="endpoints" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>One or more
<code>endpoints</code> objects. Each object shows the
<code>adminURL</code>, <code>region</code>,
<code>internalURL</code>, <code>id</code>, and <code>publicURL</code>
for the endpoint.</para></wadl:doc>
</param>
<param name="endpoints_links" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>Links for the
endpoint.</para></wadl:doc>
</param>
<param name="endpoints_links" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>Links for the
endpoint.</para></wadl:doc>
<param name="type" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>Endpoint
type.</para></wadl:doc>
</param>
<param name="type" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>Endpoint type.</para></wadl:doc>
<param name="name" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>Endpoint
name.</para></wadl:doc>
</param>
<param name="name" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>Endpoint name.</para></wadl:doc>
<param name="user" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>A <code>user</code>
object, which shows the <code>username</code>, <code>roles_links</code>,
<code>id</code>, <code>roles</code>, and
<code>name</code>.</para></wadl:doc>
</param>
<param name="user" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A <code>user</code> object, which
shows the <code>username</code>,
<code>roles_links</code>,
<code>id</code>, <code>roles</code>,
and <code>name</code>.</para></wadl:doc>
</param>
<param name="metadata" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
><para>A <code>metadata</code>
<param name="metadata" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>A <code>metadata</code>
object.</para></wadl:doc>
</param>
</representation>
</response>
<response status="403">
<representation mediaType="application/json"
element="identity:userDisabled"/>
<representation mediaType="application/json" element="identity:userDisabled"/>
</response> &commonFaults; &getFaults; </method>
<method name="GET" id="validateToken-admin">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Validate token">
<para role="shortdesc">Validates a token and confirms that
it belongs to a specified tenant.</para>
<para>Returns the permissions relevant to a particular
client. Valid tokens are in the
<code>/tokens/{tokenId}</code> path. A user should
expect an itemNotFound (<code>404</code>) fault for an
token that is not valid.</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Validate token">
<para role="shortdesc">Validates a token and confirms that it belongs to a specified
tenant.</para>
<para>Returns the permissions relevant to a particular client. Valid tokens are in the
<code>/tokens/{tokenId}</code> path. A user should expect an itemNotFound
(<code>404</code>) fault for an token that is not valid.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Validate token: JSON response">
<xsdxt:code
href="../samples/validatetoken.json"/>
<xsdxt:sample title="Validate token: JSON response">
<xsdxt:code href="../samples/validatetoken.json"/>
</xsdxt:sample>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="identity:access">
<representation mediaType="application/xml" element="identity:access">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample title="Validate token: XML response">
<xsdxt:code
href="../samples/validatetoken.xml"/>
<xsdxt:code href="../samples/validatetoken.xml"/>
</xsdxt:sample>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="HEAD" id="checkToken-admin">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Validate token (admin)">
<para role="shortdesc">Validates a token and confirms that
it belongs to a specified tenant, for performance.
</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Validate token (admin)">
<para role="shortdesc">Validates a token and confirms that it belongs to a specified
tenant, for performance.</para>
</wadl:doc>
<response status="200 203 204"/> &commonFaults; &getFaults; </method>
<method name="GET" id="listEndpointsForToken">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List endoints for token">
<para role="shortdesc">Lists the endpoints associated with
a specified token.</para>
<para role="shortdesc">Lists the endpoints associated with a specified token.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="List endpoints for token: JSON response">
<xsdxt:sample title="List endpoints for token: JSON response">
<xsdxt:code href="../samples/endpoints.json"/>
</xsdxt:sample>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="identity:endpoints">
<representation mediaType="application/xml" element="identity:endpoints">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="List endpoints for token: XML response">
<xsdxt:sample title="List endpoints for token: XML response">
<xsdxt:code href="../samples/endpoints.xml"/>
</xsdxt:sample>
</wadl:doc>
@ -639,8 +477,8 @@
<method name="GET" id="getUserByName">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get user information by name">
<para role="shortdesc">Gets detailed information about a
specified user by user name.</para>
<para role="shortdesc">Gets detailed information about a specified user by user
name.</para>
</wadl:doc>
<!-- <request>
<param name="name" style="query" type="xsd:string"
@ -649,16 +487,13 @@
xml:lang="EN">The user name.</wadl:doc></param>
</request> -->
<response status="200 203">
<representation mediaType="application/xml"
element="identity:user">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<representation mediaType="application/xml" element="identity:user">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/user.xml"/>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/user.json"/>
</wadl:doc>
</representation>
@ -666,44 +501,37 @@
<method name="GET" id="getUserById">
<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
specified user by user ID.</para>
<para role="shortdesc">Gets detailed information about a specified user by user
ID.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/xml"
element="identity:user">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<representation mediaType="application/xml" element="identity:user">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/user.xml"/>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../samples/user.json"/>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="GET" id="listUserGlobalRoles">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List user global roles">
<para role="shortdesc">Lists global roles for a specified
user. Excludes tenant roles.</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List user global roles">
<para role="shortdesc">Lists global roles for a specified user. Excludes tenant
roles.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="List user global roles: JSON response">
<xsdxt:sample title="List user global roles: JSON response">
<xsdxt:code href="../samples/roles.json"/>
</xsdxt:sample>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="identity:roles">
<representation mediaType="application/xml" element="identity:roles">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="List user global roles: XML response">
<xsdxt:sample title="List user global roles: XML response">
<xsdxt:code href="../samples/roles.xml"/>
</xsdxt:sample>
</wadl:doc>
@ -713,14 +541,12 @@
<!-- Tenant Operations -->
<method name="GET" id="listTenants">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List tenants">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List tenants">
<para role="shortdesc">Lists all tenants.</para>
<xsdxt:samples>
<xsdxt:sample xmlns="http://docs.rackspace.com/api"
title="Tenants Request with Auth Token">
<xsdxt:code
href="../samples/tenants-request-JSON.txt"/>
<xsdxt:code href="../samples/tenants-request-JSON.txt"/>
</xsdxt:sample>
</xsdxt:samples>
</wadl:doc>
@ -732,8 +558,7 @@
</xsdxt:sample>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="identity:tenants">
<representation mediaType="application/xml" element="identity:tenants">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample title="Get tenants: XML response">
<xsdxt:code href="../samples/tenants.xml"/>
@ -744,15 +569,13 @@
<method name="GET" id="getTenantByName">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get tenant information by name">
<para role="shortdesc">Gets detailed information about a
specified tenant by name.</para>
<para role="shortdesc">Gets detailed information about a specified tenant by
name.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<param name="name" style="query" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The name of the
<param name="name" style="query" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">The name of the
tenant.</wadl:doc>
</param>
</representation>
@ -760,17 +583,14 @@
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Get tenant by name: JSON response">
<xsdxt:sample title="Get tenant by name: JSON response">
<xsdxt:code href="../samples/tenant.json"/>
</xsdxt:sample>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="identity:tenant">
<representation mediaType="application/xml" element="identity:tenant">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Get tenant by name: XML response">
<xsdxt:sample title="Get tenant by name: XML response">
<xsdxt:code href="../samples/tenant.xml"/>
</xsdxt:sample>
</wadl:doc>
@ -779,48 +599,40 @@
<method name="GET" id="getTenantById">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get tenant information by ID">
<para role="shortdesc">Gets detailed information about a
specified tenant by ID.</para>
<para role="shortdesc">Gets detailed information about a specified tenant by ID.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Get tenant by ID: JSON response">
<xsdxt:sample title="Get tenant by ID: JSON response">
<xsdxt:code href="../samples/tenant.json"/>
</xsdxt:sample>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="identity:tenant">
<representation mediaType="application/xml" element="identity:tenant">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Get tenant by ID: XML response">
<xsdxt:sample title="Get tenant by ID: XML response">
<xsdxt:code href="../samples/tenant.xml"/>
</xsdxt:sample>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="GET" id="listRolesForUserOnTenant">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List roles for user">
<para role="shortdesc">Lists roles for a specified user on
a specified tenant. Excludes global roles.</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List roles for user">
<para role="shortdesc">Lists roles for a specified user on a specified tenant. Excludes
global roles.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="List roles for user: JSON response">
<xsdxt:sample title="List roles for user: JSON response">
<xsdxt:code href="../samples/roles.json"/>
</xsdxt:sample>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="identity:roles">
<representation mediaType="application/xml" element="identity:roles">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="List roles for user: XML response">
<xsdxt:sample title="List roles for user: XML response">
<xsdxt:code href="../samples/roles.xml"/>
</xsdxt:sample>
</wadl:doc>

123
api-ref/src/wadls/identity-api/src/v3/wadl/common.ent
View File

@ -519,125 +519,154 @@
</wadl:doc>
</param>'>
<!ENTITY interfaceRequestParamOpt '
<param name="interface" style="plain" required="false" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The interface type, which is <code>admin</code>, <code>public</code>, or <code>internal</code>.</para>
<param name="interface" style="plain" required="false" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The interface type, which is <code>admin</code>, <code>public</code>, or
<code>internal</code>.</para>
</wadl:doc>
</param>'>
<!ENTITY issued-atResponseParam '<param name="issued_at" style="plain" required="false" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<!ENTITY issued-atResponseParam '
<param name="issued_at" style="plain" required="false" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The date and time stamp for when the token was issued.</para>
</wadl:doc>
</param>'>
<!ENTITY tokenResponseParam '<param name="issued_at" style="plain" required="false" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<!ENTITY tokenResponseParam '
<param name="issued_at" style="plain" required="false" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>A <code>token</code> object.</para>
</wadl:doc>
</param>'>
<!ENTITY expires-atResponseParam '<param name="expires_at" style="plain" required="false" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<!ENTITY expires-atResponseParam '
<param name="expires_at" style="plain" required="false" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The date and time stamp for when the token expires.</para>
</wadl:doc>
</param>'>
<!ENTITY domain-idResponseParam '<param name="id" style="plain" required="false" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<!ENTITY domain-idResponseParam '
<param name="id" style="plain" required="false" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The domain ID.</para>
</wadl:doc>
</param>'>
<!ENTITY domain-linksResponseParam '<param name="links" style="plain" required="false" type="xsd:dict" xmlns="http://wadl.dev.java.net/2009/02">
<!ENTITY domain-linksResponseParam '
<param name="links" style="plain" required="false" type="xsd:dict" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The domain links.</para>
</wadl:doc>
</param>'>
<!ENTITY domain-nameResponseParam '<param name="name" style="plain" required="false" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<!ENTITY domain-nameResponseParam '
<param name="name" style="plain" required="false" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The domain name.</para>
</wadl:doc>
</param>'>
<!ENTITY user-idResponseParam '<param name="id" style="plain" required="false" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<!ENTITY user-idResponseParam '
<param name="id" style="plain" required="false" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The user ID.</para>
</wadl:doc>
</param>'>
<!ENTITY user-linksResponseParam '<param name="links" style="plain" required="false" type="xsd:dict" xmlns="http://wadl.dev.java.net/2009/02">
<!ENTITY user-linksResponseParam '
<param name="links" style="plain" required="false" type="xsd:dict" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The user links.</para>
</wadl:doc>
</param>'>
<!ENTITY user-nameResponseParam '<param name="name" style="plain" required="false" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<!ENTITY user-nameResponseParam '
<param name="name" style="plain" required="false" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The user name.</para>
</wadl:doc>
</param>'>
<!ENTITY serviceResponseParam '<param name="service" style="plain" required="true" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<!ENTITY serviceResponseParam '
<param name="service" style="plain" required="true" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>A <code>service</code> object.</para>
</wadl:doc>
</param>'>
<!ENTITY servicesResponseParam '<param name="services" style="plain" required="true" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<!ENTITY servicesResponseParam '
<param name="services" style="plain" required="true" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>A <code>services</code> object.</para>
</wadl:doc>
</param>'>
<!ENTITY service_idResponseParam '<param name="id" style="plain" required="true" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<!ENTITY service_idResponseParam '
<param name="id" style="plain" required="true" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The service ID.</para>
</wadl:doc>
</param>'>
<!ENTITY service_nameResponseParam '<param name="name" style="plain" required="true" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<!ENTITY service_nameResponseParam '
<param name="name" style="plain" required="true" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The service name.</para>
</wadl:doc>
</param>'>
<!ENTITY service_typeResponseParam '<param name="type" style="plain" required="true" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<!ENTITY service_typeResponseParam '
<param name="type" style="plain" required="true" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The service type.</para>
</wadl:doc>
</param>'>
<!ENTITY service_linksResponseParam '
<param name="links" style="plain" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN"><para>The
service links.</para></wadl:doc>
<param name="links" style="plain" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02"
required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The service links.</para>
</wadl:doc>
</param>'>
<!ENTITY domainsResponseParam '
<param name="domains" style="plain" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN"><para>A <code>domains</code> object.</para></wadl:doc>
<param name="domains" style="plain" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02"
required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A <code>domains</code> object.</para>
</wadl:doc>
</param>'>
<!ENTITY domain_descriptionRequestParam '
<param name="description" style="plain" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02"
required="false">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The domain description.</para>
</wadl:doc>
</param>'>
<!ENTITY domain_enabledRequestParam '
<param name="enabled" style="plain" type="xsd:boolean" xmlns="http://wadl.dev.java.net/2009/02"
required="false">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Set to true to enable the domain. Otherwise, set to false.</para>
</wadl:doc>
</param>'>
<!ENTITY domain_nameRequestParam '
<param name="name" style="plain" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02"
required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The domain name.</para>
</wadl:doc>
</param>'>
<!ENTITY domain_descriptionRequestParam '<param name="description"
style="plain" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02" required="false">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN"><para>The domain description.</para></wadl:doc>
</param>'>
<!ENTITY domain_enabledRequestParam '<param name="enabled" style="plain" type="xsd:boolean"
xmlns="http://wadl.dev.java.net/2009/02" required="false">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN"><para>Set to true to enable the domain.
Otherwise, set to false.</para></wadl:doc>
</param>'>
<!ENTITY domain_nameRequestParam '<param name="name" style="plain" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN"><para>The domain name.</para></wadl:doc>
</param>'>
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>

4
api-ref/src/wadls/netconn-api/src/metering-labels.wadl
View File

@ -8,9 +8,9 @@
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://www.w3.org/2001/XMLSchema"
xmlns:metering="http://docs.openstack.org/neutron/api/v2.0">
<grammars>
<!--<grammars>
<include href="../xsd/metering.xsd"/>
</grammars>
</grammars>-->
<resources base="https://servers.api.openstack.com/"
xml:id="metering-labels-v2.0">
<resource id="version" path="//v2.0">

2
pom.xml
View File

@ -39,7 +39,7 @@
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<version>2.0.4</version>
<version>2.1.1</version>
</plugin>
</plugins>
</build>