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"?> <?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
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:xlink="http://www.w3.org/1999/xlink" xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:linkend="http://www.w3.org/1999/linkend" version="5.0-extension RackBook-2.0" xml:id="identity-admin-v2" xlink:href="#identity-admin-v2"
xmlns:xref="http://www.w3.org/1999/xref" role="api-reference">
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> <title>Identity admin API v2.0 (STABLE)</title>
<para>Get an authentication token that permits access to the <para>Get an authentication token that permits access to the Compute API.</para>
Compute API.</para> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resources <wadl:resource href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#tokenById">
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl" <wadl:method href="#validateToken-admin"/>
xmlns:wadl="http://wadl.dev.java.net/2009/02"> <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 <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"/> href="../wadls/identity-api/src/v2.0/wadl/identity-admin.wadl#userRolesForTenant">
<wadl:resource <wadl:method href="#listRolesForUserOnTenant"/>
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>
<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"
/>
</wadl:resources> </wadl:resources>
</chapter> </chapter>

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

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

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

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

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

@ -519,125 +519,154 @@
</wadl:doc> </wadl:doc>
</param>'> </param>'>
<!ENTITY interfaceRequestParamOpt ' <!ENTITY interfaceRequestParamOpt '
<param name="interface" style="plain" required="false" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02"> <param name="interface" style="plain" required="false" type="xsd:string"
<wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns="http://wadl.dev.java.net/2009/02">
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02"
<para>The interface type, which is <code>admin</code>, <code>public</code>, or <code>internal</code>.</para> xml:lang="EN">
<para>The interface type, which is <code>admin</code>, <code>public</code>, or
<code>internal</code>.</para>
</wadl:doc> </wadl:doc>
</param>'> </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" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> 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> <para>The date and time stamp for when the token was issued.</para>
</wadl:doc> </wadl:doc>
</param>'> </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" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>A <code>token</code> object.</para> <para>A <code>token</code> object.</para>
</wadl:doc> </wadl:doc>
</param>'> </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" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The date and time stamp for when the token expires.</para> <para>The date and time stamp for when the token expires.</para>
</wadl:doc> </wadl:doc>
</param>'> </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" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The domain ID.</para> <para>The domain ID.</para>
</wadl:doc> </wadl:doc>
</param>'> </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" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The domain links.</para> <para>The domain links.</para>
</wadl:doc> </wadl:doc>
</param>'> </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" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The domain name.</para> <para>The domain name.</para>
</wadl:doc> </wadl:doc>
</param>'> </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" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The user ID.</para> <para>The user ID.</para>
</wadl:doc> </wadl:doc>
</param>'> </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" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The user links.</para> <para>The user links.</para>
</wadl:doc> </wadl:doc>
</param>'> </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" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The user name.</para> <para>The user name.</para>
</wadl:doc> </wadl:doc>
</param>'> </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" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>A <code>service</code> object.</para> <para>A <code>service</code> object.</para>
</wadl:doc> </wadl:doc>
</param>'> </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" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>A <code>services</code> object.</para> <para>A <code>services</code> object.</para>
</wadl:doc> </wadl:doc>
</param>'> </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" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The service ID.</para> <para>The service ID.</para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
<!ENTITY service_nameResponseParam '<param name="name" style="plain" required="true" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02"> <!ENTITY service_nameResponseParam '
<wadl:doc xmlns="http://docbook.org/ns/docbook" <param name="name" style="plain" required="true" type="xsd:string"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> 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> <para>The service name.</para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
<!ENTITY service_typeResponseParam '<param name="type" style="plain" required="true" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02"> <!ENTITY service_typeResponseParam '
<wadl:doc xmlns="http://docbook.org/ns/docbook" <param name="type" style="plain" required="true" type="xsd:string"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> 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> <para>The service type.</para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
<!ENTITY service_linksResponseParam ' <!ENTITY service_linksResponseParam '
<param name="links" style="plain" type="xsd:string" <param name="links" style="plain" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02"
xmlns="http://wadl.dev.java.net/2009/02" required="true"> required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" <wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN"><para>The xml:lang="EN">
service links.</para></wadl:doc> <para>The service links.</para>
</wadl:doc>
</param>'> </param>'>
<!ENTITY domainsResponseParam ' <!ENTITY domainsResponseParam '
<param name="domains" style="plain" type="xsd:string" <param name="domains" style="plain" type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02"
xmlns="http://wadl.dev.java.net/2009/02" required="true"> required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" <wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN"><para>A <code>domains</code> object.</para></wadl:doc> 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>'> </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 --> <!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'> <!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</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:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://www.w3.org/2001/XMLSchema" xmlns:csapi="http://www.w3.org/2001/XMLSchema"
xmlns:metering="http://docs.openstack.org/neutron/api/v2.0"> xmlns:metering="http://docs.openstack.org/neutron/api/v2.0">
<grammars> <!--<grammars>
<include href="../xsd/metering.xsd"/> <include href="../xsd/metering.xsd"/>
</grammars> </grammars>-->
<resources base="https://servers.api.openstack.com/" <resources base="https://servers.api.openstack.com/"
xml:id="metering-labels-v2.0"> xml:id="metering-labels-v2.0">
<resource id="version" path="//v2.0"> <resource id="version" path="//v2.0">

2
pom.xml
View File

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