openstack/api-site
Code Issues Proposed changes

Update WADLs to place parameters inside representations

Browse Source 
Plain parameters do not show up in dev guides
Root cause: placement of parameters was incorrect.
Moved params inside representations, per David Cramer.

Closes-Bug: #1331677
Closes-Bug: #1297952

Change-Id: I0fde1038e7d17b6833441b3c49c46e34d85decdd
author: diane fleming
This commit is contained in:
Diane Fleming
2014-06-18 20:26:43 -05:00
parent b0d4595d30
commit 9ee755f753
115 changed files with 6918 additions and 6335 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -124,7 +124,7 @@
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#users_user_id_roles">
<wadl:method href="#listDomainUserRoles"/>
</wadl:resource>
<!-- <wadl:resource
<!-- <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#role_id-domainusers">
<wadl:method href="#grantDomainUserRole"/>
<wadl:method href="#checkDomainUserRole"/>
@@ -161,10 +161,10 @@
<wadl:method href="#deleteProject"/>
</wadl:resource>
<!-- list project users -->
<wadl:resource
<!--<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#users">
<wadl:method href="#listProjectUsers"/>
</wadl:resource>
</wadl:resource>-->
<!-- list project user roles -->
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#user_id_roles">

2
api-ref/src/docbkx/ch_images-v1.xml
View File

@@ -47,7 +47,7 @@
<wadl:resource
href="../wadls/image-api/src/v1/os-image-1.0.wadl#image_id">
<wadl:method href="#getImage-v1"/>
<wadl:method href="#getImage-v1Headers"/>
<!-- <wadl:method href="#getImage-v1Headers"/>-->
<wadl:method href="#updateImage-v1"/>
<wadl:method href="#deleteImage-v1"/>
</wadl:resource>

28
api-ref/src/wadls/compute-api/src/v2/common.ent
View File

@@ -828,6 +828,34 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Associated metadata key-and-value pairs.</para></wadl:doc>
</param>'>
<!ENTITY unshelveAction '
<param xmlns="http://wadl.dev.java.net/2009/02" name="unshelve" style="plain" type="xsd:string"
required="true" id="os-unshelve">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Specify the <code>unshelve</code>
action in the request
body.</para></wadl:doc>
</param>' >
<!ENTITY shelveAction ' <param xmlns="http://wadl.dev.java.net/2009/02"
name="shelve" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Specify the <code>shelve</code> action
in the request body.</para>
</wadl:doc>
</param>' >
<!ENTITY shelveOffloadAction '<param xmlns="http://wadl.dev.java.net/2009/02"
name="shelveOffload" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Specify the
<code>shelveOffload</code> action in
the request body.</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>'>

472
api-ref/src/wadls/compute-api/src/v2/ext/os-admin-actions.wadl
View File

@@ -4,7 +4,7 @@
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
<resources base="https://servers.api.openstack.com"
xml:id="os-admin-actions-v2">
<resource id="version" type="#VersionDetails" path="//v2">
@@ -61,14 +61,6 @@
state.</para>
</wadl:doc>
<request>
<param name="pause" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Pause action">
<para>Specify the <code>pause</code> action in the
request body.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Pause server: JSON request">
@@ -84,6 +76,14 @@
href="../api_samples/os-admin-actions/admin-actions-pause.xml"
/>
</wadl:doc>
<param name="pause" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Pause action">
<para>Specify the <code>pause</code> action in
the request body.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
@@ -95,14 +95,6 @@
its status to ACTIVE.</para>
</wadl:doc>
<request>
<param name="unpause" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Unpause action">
<para>Specify the <code>unpause</code> action in
the request body.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Unpause server: JSON request">
@@ -118,6 +110,14 @@
href="../api_samples/os-admin-actions/admin-actions-unpause.xml"
/>
</wadl:doc>
<param name="unpause" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Unpause action">
<para>Specify the <code>unpause</code> action
in the request body.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
@@ -137,14 +137,7 @@
become available to create other instances.</para>
</wadl:doc>
<request>
<param name="suspend" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Suspend action">
<para>Specify the <code>suspend</code> action in
the request body.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Suspend server: JSON request">
@@ -160,6 +153,14 @@
href="../api_samples/os-admin-actions/admin-actions-suspend.xml"
/>
</wadl:doc>
<param name="suspend" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Suspend action">
<para>Specify the <code>suspend</code> action
in the request body.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
@@ -171,14 +172,7 @@
its status to ACTIVE.</para>
</wadl:doc>
<request>
<param name="resume" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Resume action">
<para>Specify the <code>resume</code> action in
the request body.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Resume server: JSON request">
@@ -194,6 +188,14 @@
href="../api_samples/os-admin-actions/admin-actions-resume.xml"
/>
</wadl:doc>
<param name="resume" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Resume action">
<para>Specify the <code>resume</code> action
in the request body.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
@@ -205,14 +207,7 @@
scheduler chooses the host.</para>
</wadl:doc>
<request>
<param name="migrate" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Migrate action">
<para>Specify the <code>migrate</code> action in
the request body.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Migrate server: JSON request">
@@ -228,6 +223,14 @@
href="../api_samples/os-admin-actions/admin-actions-migrate.xml"
/>
</wadl:doc>
<param name="migrate" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Migrate action">
<para>Specify the <code>migrate</code> action
in the request body.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
@@ -239,14 +242,6 @@
server.</para>
</wadl:doc>
<request>
<param name="resetNetwork" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Reset network action">
<para>Specify the <code>resetNetwork</code> action
in the request body.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Reset network: JSON request">
@@ -262,6 +257,14 @@
href="../api_samples/os-admin-actions/admin-actions-reset-network.xml"
/>
</wadl:doc>
<param name="resetNetwork" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Reset network action">
<para>Specify the <code>resetNetwork</code>
action in the request body.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
@@ -273,15 +276,7 @@
server.</para>
</wadl:doc>
<request>
<param name="injectNetworkInfo" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Inject network information action">
<para>Specify the <code>injectNetworkInfo</code>
action in the request body.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -299,6 +294,16 @@
href="../api_samples/os-admin-actions/admin-actions-inject-network-info.xml"
/>
</wadl:doc>
<param name="injectNetworkInfo" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Inject network information action">
<para>Specify the
<code>injectNetworkInfo</code> action
in the request body.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
@@ -309,14 +314,7 @@
<para role="shortdesc">Locks a server.</para>
</wadl:doc>
<request>
<param name="lock" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Lock server action">
<para>Specify the <code>lock</code> action in the
request body.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Lock server: JSON request">
@@ -332,6 +330,14 @@
href="../api_samples/os-admin-actions/admin-actions-lock-server.xml"
/>
</wadl:doc>
<param name="lock" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Lock server action">
<para>Specify the <code>lock</code> action in
the request body.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
@@ -342,14 +348,6 @@
<para role="shortdesc">Unlocks a server.</para>
</wadl:doc>
<request>
<param name="unlock" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Unlock server action">
<para>Specify the <code>unlock</code> action in
the request body.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Unlock server: JSON request">
@@ -365,6 +363,14 @@
href="../api_samples/os-admin-actions/admin-actions-unlock-server.xml"
/>
</wadl:doc>
<param name="unlock" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Unlock server action">
<para>Specify the <code>unlock</code> action
in the request body.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
@@ -375,34 +381,7 @@
<para role="shortdesc">Backs up a server instance.</para>
</wadl:doc>
<request>
<param name="createBackup" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create server backup action">
<para>Specify the <code>createBackup</code> action
in the request body.</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Name"><para>Name of the
backup image.</para></wadl:doc>
</param>
<param name="backup_type" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Backup type"><para>The backup
type. Either 'daily' or
'weekly.'</para></wadl:doc>
</param>
<param name="rotation" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Rotation"><para>An integer
value that represents the number of backups to
maintain.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -420,6 +399,35 @@
href="../api_samples/os-admin-actions/admin-actions-backup-server.xml"
/>
</wadl:doc>
<param name="createBackup" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Create server backup action">
<para>Specify the <code>createBackup</code>
action in the request body.</para>
</wadl:doc>
</param>
<param name="name" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Name"><para>Name of the
backup image.</para></wadl:doc>
</param>
<param name="backup_type" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Backup type"><para>The
backup type. Either 'daily' or
'weekly.'</para></wadl:doc>
</param>
<param name="rotation" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Rotation"><para>An
integer value that represents the number
of backups to maintain.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
@@ -431,34 +439,7 @@
host without rebooting.</para>
</wadl:doc>
<request>
<param name="os-migrateLive" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Live-migrate server action">
<para>Specify the <code>os-migrateLive</code>
action in the request body.</para>
</wadl:doc>
</param>
<param name="host" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Host"><para>Name of the new
host.</para></wadl:doc>
</param>
<param name="block_migration" style="plain"
required="true" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Block migration flag"
><para>If true, migration is
blocked.</para></wadl:doc>
</param>
<param name="disk_over_commit" style="plain"
required="true" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Disk overcommit flag"
><para>If true, disk over commit is
allowed.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -476,6 +457,35 @@
href="../api_samples/os-admin-actions/admin-actions-live-migrate.xml"
/>
</wadl:doc>
<param name="os-migrateLive" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Live-migrate server action">
<para>Specify the <code>os-migrateLive</code>
action in the request body.</para>
</wadl:doc>
</param>
<param name="host" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Host"><para>Name of the
new host.</para></wadl:doc>
</param>
<param name="block_migration" style="plain"
required="true" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Block migration flag"
><para>If true, migration is
blocked.</para></wadl:doc>
</param>
<param name="disk_over_commit" style="plain"
required="true" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Disk overcommit flag"
><para>If true, disk over commit is
allowed.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
@@ -487,20 +497,7 @@
specified state.</para>
</wadl:doc>
<request>
<param name="resetState" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Reset server state action">
<para>Specify the <code>resetState</code> action
in the request body.</para>
</wadl:doc>
</param>
<param name="state" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="State"><para>The desired
state of a server.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -518,6 +515,21 @@
href="../api_samples/os-admin-actions/admin-actions-reset-server-state.xml"
/>
</wadl:doc>
<param name="resetState" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Reset server state action">
<para>Specify the <code>resetState</code>
action in the request body.</para>
</wadl:doc>
</param>
<param name="state" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="State"><para>The desired
state of a server.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
@@ -529,36 +541,7 @@
host.</para>
</wadl:doc>
<request>
<param name="evacuate" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Evacuate action">
<para>Specify the <code>evacuate</code> action in
the request body.</para>
</wadl:doc>
</param>
<param name="host" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Host"><para>The name or ID of
the host where the server is
evacuated.</para></wadl:doc>
</param>
<param name="adminPass" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Admin password"
><para>Specifies a new admin password for the
evacuated instance.</para></wadl:doc>
</param>
<param name="onSharedStorage" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="On shared storage flag"
><para>If server is on shared storage, set to
True. Otherwise, set to
False.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -575,6 +558,36 @@
href="../api_samples/os-admin-actions/server-evacuate-req.xml"
/>
</wadl:doc>
<param name="evacuate" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Evacuate action">
<para>Specify the <code>evacuate</code> action
in the request body.</para>
</wadl:doc>
</param>
<param name="host" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Host"><para>The name or
ID of the host where the server is
evacuated.</para></wadl:doc>
</param>
<param name="adminPass" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Admin password"
><para>Specifies a new admin password for
the evacuated instance.</para></wadl:doc>
</param>
<param name="onSharedStorage" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="On shared storage flag"
><para>If server is on shared storage, set
to True. Otherwise, set to
False.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200">
@@ -605,21 +618,7 @@
to a specified server.</para>
</wadl:doc>
<request>
<param name="addSecurityGroup" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Add security group action"
><para>Specify the
<code>addSecurityGroup</code> action in
the request body.</para></wadl:doc>
</param>
<param name="name" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Name"><para>The name of the
security group to assign to the
server.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -637,6 +636,22 @@
href="../api_samples/os-security-groups/security-group-add-post-req.xml"
/>
</wadl:doc>
<param name="addSecurityGroup" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Add security group action"
><para>Specify the
<code>addSecurityGroup</code> action
in the request body.</para></wadl:doc>
</param>
<param name="name" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Name"><para>The name of
the security group to assign to the
server.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200"/>
@@ -648,21 +663,7 @@
from a specified server.</para>
</wadl:doc>
<request>
<param name="removeSecurityGroup" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Remove security group action"
><para>Specify the
<code>removeSecurityGroup</code> action in
the request body.</para></wadl:doc>
</param>
<param name="name" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Name"><para>The name of the
security group to remove from the
server.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -680,6 +681,23 @@
href="../api_samples/os-security-groups/security-group-remove-post-req.xml"
/>
</wadl:doc>
<param name="removeSecurityGroup" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Remove security group action"
><para>Specify the
<code>removeSecurityGroup</code>
action in the request
body.</para></wadl:doc>
</param>
<param name="name" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Name"><para>The name of
the security group to remove from the
server.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200"/>
@@ -693,27 +711,6 @@
the floating IP address.</para>
</wadl:doc>
<request>
<param name="addFloatingIp" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Add floating IP action"
><para>Specify the <code>addFloatingIP</code>
action in the request body.</para></wadl:doc>
</param>
<param name="fixed_address" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Fixed address"><para>A fixed
IP address that you want to associate with the
floating IP address.</para></wadl:doc>
</param>
<param name="address" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Floating IP address"><para>A
floating IP address to associate with the
instance.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -722,8 +719,31 @@
href="../api_samples/os-admin-actions/admin-actions-add-floating-ip.json"
/>
</wadl:doc>
<param name="addFloatingIp" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Add floating IP action"
><para>Specify the
<code>addFloatingIP</code> action in
the request body.</para></wadl:doc>
</param>
<param name="fixed_address" style="plain"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Fixed address"><para>A
fixed IP address that you want to
associate with the floating IP
address.</para></wadl:doc>
</param>
<param name="address" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Floating IP address"
><para>A floating IP address to associate
with the instance.</para></wadl:doc>
</param>
</representation>
<!-- <representation mediaType="application/xml">
<!-- <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Add floating IP address: XML request">

8
api-ref/src/wadls/compute-api/src/v2/ext/os-agents.wadl
View File

@@ -1,10 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:db="http://docbook.org/ns/docbook"
xmlns:common="http://docs.openstack.org/common/api/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
<resources base="https://servers.api.openstack.com"
xml:id="os-agents-v2">
<resource id="version" type="#VersionDetails" path="//v2">

98
api-ref/src/wadls/compute-api/src/v2/ext/os-aggregates.wadl
View File

@@ -1,10 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
xmlns:db="http://docbook.org/ns/docbook"
xmlns:common="http://docs.openstack.org/common/api/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
<resources base="https://servers.api.openstack.com"
xml:id="os-aggregates-v2">
<resource id="version" path="//v2">
@@ -71,18 +73,6 @@
<para role="shortdesc">Creates an aggregate.</para>
</wadl:doc>
<request>
<param name="name" style="plain" required="true"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Name of
aggregate</para></wadl:doc>
</param>
<param name="availability_zone" style="plain"
required="true" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Availability zone of
aggregate</para></wadl:doc>
</param>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -98,6 +88,18 @@
href="../api_samples/os-aggregates/aggregate-post-req.json"
/>
</wadl:doc>
<param name="name" style="plain" required="true"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Name of
aggregate</para></wadl:doc>
</param>
<param name="availability_zone" style="plain"
required="true" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Availability zone of
aggregate</para></wadl:doc>
</param>
</representation>
</request>
<response status="200">
@@ -159,18 +161,7 @@
aggregate.</para>
</wadl:doc>
<request>
<param name="name" style="plain" required="true"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Name of
aggregate.</para></wadl:doc>
</param>
<param name="availability_zone" style="plain"
required="true" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Availability zone of
aggregate.</para></wadl:doc>
</param>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -186,6 +177,18 @@
href="../api_samples/os-aggregates/aggregate-update-post-req.json"
/>
</wadl:doc>
<param name="name" style="plain" required="true"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Name of
aggregate.</para></wadl:doc>
</param>
<param name="availability_zone" style="plain"
required="true" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Availability zone of
aggregate.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200">
@@ -224,12 +227,7 @@
aggregate.</para>
</wadl:doc>
<request>
<param name="metadata" style="plain" required="true"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Metadata value to be
set.</para></wadl:doc>
</param>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -237,6 +235,12 @@
href="../api_samples/os-aggregates/aggregate-metadata-post-req.xml"
/>
</wadl:doc>
<param name="metadata" style="plain" required="true"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Metadata value to be
set.</para></wadl:doc>
</param>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -272,14 +276,7 @@
<para role="shortdesc">Adds a host to an aggregate.</para>
</wadl:doc>
<request>
<param name="host" style="plain" required="true"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Host ID to add to an
aggregate, which is a collection of multiple
groups of hosts that share common resources
like storage and network.</para></wadl:doc>
</param>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -287,6 +284,15 @@
href="../api_samples/os-aggregates/aggregate-add-host-post-req.xml"
/>
</wadl:doc>
<param name="host" style="plain" required="true"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Host ID to add to an
aggregate, which is a collection of
multiple groups of hosts that share common
resources like storage and
network.</para></wadl:doc>
</param>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -323,12 +329,6 @@
aggregate.</para>
</wadl:doc>
<request>
<param name="host" style="plain" required="true"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Host ID to add to an
aggregate.</para></wadl:doc>
</param>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -336,6 +336,12 @@
href="../api_samples/os-aggregates/aggregate-remove-host-post-req.xml"
/>
</wadl:doc>
<param name="host" style="plain" required="true"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Host ID to add to an
aggregate.</para></wadl:doc>
</param>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"

204
api-ref/src/wadls/compute-api/src/v2/ext/os-block-device-mapping-v2-boot.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
@@ -12,8 +12,10 @@
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:db="http://docbook.org/ns/docbook"
xmlns:common="http://docs.openstack.org/common/api/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
<grammars>
<include href="../xsd/api.xsd"/>
<include href="../xsd/api-common.xsd"/>
@@ -68,75 +70,7 @@
<para role="shortdesc">Creates a server with a block
device mapping.</para>
</wadl:doc>
<request> &serverCreateParameters; <param
name="block_device_mapping_v2" style="plain"
required="true" type="csapi:blockDeviceMapping"
path="/csapi:server">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="block_device_mapping_v2">
<para>block_device_mapping_v2.</para>
</wadl:doc>
</param>
<param name="device_name" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A device name where the volume is attached
in the system at /dev/dev_name. This value is
typically vda.</para>
</wadl:doc>
</param>
<param name="source_type" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Either <code>snap</code> or any other value,
including a blank string. <code>snap</code>
means that the volume was created from a
snapshot.</para>
</wadl:doc>
</param>
<param name="destination_type" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Either <code>snap</code> or any other value,
including a blank string. <code>snap</code>
means that the volume was created from a
snapshot.</para>
</wadl:doc>
</param>
<param name="delete_on_termination" style="plain"
type="xsd:bool" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Set to True (or 1) to delete the volume when
the instance is deleted. Set to False (or 0)
to retain the volume when the instance is
deleted.</para>
</wadl:doc>
</param>
<param name="guest_format" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Guest format.</para>
</wadl:doc>
</param>
<param name="uuid" style="plain" type="csapi:uuid"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The device ID.</para>
</wadl:doc>
</param>
<param name="boot_index" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The boot index.</para>
</wadl:doc>
</param>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -152,11 +86,79 @@
<xsdxt:code
href="../api_samples/os-block-device-mapping-v2-boot/server-post-req.xml"
/>
</wadl:doc>
</wadl:doc> &serverCreateParameters; <param
name="block_device_mapping_v2" style="plain"
required="true" type="csapi:blockDeviceMapping"
path="/csapi:server">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="block_device_mapping_v2">
<para>block_device_mapping_v2.</para>
</wadl:doc>
</param>
<param name="device_name" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A device name where the volume is
attached in the system at /dev/dev_name.
This value is typically vda.</para>
</wadl:doc>
</param>
<param name="source_type" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Either <code>snap</code> or any other
value, including a blank string.
<code>snap</code> means that the
volume was created from a snapshot.</para>
</wadl:doc>
</param>
<param name="destination_type" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Either <code>snap</code> or any other
value, including a blank string.
<code>snap</code> means that the
volume was created from a snapshot.</para>
</wadl:doc>
</param>
<param name="delete_on_termination" style="plain"
type="xsd:bool" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Set to True (or 1) to delete the volume
when the instance is deleted. Set to False
(or 0) to retain the volume when the
instance is deleted.</para>
</wadl:doc>
</param>
<param name="guest_format" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Guest format.</para>
</wadl:doc>
</param>
<param name="uuid" style="plain" type="csapi:uuid"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The device ID.</para>
</wadl:doc>
</param>
<param name="boot_index" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The boot index.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202"> &serverCreateParameters; <representation
mediaType="application/json">
<response status="202">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
@@ -171,8 +173,7 @@
<xsdxt:code
href="../api_samples/os-block-device-mapping-v2-boot/server-post-resp.xml"
/>
</wadl:doc>
</representation>
</wadl:doc> &serverCreateParameters; </representation>
</response>
<response status="422">
<representation mediaType="application/json"/>
@@ -187,30 +188,11 @@
<para role="shortdesc">Lists IDs, names, and links for all
servers.</para>
</wadl:doc>
<request> &serverListQueryParameters; </request>
<request>
<representation mediaType="application/xml">
&serverListQueryParameters; </representation>
</request>
<response status="200 203">
<param name="servers" style="plain" required="true"
type="csapi:ServersWithOnlyIDsNamesLinks"
path="/csapi:servers/atom:link[@rel='servers']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>List of servers.</para>
</wadl:doc>
<link resource_type="#ServerList" rel="servers"/>
</param>
<param name="next" style="plain" type="xsd:anyURI"
path="/csapi:servers/atom:link[@rel='next']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the next item in the
list.</para></wadl:doc>
<link resource_type="#ServerList" rel="next"/>
</param>
<param name="previous" style="plain" type="xsd:anyURI"
path="/csapi:servers/atom:link[@rel='previous']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the previous item in
the list.</para></wadl:doc>
<link resource_type="#ServerList" rel="previous"/>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -224,6 +206,28 @@
xml:lang="EN"><xsdxt:code
href="../api_samples/servers-list-resp.xml"/>
</wadl:doc>
<param name="servers" style="plain" required="true"
type="csapi:ServersWithOnlyIDsNamesLinks"
path="/csapi:servers/atom:link[@rel='servers']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>List of servers.</para>
</wadl:doc>
<link resource_type="#ServerList" rel="servers"/>
</param>
<param name="next" style="plain" type="xsd:anyURI"
path="/csapi:servers/atom:link[@rel='next']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the next item in
the list.</para></wadl:doc>
<link resource_type="#ServerList" rel="next"/>
</param>
<param name="previous" style="plain" type="xsd:anyURI"
path="/csapi:servers/atom:link[@rel='previous']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the previous item
in the list.</para></wadl:doc>
<link resource_type="#ServerList" rel="previous"/>
</param>
</representation>
</response>
<!-- Common Faults --> &commonFaults; </method>

6
api-ref/src/wadls/compute-api/src/v2/ext/os-certificates.wadl
View File

@@ -1,9 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:db="http://docbook.org/ns/docbook"
xmlns:common="http://docs.openstack.org/common/api/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
<resources base="https://servers.api.openstack.com"
xml:id="os-certificates-v2">

54
api-ref/src/wadls/compute-api/src/v2/ext/os-cloudpipe.wadl
View File

@@ -1,10 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:db="http://docbook.org/ns/docbook"
xmlns:common="http://docs.openstack.org/common/api/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
<resources base="https://servers.api.openstack.com"
xml:id="os-cloudpipe-v2">
<resource id="version" type="#VersionDetails" path="//v2">
@@ -57,15 +59,6 @@
<para role="shortdesc">Creates a cloudpipe.</para>
</wadl:doc>
<request>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="project_id" style="query" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Creates the cloudpipe for the
specified project ID. If omitted, the project
ID defaults to the calling
tenant.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -81,6 +74,15 @@
href="../api_samples/os-cloudpipe/cloud-pipe-create-req.xml"
/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="project_id" style="query" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Creates the cloudpipe for
the specified project ID. If omitted, the
project ID defaults to the calling
tenant.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200">
@@ -110,20 +112,6 @@
instance.</para>
</wadl:doc>
<request>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="vpn_ip" style="header" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The VPN IP
address.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="vpn_port" style="header" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The VPN
port.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -139,6 +127,20 @@
href="../api_samples/os-cloudpipe-update/cloud-pipe-update-req.xml"
/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="vpn_ip" style="header" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The VPN IP
address.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="vpn_port" style="header" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The VPN
port.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202"/>

41
api-ref/src/wadls/compute-api/src/v2/ext/os-console-output.wadl
View File

@@ -1,10 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:db="http://docbook.org/ns/docbook"
xmlns:common="http://docs.openstack.org/common/api/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
<resources base="https://servers.api.openstack.com"
xml:id="os-console-output-v2">
<resource id="version" type="#VersionDetails" path="//v2">
@@ -43,22 +45,6 @@
instance.</para>
</wadl:doc>
<request>
<param name="os-getConsoleOutput" style="plain"
type="xsd:string" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Get console output action"
><para>Specify the
<code>os-getConsoleOutput</code> action in
the request body.</para></wadl:doc>
</param>
<param name="length" style="plain">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Length">
<para>Number of lines to fetch from the end of
console log.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -76,6 +62,23 @@
href="../api_samples/os-console-output/console-output-post-req.xml"
/>
</wadl:doc>
<param name="os-getConsoleOutput" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Get console output action"
><para>Specify the
<code>os-getConsoleOutput</code>
action in the request
body.</para></wadl:doc>
</param>
<param name="length" style="plain">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Length">
<para>Number of lines to fetch from the end of
console log.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">

38
api-ref/src/wadls/compute-api/src/v2/ext/os-consoles.wadl
View File

@@ -1,10 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:db="http://docbook.org/ns/docbook"
xmlns:common="http://docs.openstack.org/common/api/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
<resources base="https://servers.api.openstack.com"
xml:id="os-consoles-v2">
<resource id="version" type="#VersionDetails" path="//v2">
@@ -42,21 +44,6 @@
instance.</para>
</wadl:doc>
<request>
<param name="getConsole" style="plain" type="xsd:string"
required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Get console action"
><para>Specify the <code>getConsole</code>
action in the request body.</para></wadl:doc>
</param>
<param name="type" style="plain" required="true"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Type"><para>Valid values are
<code>novnc</code> and
<code>xvpvnc</code>.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Get console: JSON request">
@@ -72,6 +59,21 @@
href="../api_samples/os-consoles/get-vnc-console-post-req.xml"
/>
</wadl:doc>
<param name="getConsole" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Get console action"
><para>Specify the <code>getConsole</code>
action in the request
body.</para></wadl:doc>
</param>
<param name="type" style="plain" required="true"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Type"><para>Valid values
are <code>novnc</code> and
<code>xvpvnc</code>.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200">

127
api-ref/src/wadls/compute-api/src/v2/ext/os-coverage.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@@ -33,29 +33,6 @@
<para role="shortdesc">Generates a coverage report.</para>
</wadl:doc>
<request>
<param name="file" style="plain" type="csapi:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="name">
<para>The file name for the report.</para>
</wadl:doc>
</param>
<param name="xml" style="plain" type="csapi:bool"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="xml">
<para>Set to true to generate the report in XML
format.</para>
</wadl:doc>
</param>
<param name="html" style="plain" type="csapi:bool"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="html">
<para>Set to true to generate the report in HTML
format.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -73,16 +50,33 @@
href="../api_samples/os-coverage/coverage-xml-report-post-req.xml"
/>
</wadl:doc>
<param name="file" style="plain" type="csapi:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="name">
<para>The file name for the report.</para>
</wadl:doc>
</param>
<param name="xml" style="plain" type="csapi:bool"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="xml">
<para>Set to true to generate the report in
XML format.</para>
</wadl:doc>
</param>
<param name="html" style="plain" type="csapi:bool"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="html">
<para>Set to true to generate the report in
HTML format.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
<param name="path" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The path to the report file.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -98,6 +92,13 @@
href="../api_samples/os-coverage/coverage-xml-report-post-resp.xml"
/>
</wadl:doc>
<param name="path" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The path to the report file.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
@@ -108,14 +109,6 @@
reporting.</para>
</wadl:doc>
<request>
<param name="start" style="plain" type="csapi:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Specify <code>start</code> in the request
body.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -131,6 +124,14 @@
href="../api_samples/os-coverage/coverage-start-post-req.xml"
/>
</wadl:doc>
<param name="start" style="plain" type="csapi:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Specify <code>start</code> in the
request body.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
@@ -144,22 +145,6 @@
report.</para>
</wadl:doc>
<request>
<param name="start" style="plain" type="csapi:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Specify <code>start</code> in the request
body.</para>
</wadl:doc>
</param>
<param name="combine" style="plain" type="csapi:bool"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Set to true to generate a combined report
for all services.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -177,6 +162,22 @@
href="../api_samples/os-coverage/coverage-start-combine-post-req.xml"
/>
</wadl:doc>
<param name="start" style="plain" type="csapi:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Specify <code>start</code> in the
request body.</para>
</wadl:doc>
</param>
<param name="combine" style="plain" type="csapi:bool"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Set to true to generate a combined
report for all services.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200"/>
@@ -187,14 +188,6 @@
<para role="shortdesc">Stops coverage reporting.</para>
</wadl:doc>
<request>
<param name="stop" style="plain" type="csapi:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Specify <code>stop</code> in the request
body.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -210,6 +203,14 @@
href="../api_samples/os-coverage/coverage-stop-post-req.xml"
/>
</wadl:doc>
<param name="stop" style="plain" type="csapi:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Specify <code>stop</code> in the request
body.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202">

55
api-ref/src/wadls/compute-api/src/v2/ext/os-createserverext.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
@@ -43,13 +43,7 @@
<para role="shortdesc">Creates a server with the
configuration drive extended attribute.</para>
</wadl:doc>
<request> &serverCreateParameters; <param name="config_drive"
style="plain" type="csapi:UUID" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>ID of image to mount within
server as a configuration
drive.</para></wadl:doc>
</param>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -64,7 +58,14 @@
<xsdxt:code
href="../api_samples/os-config-drive/server-post-req.xml"
/>
</wadl:doc>
</wadl:doc>&serverCreateParameters; <param
name="config_drive" style="plain"
type="csapi:UUID" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>ID of image to mount
within server as a configuration
drive.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202"> &serverCreateParameters;
@@ -93,14 +94,7 @@
server including the configuration drive extended
attribute.</para>
</wadl:doc>
<response status="202"> &serverCreateParameters; <param
name="config_drive" style="plain" type="csapi:UUID"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The ID of the image to mount
on the server as a configuration
drive.</para></wadl:doc>
</param>
<response status="202">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -115,7 +109,14 @@
<xsdxt:code
href="../api_samples/os-config-drive/server-config-drive-get-resp.xml"
/>
</wadl:doc>
</wadl:doc> &serverCreateParameters; <param
name="config_drive" style="plain"
type="csapi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The ID of the image to
mount on the server as a configuration
drive.</para></wadl:doc>
</param>
</representation>
</response>
</method>
@@ -126,14 +127,7 @@
including the configuration drive extended
attribute.</para>
</wadl:doc>
<response status="202"> &serverCreateParameters; <param
name="config_drive" style="plain" type="csapi:UUID"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The ID of the image to mount
on the server as a configuration
drive.</para></wadl:doc>
</param>
<response status="202">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -148,7 +142,14 @@
<xsdxt:code
href="../api_samples/os-config-drive/servers-config-drive-details-resp.xml"
/>
</wadl:doc>
</wadl:doc> &serverCreateParameters; <param
name="config_drive" style="plain"
type="csapi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The ID of the image to
mount on the server as a configuration
drive.</para></wadl:doc>
</param>
</representation>
</response>
</method>

35
api-ref/src/wadls/compute-api/src/v2/ext/os-deferred-delete.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"
@@ -42,14 +42,7 @@
<para role="shortdesc">Force-deletes a server.</para>
</wadl:doc>
<request>
<param name="forceDelete" style="plain" type="xsd:string"
required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Force delete action"
><para>Specify the <code>forceDelete</code>
action in the request body.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -67,6 +60,14 @@
href="../api_samples/os-deferred-delete/force-delete-post-req.xml"
/>
</wadl:doc>
<param name="forceDelete" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Force delete action"
><para>Specify the
<code>forceDelete</code> action in the
request body.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
@@ -77,14 +78,6 @@
<para role="shortdesc">Restores a deleted server.</para>
</wadl:doc>
<request>
<param name="restore" style="plain" type="xsd:string"
required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Restore action"><para>Specify
the <code>restore</code> action in the request
body.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Restore server: JSON request">
@@ -100,6 +93,14 @@
href="../api_samples/os-deferred-delete/restore-post-req.xml"
/>
</wadl:doc>
<param name="restore" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Restore action"
><para>Specify the <code>restore</code>
action in the request
body.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202"/>

2
api-ref/src/wadls/compute-api/src/v2/ext/os-diagnostics.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"

81
api-ref/src/wadls/compute-api/src/v2/ext/os-disk-config.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
@@ -74,13 +74,7 @@
title="Create server">
<para role="shortdesc">Creates a server.</para>
</wadl:doc>
<request> &serverCreateParameters; <param
name="OS-DCF:diskConfig" style="plain">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A valid value is AUTO or MANUAL.</para>
</wadl:doc>
</param>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -95,11 +89,17 @@
<xsdxt:code
href="../api_samples/OS-DCF/server-post-req.xml"
/>
</wadl:doc>
</wadl:doc>&serverCreateParameters; <param
name="OS-DCF:diskConfig" style="plain">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A valid value is AUTO or MANUAL.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202"> <!--&serverCreateParameters;-->
<representation mediaType="application/json">
<response status="202">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
@@ -113,8 +113,7 @@
<xsdxt:code
href="../api_samples/OS-DCF/server-post-resp.xml"
/>
</wadl:doc>
</representation>
</wadl:doc> &serverCreateParameters; </representation>
</response>
</method>
<method name="PUT" id="updateServer">
@@ -233,13 +232,6 @@
server.</para>
</wadl:doc>
<response status="200">
<param name="OS-DCF:diskConfig" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Valid value is AUTO or
MANUAL.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -255,6 +247,13 @@
href="../api_samples/OS-DCF/server-get-resp.xml"
/>
</wadl:doc>
<param name="OS-DCF:diskConfig" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Valid value is AUTO or
MANUAL.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
@@ -264,13 +263,6 @@
<para role="shortdesc">Lists servers.</para>
</wadl:doc>
<response status="200">
<param name="OS-DCF:diskConfig" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Valid value is AUTO or
MANUAL.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -286,6 +278,13 @@
href="../api_samples/OS-DCF/list-servers-detail-get.xml"
/>
</wadl:doc>
<param name="OS-DCF:diskConfig" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Valid value is AUTO or
MANUAL.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
@@ -296,13 +295,6 @@
image.</para>
</wadl:doc>
<response status="200">
<param name="OS-DCF:diskConfig" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Valid value is AUTO or
MANUAL.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -318,6 +310,13 @@
href="../api_samples/OS-DCF/image-get-resp.xml"
/>
</wadl:doc>
<param name="OS-DCF:diskConfig" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Valid value is AUTO or
MANUAL.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
@@ -327,13 +326,6 @@
<para role="shortdesc">Lists images.</para>
</wadl:doc>
<response status="200">
<param name="OS-DCF:diskConfig" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Valid value is AUTO or
MANUAL.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -349,6 +341,13 @@
href="../api_samples/OS-DCF/image-list-resp.xml"
/>
</wadl:doc>
<param name="OS-DCF:diskConfig" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Valid value is AUTO or
MANUAL.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>

4
api-ref/src/wadls/compute-api/src/v2/ext/os-ext-az.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
@@ -14,7 +14,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The ID for the tenant or
account in a multi-tenancy cloud.
</para></wadl:doc>
</para></wadl:doc>
</param>
<resource id="Servers" path="servers">
<resource path="{server_id}" id="server_id">

2
api-ref/src/wadls/compute-api/src/v2/ext/os-ext-img-size.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"

9
api-ref/src/wadls/compute-api/src/v2/ext/os-ext-ips.wadl
View File

@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
@@ -65,12 +63,11 @@
</representation>
</response>
</method>
<method name="GET" id="serversIPList">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List servers with IP type">
<para role="shortdesc">Lists all servers showing their IPs
by type, either fixed or floating.</para>
<para role="shortdesc">Lists servers and shows their IPs
by type. Type is either fixed or floating.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">

2
api-ref/src/wadls/compute-api/src/v2/ext/os-extended-server-attributes.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"

5
api-ref/src/wadls/compute-api/src/v2/ext/os-extended-status.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
@@ -69,7 +69,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List extended status for servers">
<para role="shortdesc">Lists the extended status
attributes in the detailed response for all servers.</para>
attributes in the detailed response for all
servers.</para>
<para>The extended status attributes are vm_state,
power_state, and task_state.</para>
</wadl:doc>

4
api-ref/src/wadls/compute-api/src/v2/ext/os-fixed-ips.wadl
View File

@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"

195
api-ref/src/wadls/compute-api/src/v2/ext/os-flavor-access.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
@@ -53,13 +53,7 @@
<para role="shortdesc">Lists flavors and includes the
access type, which is public or private.</para>
</wadl:doc>
<response status="200"> &flavorRespParameters; <param
name="os-flavor-access:is_public" style="plain"
required="true" type="xsd:Boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Set to true if access is
public.</para></wadl:doc>
</param>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -74,7 +68,13 @@
<xsdxt:code
href="../api_samples/os-flavor-access/flavor-access-detail-resp.xml"
/>
</wadl:doc>
</wadl:doc>&flavorRespParameters; <param
name="os-flavor-access:is_public" style="plain"
required="true" type="xsd:Boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Set to true if access is
public.</para></wadl:doc>
</param>
</representation>
</response>
</method>
@@ -83,14 +83,7 @@
title="Create private flavor">
<para role="shortdesc">Creates a private flavor.</para>
</wadl:doc>
<request> &flavorReqParameters; <param
name="os-flavor-access:is_public" style="plain"
required="true" type="xsd:Boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Set to true if access is
public. Set to false if access is
private.</para></wadl:doc>
</param>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -105,16 +98,17 @@
<xsdxt:code
href="../api_samples/os-flavor-access/flavor-access-create-req.xml"
/>
</wadl:doc>
</wadl:doc>&flavorReqParameters; <param
name="os-flavor-access:is_public" style="plain"
required="true" type="xsd:Boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Set to true if access is
public. Set to false if access is
private.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200"> &flavorRespParameters; <param
name="os-flavor-access:is_public" style="plain"
required="true" type="xsd:Boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Set to true if access is
public.</para></wadl:doc>
</param>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -129,7 +123,13 @@
<xsdxt:code
href="../api_samples/os-flavor-access/flavor-access-create-resp.xml"
/>
</wadl:doc>
</wadl:doc>&flavorRespParameters; <param
name="os-flavor-access:is_public" style="plain"
required="true" type="xsd:Boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Set to true if access is
public.</para></wadl:doc>
</param>
</representation>
</response>
</method>
@@ -139,13 +139,7 @@
<para role="shortdesc">Gets the flavor access type, which
is public or private.</para>
</wadl:doc>
<response status="200"> &flavorRespParameters; <param
name="os-flavor-access:is_public" style="plain"
required="true" type="xsd:Boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Set to true if access is
public.</para></wadl:doc>
</param>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -160,7 +154,13 @@
<xsdxt:code
href="../api_samples/os-flavor-access/flavor-access-show-resp.xml"
/>
</wadl:doc>
</wadl:doc>&flavorRespParameters; <param
name="os-flavor-access:is_public" style="plain"
required="true" type="xsd:Boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Set to true if access is
public.</para></wadl:doc>
</param>
</representation>
</response>
</method>
@@ -171,18 +171,7 @@
specified private flavor.</para>
</wadl:doc>
<response status="200">
<param name="flavor_id" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The flavor
ID.</para></wadl:doc>
</param>
<param name="tenant_id" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The tenant
ID.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -198,6 +187,18 @@
href="../api_samples/os-flavor-access/flavor-access-list-resp.xml"
/>
</wadl:doc>
<param name="flavor_id" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The flavor
ID.</para></wadl:doc>
</param>
<param name="tenant_id" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The tenant
ID.</para></wadl:doc>
</param>
</representation>
</response>
</method>
@@ -208,19 +209,6 @@
the specified private flavor.</para>
</wadl:doc>
<request>
<param name="addTenantAccess" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Specify the
<code>addTenantAccess</code>
action.</para></wadl:doc>
</param>
<param name="tenant" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The name of the tenant to
which to give access.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -236,21 +224,23 @@
href="../api_samples/os-flavor-access/flavor-access-add-tenant-req.xml"
/>
</wadl:doc>
<param name="addTenantAccess" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Specify the
<code>addTenantAccess</code>
action.</para></wadl:doc>
</param>
<param name="tenant" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The name of the tenant to
which to give access.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200">
<param name="flavor_id" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The flavor
ID.</para></wadl:doc>
</param>
<param name="tenant_id" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The tenant
ID.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -266,6 +256,18 @@
href="../api_samples/os-flavor-access/flavor-access-add-tenant-resp.xml"
/>
</wadl:doc>
<param name="flavor_id" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The flavor
ID.</para></wadl:doc>
</param>
<param name="tenant_id" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The tenant
ID.</para></wadl:doc>
</param>
</representation>
</response>
</method>
@@ -276,19 +278,6 @@
tenant for the specified private flavor.</para>
</wadl:doc>
<request>
<param name="removeTenantAccess" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Specify the
<code>removeTenantAccess</code>
action.</para></wadl:doc>
</param>
<param name="tenant" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The name of the tenant from
which to revoke access.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -304,21 +293,23 @@
href="../api_samples/os-flavor-access/flavor-access-remove-tenant-req.xml"
/>
</wadl:doc>
<param name="removeTenantAccess" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Specify the
<code>removeTenantAccess</code>
action.</para></wadl:doc>
</param>
<param name="tenant" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The name of the tenant
from which to revoke
access.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200">
<param name="flavor_id" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The flavor
ID.</para></wadl:doc>
</param>
<param name="tenant_id" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The tenant
ID.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -334,6 +325,18 @@
href="../api_samples/os-flavor-access/flavor-access-remove-tenant-resp.xml"
/>
</wadl:doc>
<param name="flavor_id" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The flavor
ID.</para></wadl:doc>
</param>
<param name="tenant_id" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The tenant
ID.</para></wadl:doc>
</param>
</representation>
</response>
</method>

10
api-ref/src/wadls/compute-api/src/v2/ext/os-flavor-extra-specs.wadl
View File

@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
@@ -25,7 +23,7 @@
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The ID of the
flavor of interest to you.
</para></wadl:doc>
</para></wadl:doc>
</param>
<resource path="os-extra_specs"
id="os-extra-specs">
@@ -69,7 +67,6 @@
</representation>
</response>
</method>
<method name="POST" id="createExtra-specs">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create flavor extra specs">
@@ -113,7 +110,6 @@
</representation>
</response>
</method>
<method name="PUT" id="updateDetailExtra-specs">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update flavor extra specs">
@@ -157,7 +153,6 @@
</representation>
</response>
</method>
<method name="GET" id="detailExtra-spec">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get flavor extra spec details">
@@ -183,7 +178,6 @@
</representation>
</response>
</method>
<method name="DELETE" id="deleteDetailExtra-spec">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete flavor extra specs">

2
api-ref/src/wadls/compute-api/src/v2/ext/os-flavor-rxtx.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"

112
api-ref/src/wadls/compute-api/src/v2/ext/os-flavorextradata.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
@@ -43,57 +43,7 @@
extended attributes.</para>
</wadl:doc>
<request>
<param style="plain" name="name" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The name for the flavor.</para></wadl:doc>
</param>
<param style="plain" name="ram" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The amount of RAM, in MBs, for
the flavor.</para></wadl:doc>
</param>
<param style="plain" name="vcpus" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The virtual CPUs, in a whole
integer amount, for the
flavor.</para></wadl:doc>
</param>
<param style="plain" name="disk" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The amount of disk space, in
GBs, for the flavor.</para></wadl:doc>
</param>
<param style="plain" name="id" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The ID, a unique integer
value, for the flavor.</para></wadl:doc>
</param>
<param style="plain" name="rxtx_factor" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Enables you to override the
bandwidth cap value, which defaults to the
bandwidth cap value for the network to which
the flavor is attached. The new bandwidth cap
is calculated by multiplying the rxtx_factor
valued that you specify by the rxtx_base
property for the network.</para></wadl:doc>
</param>
<param style="plain" name="OS-FLV-EXT-DATA:ephemeral"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The size of secondary drive, in GBs, to
attach to a server.</para>
</wadl:doc>
</param>
<param style="plain" name="swap" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The amount of swap disk space, in GBs, to
allocate to a server.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -109,6 +59,60 @@
href="../api_samples/OS-FLV-EXT-DATA/flavors-extra-data-post-req.xml"
/>
</wadl:doc>
<param style="plain" name="name" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The name for the
flavor.</para></wadl:doc>
</param>
<param style="plain" name="ram" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The amount of RAM, in MBs,
for the flavor.</para></wadl:doc>
</param>
<param style="plain" name="vcpus" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The virtual CPUs, in a
whole integer amount, for the
flavor.</para></wadl:doc>
</param>
<param style="plain" name="disk" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The amount of disk space,
in GBs, for the flavor.</para></wadl:doc>
</param>
<param style="plain" name="id" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The ID, a unique integer
value, for the flavor.</para></wadl:doc>
</param>
<param style="plain" name="rxtx_factor"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Enables you to override
the bandwidth cap value, which defaults to
the bandwidth cap value for the network to
which the flavor is attached. The new
bandwidth cap is calculated by multiplying
the rxtx_factor valued that you specify by
the rxtx_base property for the
network.</para></wadl:doc>
</param>
<param style="plain" name="OS-FLV-EXT-DATA:ephemeral"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The size of secondary drive, in GBs, to
attach to a server.</para>
</wadl:doc>
</param>
<param style="plain" name="swap" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The amount of swap disk space, in GBs,
to allocate to a server.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
@@ -147,8 +151,6 @@
/>
</wadl:doc>
</representation>
</response>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -175,8 +177,6 @@
/>
</wadl:doc>
</representation>
</response>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">

73
api-ref/src/wadls/compute-api/src/v2/ext/os-flavormanage.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
@@ -36,47 +36,12 @@
</resource>
</resource>
</resources>
<method name="POST" id="createFlavor">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create flavor">
<para role="shortdesc">Creates a flavor.</para>
</wadl:doc>
<request>
<param style="plain" name="name" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The name for the new flavor.</para>
</wadl:doc>
</param>
<param style="plain" name="ram" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The amount of RAM, in MBs, for this
flavor.</para>
</wadl:doc>
</param>
<param style="plain" name="vcpus" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The virtual CPUs, in a whole integer amount,
for the new flavor.</para>
</wadl:doc>
</param>
<param style="plain" name="disk" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The amount of disk space, in GBs.</para>
</wadl:doc>
</param>
<param style="plain" name="id" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The ID for the new flavor, which is a unique
integer value.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -92,9 +57,41 @@
href="../api_samples/os-flavor-manage/flavor-create-post-req.xml"
/>
</wadl:doc>
<param style="plain" name="name" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The name for the new flavor.</para>
</wadl:doc>
</param>
<param style="plain" name="ram" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The amount of RAM, in MBs, for this
flavor.</para>
</wadl:doc>
</param>
<param style="plain" name="vcpus" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The virtual CPUs, in a whole integer
amount, for the new flavor.</para>
</wadl:doc>
</param>
<param style="plain" name="disk" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The amount of disk space, in GBs.</para>
</wadl:doc>
</param>
<param style="plain" name="id" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The ID for the new flavor, which is a
unique integer value.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -114,7 +111,6 @@
</representation>
</response>
</method>
<method name="DELETE" id="deleteFlavor">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete flavor">
@@ -122,7 +118,6 @@
</wadl:doc>
<response status="204"/>
</method>
<method name="GET" id="listFlavors">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List flavors">

2
api-ref/src/wadls/compute-api/src/v2/ext/os-floating-ip-dns.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"

4
api-ref/src/wadls/compute-api/src/v2/ext/os-floating-ip-pools.wadl
View File

@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"

36
api-ref/src/wadls/compute-api/src/v2/ext/os-floating-ips-bulk.wadl
View File

@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<resources base="https://servers.api.openstack.com"
xml:id="os-floating-ips-bulk-v2">
xml:id="os-floating-ips-bulk-v2">
<resource id="version" type="#VersionDetails" path="//v2">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template"
@@ -94,14 +94,6 @@
<para role="shortdesc">Bulk-creates floating IPs.</para>
</wadl:doc>
<request>
<param name="ip_range" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The range of IP addresses to use for
creating floating IPs.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -117,6 +109,14 @@
href="../api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.xml"
/>
</wadl:doc>
<param name="ip_range" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The range of IP addresses to use for
creating floating IPs.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
@@ -144,14 +144,6 @@
<para role="shortdesc">Bulk-deletes floating IPs.</para>
</wadl:doc>
<request>
<param name="ip_range" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The range of IP addresses from which to
bulk-delete floating IPs.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -167,6 +159,14 @@
href="../api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-req.xml"
/>
</wadl:doc>
<param name="ip_range" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The range of IP addresses from which to
bulk-delete floating IPs.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">

59
api-ref/src/wadls/compute-api/src/v2/ext/os-floating-ips.wadl
View File

@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
<resources base="https://servers.api.openstack.com"
xml:id="os-floating-ips-v2">
xml:id="os-floating-ips-v2">
<resource id="version" type="#VersionDetails" path="//v2">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template"
@@ -28,7 +28,7 @@
xml:lang="EN"><para>The unique
identifier associated with
allocated floating IP address.
</para></wadl:doc>
</para></wadl:doc>
</param>
<method href="#DetailFloatingIP"/>
<method href="#DeallocateFloatingIP"/>
@@ -85,13 +85,7 @@
to a tenant or account.</para>
</wadl:doc>
<request>
<param name="pool" style="plain">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Pool to allocate IP address from. Will use
default pool if not specified.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -107,6 +101,13 @@
href="../api_samples/os-floating-ips/floating-ips-create-req.xml"
/>
</wadl:doc>
<param name="pool" style="plain">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Pool to allocate IP address from. Will
use default pool if not specified.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
@@ -176,12 +177,6 @@
instance.</para>
</wadl:doc>
<request>
<param name="pool" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The pool to which to add the
floating IP address.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -197,6 +192,12 @@
href="../api_samples/os-floating-ips/floating-ips-add-req.xml"
/>
</wadl:doc>
<param name="pool" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The pool to which to add
the floating IP address.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
@@ -208,19 +209,6 @@
instance.</para>
</wadl:doc>
<request>
<param name="removeFloatingIp" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Specify the
<code>removeFloatingIp</code> action in
the request body.</para></wadl:doc>
</param>
<param name="address" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The floating IP address that
you want to remove.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -236,6 +224,19 @@
href="../api_samples/os-floating-ips/floating-ips-remove-req.xml"
/>
</wadl:doc>
<param name="removeFloatingIp" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Specify the
<code>removeFloatingIp</code> action
in the request body.</para></wadl:doc>
</param>
<param name="address" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The floating IP address
that you want to remove.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202"/>

6
api-ref/src/wadls/compute-api/src/v2/ext/os-flv-disabled.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@@ -52,8 +52,6 @@
/>
</wadl:doc>
</representation>
</response>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -80,8 +78,6 @@
/>
</wadl:doc>
</representation>
</response>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">

73
api-ref/src/wadls/compute-api/src/v2/ext/os-hosts.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
@@ -51,25 +51,27 @@
<para role="shortdesc">Lists hosts.</para>
</wadl:doc>
<request>
<param name="service" style="query" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Service name">
<para>The service name. To filter the returned
list by service name, specify
<code>?service={service}</code> in the
URI.</para>
</wadl:doc>
</param>
<param path="?zone={zone}" name="zone" style="query"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Zone">
<para>The zone. To filter the returned list by
zone, specify <code>?zone={zone}</code> in the
URI.</para>
</wadl:doc>
</param>
<representation mediaType="application/xml">
<param name="service" style="query" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Service name">
<para>The service name. To filter the returned
list by service name, specify
<code>?service={service}</code> in the
URI.</para>
</wadl:doc>
</param>
<param path="?zone={zone}" name="zone" style="query"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Zone">
<para>The zone. To filter the returned list by
zone, specify <code>?zone={zone}</code> in
the URI.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
@@ -97,20 +99,7 @@
maintenance mode.</para>
</wadl:doc>
<request>
<param name="status" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Status">
<para>Valid values are enable or disable.</para>
</wadl:doc>
</param>
<param name="maintenance_mode" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Maintenance mode">
<para>Valid values are enable or disable.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Update host: JSON request">
@@ -126,6 +115,22 @@
href="../api_samples/os-hosts/host-put-maintenance-req.xml"
/>
</wadl:doc>
<param name="status" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Status">
<para>Valid values are enable or
disable.</para>
</wadl:doc>
</param>
<param name="maintenance_mode" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Maintenance mode">
<para>Valid values are enable or
disable.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">

26
api-ref/src/wadls/compute-api/src/v2/ext/os-hypervisors.wadl
View File

@@ -52,19 +52,6 @@
API, such as libvirt or XenAPI.</para>
</wadl:doc>
<response status="200">
<param name="hypervisor_hostname" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Hypervisor host name,
retrieved from the per-server
listing.</para></wadl:doc>
</param>
<param name="id" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Hypervisor
ID.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -80,6 +67,19 @@
href="../api_samples/os-hypervisors/hypervisors-list-resp.xml"
/>
</wadl:doc>
<param name="hypervisor_hostname" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Hypervisor host name,
retrieved from the per-server
listing.</para></wadl:doc>
</param>
<param name="id" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Hypervisor
ID.</para></wadl:doc>
</param>
</representation>
</response>
</method>

8
api-ref/src/wadls/compute-api/src/v2/ext/os-instance-actions.wadl
View File

@@ -1,9 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
@@ -50,7 +48,7 @@
title="Get Action Details">
<para>The UUID of the action for
which you want to get details.
</para>
</para>
</wadl:doc>
</param>
<method href="#getActionDetails"/>
@@ -96,7 +94,7 @@
permissions for this request in the
<filename>policy.json</filename> file. By default,
only administrators can get details for an action.
</para></wadl:doc>
</para></wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"

4
api-ref/src/wadls/compute-api/src/v2/ext/os-instance_usage_audit_log.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
@@ -34,7 +34,7 @@
Defaults to the beginning of the most
recently completed audit period prior
to the <code>before</code> date.
</para>
</para>
</wadl:doc>
</param>
<param name="end" path="end={end}" style="query"

188
api-ref/src/wadls/compute-api/src/v2/ext/os-interface.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
@@ -44,9 +44,9 @@
<para>The interface ID.</para>
</wadl:doc>
</param>
<method href="#showAttachedInterface"
/>
<method href="#deleteAttachedInterface"/>
<method href="#showAttachedInterface"/>
<method
href="#deleteAttachedInterface"/>
</resource>
</resource>
</resource>
@@ -61,22 +61,6 @@
to attach the port to a server instance.</para>
</wadl:doc>
<request>
<param name="interfaceAttachment" style="plain"
type="xsd:string" required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>Specify the <code>interfaceAttachment</code>
action in the request body.</para>
</wadl:doc>
</param>
<param name="port_id" style="plain" type="csapi:uuid"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The ID of the port for which you want to
create an interface.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
@@ -92,45 +76,26 @@
href="../api_samples/os-attach-interfaces/attach-interfaces-create-req.xml"
/>
</wadl:doc>
<param name="interfaceAttachment" style="plain"
type="xsd:string" required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>Specify the
<code>interfaceAttachment</code>
action in the request body.</para>
</wadl:doc>
</param>
<param name="port_id" style="plain" type="csapi:uuid"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The ID of the port for which you want to
create an interface.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202">
<param name="fixed_ips" style="plain" type="xsd:string"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>Fixed IP addresses with subnet IDs.</para>
</wadl:doc>
</param>
<param name="mac_addr" style="plain" type="xsd:string"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The MAC address.</para>
</wadl:doc>
</param>
<param name="net_id" style="plain" type="csapi:uuid"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The network ID.</para>
</wadl:doc>
</param>
<param name="port_id" style="plain" type="csapi:uuid"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The port ID.</para>
</wadl:doc>
</param>
<param name="port_state" style="plain" type="xsd:string"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="Port state">
<para>The port state.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
@@ -146,6 +111,43 @@
href="../api_samples/os-attach-interfaces/attach-interfaces-create-resp.xml"
/>
</wadl:doc>
<param name="fixed_ips" style="plain"
type="xsd:string" required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>Fixed IP addresses with subnet
IDs.</para>
</wadl:doc>
</param>
<param name="mac_addr" style="plain" type="xsd:string"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The MAC address.</para>
</wadl:doc>
</param>
<param name="net_id" style="plain" type="csapi:uuid"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The network ID.</para>
</wadl:doc>
</param>
<param name="port_id" style="plain" type="csapi:uuid"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The port ID.</para>
</wadl:doc>
</param>
<param name="port_state" style="plain"
type="xsd:string" required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="Port state">
<para>The port state.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
@@ -155,41 +157,6 @@
<para role="shortdesc">Lists port interfaces.</para>
</wadl:doc>
<response status="202">
<param name="port_state" style="plain" type="xsd:string"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The port state.</para>
</wadl:doc>
</param>
<param name="fixed_ips" style="plain" type="xsd:string"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>Fixed IP addresses with subnet IDs.</para>
</wadl:doc>
</param>
<param name="mac_addr" style="plain" type="xsd:string"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The MAC address.</para>
</wadl:doc>
</param>
<param name="net_id" style="plain" type="csapi:uuid"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The network ID.</para>
</wadl:doc>
</param>
<param name="port_id" style="plain" type="csapi:uuid"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The port ID.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
@@ -205,6 +172,42 @@
href="../api_samples/os-attach-interfaces/attach-interfaces-list-resp.xml"
/>
</wadl:doc>
<param name="port_state" style="plain"
type="xsd:string" required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The port state.</para>
</wadl:doc>
</param>
<param name="fixed_ips" style="plain"
type="xsd:string" required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>Fixed IP addresses with subnet
IDs.</para>
</wadl:doc>
</param>
<param name="mac_addr" style="plain" type="xsd:string"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The MAC address.</para>
</wadl:doc>
</param>
<param name="net_id" style="plain" type="csapi:uuid"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The network ID.</para>
</wadl:doc>
</param>
<param name="port_id" style="plain" type="csapi:uuid"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The port ID.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
@@ -236,7 +239,8 @@
<method name="DELETE" id="deleteAttachedInterface">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Detach interface">
<para role="shortdesc">Detaches a specified port interface.</para>
<para role="shortdesc">Detaches a specified port
interface.</para>
</wadl:doc>
<response status="202"/>
</method>

38
api-ref/src/wadls/compute-api/src/v2/ext/os-keypairs.wadl
View File

@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
@@ -27,7 +25,7 @@
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The name
associated with a keypair.
</para></wadl:doc>
</para></wadl:doc>
</param>
<method href="#deleteKeypair"/>
<method href="#showKeypair"/>
@@ -61,7 +59,6 @@
</representation>
</response>
</method>
<method name="GET" id="showKeypair">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show keypair information">
@@ -79,7 +76,6 @@
</representation>
</response>
</method>
<method name="DELETE" id="deleteKeypair">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete keypair">
@@ -94,21 +90,6 @@
keypair.</para>
</wadl:doc>
<request>
<param name="name" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The name to associate with the
keypair.</para></wadl:doc>
</param>
<param name="public_key" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The public ssh key to import. If not
provided, a key is generated.
</para></wadl:doc>
</param>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -124,6 +105,21 @@
href="../api_samples/os-keypairs/keypairs-import-post-req.json"
/>
</wadl:doc>
<param name="name" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The name to associate with the
keypair.</para></wadl:doc>
</param>
<param name="public_key" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The public ssh key to import. If not
provided, a key is generated.
</para></wadl:doc>
</param>
</representation>
</request>
<response status="200">

146
api-ref/src/wadls/compute-api/src/v2/ext/os-migrations.wadl
View File

@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://docs.openstack.org/api/compute/2.0"
@@ -61,73 +59,6 @@
cell in a region.</para>
</wadl:doc>
<response status="200">
<param name="created_at" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"><para>The
created at time stamp.</para></wadl:doc>
</param>
<param name="dest_compute" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"><para>The
destination compute node.</para></wadl:doc>
</param>
<param name="dest_host" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"><para>The
destination host.</para></wadl:doc>
</param>
<param name="id" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"><para>The
migration ID.</para></wadl:doc>
</param>
<param name="instance_uuid" style="plain" required="true"
type="csapi:uuid">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"><para>The ID
of the instance being
migrated.</para></wadl:doc>
</param>
<param name="new_instance_type_id" style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"><para>The ID
of the new instance type.</para></wadl:doc>
</param>
<param name="old_instance_type_id" style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"><para>The ID
of the old instance type.</para></wadl:doc>
</param>
<param name="source_compute" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"><para>The
source compute node.</para></wadl:doc>
</param>
<param name="source_node" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"><para>The
source node.</para></wadl:doc>
</param>
<param name="status" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"><para>The
migration status.</para></wadl:doc>
</param>
<param name="updated_at" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"><para>The
updated at time stamp.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
@@ -143,6 +74,81 @@
href="../api_samples/os-migrations/migrations-get.xml"
/>
</wadl:doc>
<param name="created_at" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
><para>The created at time
stamp.</para></wadl:doc>
</param>
<param name="dest_compute" style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
><para>The destination compute
node.</para></wadl:doc>
</param>
<param name="dest_host" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
><para>The destination
host.</para></wadl:doc>
</param>
<param name="id" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
><para>The migration ID.</para></wadl:doc>
</param>
<param name="instance_uuid" style="plain"
required="true" type="csapi:uuid">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
><para>The ID of the instance being
migrated.</para></wadl:doc>
</param>
<param name="new_instance_type_id" style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
><para>The ID of the new instance
type.</para></wadl:doc>
</param>
<param name="old_instance_type_id" style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
><para>The ID of the old instance
type.</para></wadl:doc>
</param>
<param name="source_compute" style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
><para>The source compute
node.</para></wadl:doc>
</param>
<param name="source_node" style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
><para>The source node.</para></wadl:doc>
</param>
<param name="status" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
><para>The migration
status.</para></wadl:doc>
</param>
<param name="updated_at" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
><para>The updated at time
stamp.</para></wadl:doc>
</param>
</representation>
</response>
</method>

64
api-ref/src/wadls/compute-api/src/v2/ext/os-multi-server-create.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
@@ -40,31 +40,7 @@
<para role="shortdesc">Creates one or more servers with an
optional reservation ID.</para>
</wadl:doc>
<request> &serverCreateParameters; <param
name="return_reservation_id" style="query"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Set to <code>True</code>to
generate a reservation ID for each server.
Omit this attribute to create servers without
a reservation ID. This extended attribute is
enabled when the service provider enables
multiple server launch.</para></wadl:doc>
</param>
<param name="min_count" style="query" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The minimum number of servers
to launch when the service provider enables
multiple server launch.</para></wadl:doc>
</param>
<param name="max_count" style="query" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The maximum number of servers
to launch when the service provider enables
multiple server launch.</para></wadl:doc>
</param>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -79,7 +55,34 @@
<xsdxt:code
href="../api_samples/os-multiple-create/multiple-create-no-resv-post-req.xml"
/>
</wadl:doc>
</wadl:doc>&serverCreateParameters; <param
name="return_reservation_id" style="query"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Set to <code>True</code>to
generate a reservation ID for each server.
Omit this attribute to create servers
without a reservation ID. This extended
attribute is enabled when the service
provider enables multiple server
launch.</para></wadl:doc>
</param>
<param name="min_count" style="query" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The minimum number of
servers to launch when the service
provider enables multiple server
launch.</para></wadl:doc>
</param>
<param name="max_count" style="query" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The maximum number of
servers to launch when the service
provider enables multiple server
launch.</para></wadl:doc>
</param>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -98,8 +101,8 @@
</wadl:doc>
</representation>
</request>
<response status="202"> &serverCreateParameters;
<representation mediaType="application/json">
<response status="202">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
@@ -113,8 +116,7 @@
<xsdxt:code
href="../api_samples/os-multiple-create/multiple-create-no-resv-post-resp.xml"
/>
</wadl:doc>
</representation>
</wadl:doc> &serverCreateParameters; </representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">

215
api-ref/src/wadls/compute-api/src/v2/ext/os-networks.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
@@ -63,18 +63,20 @@
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-networks/networks-list-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-networks/networks-list-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -86,18 +88,20 @@
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-networks/network-show-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-networks/network-show-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -221,18 +225,20 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-networks/network-add-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-networks/network-add-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>
@@ -243,96 +249,6 @@
<para role="shortdesc">Creates a network.</para>
</wadl:doc>
<request>
<param name="network" style="plain" required="true"
type="csapi:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">A dictionary representation
of a network.</para></wadl:doc>
</param>
<param name="label" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">Network
label.</para></wadl:doc>
</param>
<param name="bridge" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">VIFs on this network are
connected to this bridge.</para></wadl:doc>
</param>
<param name="bridge_interface" style="plain"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">The bridge is connected to
this interface.</para></wadl:doc>
</param>
<param name="cidr" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">IPv4
subnet.</para></wadl:doc>
</param>
<param name="multi_host" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">Multi
host.</para></wadl:doc>
</param>
<param name="vlan" style="plain" required="false"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">Vlan id.</para></wadl:doc>
</param>
<param name="cidr_v6" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">IPv6
subnet.</para></wadl:doc>
</param>
<param name="dns1" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">First
DNS.</para></wadl:doc>
</param>
<param name="dns2" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">Second
DNS.</para></wadl:doc>
</param>
<param name="gateway" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">IPv4
gateway.</para></wadl:doc>
</param>
<param name="gateway_v6" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">IPv6
gateway.</para></wadl:doc>
</param>
<param name="project_id" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">Project
id.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -348,6 +264,99 @@
href="../api_samples/os-networks/network-create-req.xml"
/>
</wadl:doc>
<param name="network" style="plain" required="true"
type="csapi:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">A dictionary
representation of a
network.</para></wadl:doc>
</param>
<param name="label" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">Network
label.</para></wadl:doc>
</param>
<param name="bridge" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">VIFs on this network
are connected to this
bridge.</para></wadl:doc>
</param>
<param name="bridge_interface" style="plain"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">The bridge is connected
to this interface.</para></wadl:doc>
</param>
<param name="cidr" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">IPv4
subnet.</para></wadl:doc>
</param>
<param name="multi_host" style="plain"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">Multi
host.</para></wadl:doc>
</param>
<param name="vlan" style="plain" required="false"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">Vlan
id.</para></wadl:doc>
</param>
<param name="cidr_v6" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">IPv6
subnet.</para></wadl:doc>
</param>
<param name="dns1" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">First
DNS.</para></wadl:doc>
</param>
<param name="dns2" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">Second
DNS.</para></wadl:doc>
</param>
<param name="gateway" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">IPv4
gateway.</para></wadl:doc>
</param>
<param name="gateway_v6" style="plain"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">IPv6
gateway.</para></wadl:doc>
</param>
<param name="project_id" style="plain"
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create multiple servers">
<para role="shortdesc">Project
id.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202">

298
api-ref/src/wadls/compute-api/src/v2/ext/os-quota-sets.wadl
View File

@@ -96,8 +96,8 @@
<para role="shortdesc">Gets default quotas for a
tenant.</para>
</wadl:doc>
<response status="200"> &quotaSetsRespParameters;
<representation mediaType="application/json">
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Get default quotas response: JSON">
@@ -113,8 +113,7 @@
<xsdxt:code
href="../api_samples/os-quota-sets/quotas-show-defaults-get-resp.xml"
/>
</wadl:doc>
</representation>
</wadl:doc>&quotaSetsRespParameters; </representation>
</response>
</method>
<method name="GET" id="showQuota">
@@ -122,8 +121,8 @@
title="Show quotas">
<para role="shortdesc">Shows quotas for a tenant.</para>
</wadl:doc>
<response status="200"> &quotaSetsRespParameters;
<representation mediaType="application/json">
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Show quotas response: JSON">
<xsdxt:code
@@ -137,7 +136,7 @@
<xsdxt:code
href="../api_samples/os-quota-sets/quotas-show-get-resp.xml"
/>
</wadl:doc>
</wadl:doc> &quotaSetsRespParameters;
</representation>
</response>
</method>
@@ -146,8 +145,8 @@
title="Update quotas">
<para role="shortdesc">Updates quotas for a tenant.</para>
</wadl:doc>
<request> &quotaSetsReqParameters; <representation
mediaType="application/json">
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Update quotas response: JSON">
<xsdxt:code
@@ -161,11 +160,10 @@
<xsdxt:code
href="../api_samples/os-quota-sets/quotas-update-post-req.xml"
/>
</wadl:doc>
</representation>
</wadl:doc> &quotaSetsReqParameters; </representation>
</request>
<response status="200"> &quotaSetsRespParameters;
<representation mediaType="application/json">
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Update quota response: JSON">
<xsdxt:code
@@ -179,15 +177,15 @@
<xsdxt:code
href="../api_samples/os-quota-sets/quotas-update-post-resp.xml"
/>
</wadl:doc>
</wadl:doc> &quotaSetsRespParameters;
</representation>
</response>
</method>
<method name="DELETE" id="deleteQuotas">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Delete quotas">
<para role="shortdesc">Deletes quotas for a tenant so the quotas
revert to default values.</para>
<para role="shortdesc">Deletes quotas for a tenant so the
quotas revert to default values.</para>
</wadl:doc>
<response status="200"/>
</method>
@@ -197,8 +195,8 @@
>Enables an admin user to show quotas for a specified
tenant and user.</para>
</wadl:doc>
<response status="200"> &quotaSetsRespParameters;
<representation mediaType="application/json">
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Show quotas for user response: JSON">
@@ -214,7 +212,7 @@
<xsdxt:code
href="../api_samples/os-user-quotas/user-quotas-show-get-resp.xml"
/>
</wadl:doc>
</wadl:doc> &quotaSetsRespParameters;
</representation>
</response>
</method>
@@ -224,8 +222,8 @@
<para role="shortdesc">Updates quotas for a specified
tenant/project and user.</para>
</wadl:doc>
<request> &quotaSetsReqParameters; <representation
mediaType="application/json">
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Update quotas for user request: JSON">
@@ -241,11 +239,10 @@
<xsdxt:code
href="../api_samples/os-user-quotas/user-quotas-update-post-req.xml"
/>
</wadl:doc>
</representation>
</wadl:doc> &quotaSetsReqParameters; </representation>
</request>
<response status="200"> &quotaSetsRespParameters;
<representation mediaType="application/json">
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Update quotas for user response: JSON">
@@ -261,15 +258,15 @@
<xsdxt:code
href="../api_samples/os-user-quotas/user-quotas-update-post-resp.xml"
/>
</wadl:doc>
</wadl:doc> &quotaSetsRespParameters;
</representation>
</response>
</method>
<method name="DELETE" id="deleteQuotasUser">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Delete quotas for user">
<para role="shortdesc">Deletes quotas for a user so that the quotas
revert to default values.</para>
<para role="shortdesc">Deletes quotas for a user so that
the quotas revert to default values.</para>
</wadl:doc>
<response status="200"/>
</method>
@@ -280,127 +277,6 @@
user.</para>
</wadl:doc>
<response status="200">
<param name="quota_set" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="quota_set"><para>A quota_set
object.</para></wadl:doc>
</param>
<param name="cores" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="cores"><para>A cores
object.</para></wadl:doc>
</param>
<param name="fixed_ips " style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="fixed_ips"><para>A fixed_ips
object.</para></wadl:doc>
</param>
<param name="floating_ips" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="floating_ips"><para>A floating_ips
object.</para></wadl:doc>
</param>
<param name="id" style="plain" required="true"
type="csapi:UUID">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook" title="id"
><para>The ID for the quota
set.</para></wadl:doc>
</param>
<param name="injected_file_content_bytes" style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"><para>An
injected_file_content_bytes
object.</para></wadl:doc>
</param>
<param name="injected_file_path_bytes " style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="Show Quota Details for User"><para>An
injected_file_path_bytes
object.</para></wadl:doc>
</param>
<param name="injected_files" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="injected_files"><para>An injected_files
object.</para></wadl:doc>
</param>
<param name="instances" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="instances"><para>An instances
object.</para></wadl:doc>
</param>
<param name="key_pairs" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="key_pairs"><para>A key_pairs
object.</para></wadl:doc>
</param>
<param name="metadata_items" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="metadata_items"><para>A metadata_items
object.</para></wadl:doc>
</param>
<param name="ram" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook" title="ram"
><para>A ram object.</para></wadl:doc>
</param>
<param name="security_group_rules" style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="security_group_rules"><para>A
security_group_rules object.</para></wadl:doc>
</param>
<param name="security_groups" style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="security_groups"><para>A security_groups
object.</para></wadl:doc>
</param>
<param name="in_use" style="plain" type="xsd:int"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="in_use">
<para>The number of items in
use.</para></wadl:doc>
</param>
<param name="limit" style="plain" required="true"
type="xsd:int">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="limit"><para>The number of items permitted
for this tenant.</para></wadl:doc>
</param>
<param name="reserved" style="plain" required="true"
type="xsd:int">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="reserved">
<para>The number of reserved
items.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
@@ -409,6 +285,130 @@
href="../api_samples/os-quota-sets/quotas-user-show-detail-get-resp.json"
/>
</wadl:doc>
<param name="quota_set" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="quota_set"><para>A quota_set
object.</para></wadl:doc>
</param>
<param name="cores" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="cores"><para>A cores
object.</para></wadl:doc>
</param>
<param name="fixed_ips " style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="fixed_ips"><para>A fixed_ips
object.</para></wadl:doc>
</param>
<param name="floating_ips" style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="floating_ips"><para>A floating_ips
object.</para></wadl:doc>
</param>
<param name="id" style="plain" required="true"
type="csapi:UUID">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="id"><para>The ID for the quota
set.</para></wadl:doc>
</param>
<param name="injected_file_content_bytes"
style="plain" required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"><para>An
injected_file_content_bytes
object.</para></wadl:doc>
</param>
<param name="injected_file_path_bytes " style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="Show Quota Details for User"><para>An
injected_file_path_bytes
object.</para></wadl:doc>
</param>
<param name="injected_files" style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="injected_files"><para>An injected_files
object.</para></wadl:doc>
</param>
<param name="instances" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="instances"><para>An instances
object.</para></wadl:doc>
</param>
<param name="key_pairs" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="key_pairs"><para>A key_pairs
object.</para></wadl:doc>
</param>
<param name="metadata_items" style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="metadata_items"><para>A metadata_items
object.</para></wadl:doc>
</param>
<param name="ram" style="plain" required="true"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="ram"><para>A ram
object.</para></wadl:doc>
</param>
<param name="security_group_rules" style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="security_group_rules"><para>A
security_group_rules
object.</para></wadl:doc>
</param>
<param name="security_groups" style="plain"
required="true" type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="security_groups"><para>A
security_groups object.</para></wadl:doc>
</param>
<param name="in_use" style="plain" type="xsd:int"
required="true">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="in_use">
<para>The number of items in
use.</para></wadl:doc>
</param>
<param name="limit" style="plain" required="true"
type="xsd:int">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="limit"><para>The number of items
permitted for this
tenant.</para></wadl:doc>
</param>
<param name="reserved" style="plain" required="true"
type="xsd:int">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook"
title="reserved">
<para>The number of reserved
items.</para></wadl:doc>
</param>
</representation>
</response>
</method>

47
api-ref/src/wadls/compute-api/src/v2/ext/os-rescue.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@@ -42,20 +42,6 @@
Changes status to RESCUE.</para>
</wadl:doc>
<request>
<param name="rescue" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Rescue action"><para>Specify
the <code>rescue</code> action in the request
body.</para></wadl:doc>
</param>
<param name="adminPass" style="plain" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Admin password"><para>Use
this password for the rescued instance.
Generate a new password if none is
provided.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Rescue server: JSON request">
@@ -71,6 +57,22 @@
href="../api_samples/os-rescue/server-rescue-req.xml"
/>
</wadl:doc>
<param name="rescue" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Rescue action"
><para>Specify the <code>rescue</code>
action in the request
body.</para></wadl:doc>
</param>
<param name="adminPass" style="plain"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Admin password"><para>Use
this password for the rescued instance.
Generate a new password if none is
provided.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200">
@@ -98,13 +100,6 @@
<para role="shortdesc">Unrescues a server.</para>
</wadl:doc>
<request>
<param name="unrescue" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Unrescue action"
><para>Specify the <code>unrescue</code>
action in the request body.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -121,6 +116,14 @@
href="../api_samples/os-rescue/server-unrescue-req.xml"
/>
</wadl:doc>
<param name="unrescue" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Unrescue action"
><para>Specify the <code>unrescue</code>
action in the request
body.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202"/>

22
api-ref/src/wadls/compute-api/src/v2/ext/os-scheduler-hints.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
@@ -30,13 +30,7 @@
role="shortdesc">Creates a server with scheduler hints
that are passed directly to the scheduler.</para>
</wadl:doc>
<request> &serverCreateParameters; <param
name="os:scheduler_hints" style="plain"
required="true" type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Dictionary of data to send to
the scheduler.</para></wadl:doc>
</param>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -51,11 +45,17 @@
<xsdxt:code
href="../api_samples/OS-SCH-HNT/scheduler-hints-post-req.xml"
/>
</wadl:doc>
</wadl:doc> &serverCreateParameters; <param
name="os:scheduler_hints" style="plain"
required="true" type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Dictionary of data to send
to the scheduler.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200"> &serverCreateParameters; <representation
mediaType="application/json">
<response status="200"> &serverCreateParameters;
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code

336
api-ref/src/wadls/compute-api/src/v2/ext/os-security-group-default-rules.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@@ -47,48 +47,7 @@
rules.</para>
</wadl:doc>
<response status="200">
<param name="from_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="From port">
<para>Port at start of range.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="csapi:UUID"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Security group ID">
<para>Security group ID.</para>
</wadl:doc>
</param>
<param name="ip_protocol" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP protocol">
<para>The IP protocol: ICMP, TCP, or UDP.</para>
</wadl:doc>
</param>
<param name="ip_range" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP range">
<para>An IP range object.</para>
</wadl:doc>
</param>
<param name="cidr" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="CIDR">
<para>The CIDR for address range.</para>
</wadl:doc>
</param>
<param name="to_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="To port">
<para>Port at end of range.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -106,6 +65,49 @@
href="../api_samples/os-security-group-default-rules/security-group-default-rules-list-resp.xml"
/>
</wadl:doc>
<param name="from_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="From port">
<para>Port at start of range.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="csapi:UUID"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Security group ID">
<para>Security group ID.</para>
</wadl:doc>
</param>
<param name="ip_protocol" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP protocol">
<para>The IP protocol: ICMP, TCP, or
UDP.</para>
</wadl:doc>
</param>
<param name="ip_range" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP range">
<para>An IP range object.</para>
</wadl:doc>
</param>
<param name="cidr" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="CIDR">
<para>The CIDR for address range.</para>
</wadl:doc>
</param>
<param name="to_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="To port">
<para>Port at end of range.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
@@ -116,48 +118,7 @@
security group rule.</para>
</wadl:doc>
<response status="200">
<param name="from_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="From port">
<para>Port at start of range.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="csapi:UUID"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Security group ID">
<para>Security group ID.</para>
</wadl:doc>
</param>
<param name="ip_protocol" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP protocol">
<para>The IP protocol: ICMP, TCP, or UDP.</para>
</wadl:doc>
</param>
<param name="ip_range" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP range">
<para>An IP range object.</para>
</wadl:doc>
</param>
<param name="cidr" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="CIDR">
<para>The CIDR for address range.</para>
</wadl:doc>
</param>
<param name="to_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="To port">
<para>Port at end of range.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -175,6 +136,49 @@
href="../api_samples/os-security-group-default-rules/security-group-default-rules-show-resp.xml"
/>
</wadl:doc>
<param name="from_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="From port">
<para>Port at start of range.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="csapi:UUID"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Security group ID">
<para>Security group ID.</para>
</wadl:doc>
</param>
<param name="ip_protocol" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP protocol">
<para>The IP protocol: ICMP, TCP, or
UDP.</para>
</wadl:doc>
</param>
<param name="ip_range" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP range">
<para>An IP range object.</para>
</wadl:doc>
</param>
<param name="cidr" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="CIDR">
<para>The CIDR for address range.</para>
</wadl:doc>
</param>
<param name="to_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="To port">
<para>Port at end of range.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
@@ -185,41 +189,6 @@
rule.</para>
</wadl:doc>
<request>
<param name="id" style="plain" type="csapi:UUID"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Security group name or ID">
<para>Security group name or ID.</para>
</wadl:doc>
</param>
<param name="ip_protocol" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP protocol">
<para>The IP protocol: ICMP, TCP, or UDP.</para>
</wadl:doc>
</param>
<param name="from_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="From port">
<para>Port at start of range.</para>
</wadl:doc>
</param>
<param name="to_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="To port">
<para>Port at end of range.</para>
</wadl:doc>
</param>
<param name="cidr" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="CIDR">
<para>The CIDR for address range.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -237,51 +206,47 @@
href="../api_samples/os-security-group-default-rules/security-group-default-rules-create-req.xml"
/>
</wadl:doc>
<param name="id" style="plain" type="csapi:UUID"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Security group name or ID">
<para>Security group name or ID.</para>
</wadl:doc>
</param>
<param name="ip_protocol" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP protocol">
<para>The IP protocol: ICMP, TCP, or
UDP.</para>
</wadl:doc>
</param>
<param name="from_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="From port">
<para>Port at start of range.</para>
</wadl:doc>
</param>
<param name="to_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="To port">
<para>Port at end of range.</para>
</wadl:doc>
</param>
<param name="cidr" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="CIDR">
<para>The CIDR for address range.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
<param name="from_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="From port">
<para>Port at start of range.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="csapi:UUID"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Security group ID">
<para>Security group ID.</para>
</wadl:doc>
</param>
<param name="ip_protocol" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP protocol">
<para>The IP protocol: ICMP, TCP, or UDP.</para>
</wadl:doc>
</param>
<param name="ip_range" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP range">
<para>An IP range object.</para>
</wadl:doc>
</param>
<param name="cidr" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="CIDR">
<para>The CIDR for address range.</para>
</wadl:doc>
</param>
<param name="to_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="To port">
<para>Port at end of range.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
@@ -299,14 +264,57 @@
href="../api_samples/os-security-group-default-rules/security-group-default-rules-create-resp.xml"
/>
</wadl:doc>
<param name="from_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="From port">
<para>Port at start of range.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="csapi:UUID"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Security group ID">
<para>Security group ID.</para>
</wadl:doc>
</param>
<param name="ip_protocol" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP protocol">
<para>The IP protocol: ICMP, TCP, or
UDP.</para>
</wadl:doc>
</param>
<param name="ip_range" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="IP range">
<para>An IP range object.</para>
</wadl:doc>
</param>
<param name="cidr" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="CIDR">
<para>The CIDR for address range.</para>
</wadl:doc>
</param>
<param name="to_port" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="To port">
<para>Port at end of range.</para>
</wadl:doc>
</param>
</representation>
</response>
</method>
<method name="DELETE" id="deleteSecGroupDefaultRule">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete default security group rule">
<para role="shortdesc">Deletes a specified security
group rule.</para>
<para role="shortdesc">Deletes a specified security group
rule.</para>
</wadl:doc>
<response status="204"/>
</method>

2
api-ref/src/wadls/compute-api/src/v2/ext/os-security-groups.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"

28
api-ref/src/wadls/compute-api/src/v2/ext/os-server-OS-EXT-IPS-MAC.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
@@ -45,13 +45,7 @@
<para role="shortdesc">Creates a server with the
OS-EXT-IPS-MAC:mac_addr extended attribute.</para>
</wadl:doc>
<request> &serverCreateParameters; <param
name="OS-EXT-IPS-MAC:mac_addr" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Associated MAC
address.</para></wadl:doc>
</param>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -66,7 +60,13 @@
<xsdxt:code
href="../api_samples/OS-EXT-IPS-MAC/server-post-req.xml"
/>
</wadl:doc>
</wadl:doc>&serverCreateParameters; <param
name="OS-EXT-IPS-MAC:mac_addr" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Associated MAC
address.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202"> &serverCreateParameters;
@@ -95,7 +95,10 @@
server. Includes the OS-EXT-IPS-MAC:mac_addr extended
attribute.</para>
</wadl:doc>
<request> &serverListQueryParameters; </request>
<request>
<representation mediaType="application/xml">
&serverListQueryParameters;</representation>
</request>
<response status="202"> &serverCreateParameters; <param
name="OS-EXT-IPS-MAC:mac_addr" style="plain"
type="xsd:string" required="false">
@@ -128,7 +131,10 @@
Includes the OS-EXT-IPS-MAC:mac_addr extended
attribute.</para>
</wadl:doc>
<request> &serverListQueryParameters; </request>
<request>
<representation mediaType="application/xml">
&serverListQueryParameters; </representation>
</request>
<response status="202"> &serverCreateParameters; <param
name="OS-EXT-IPS-MAC:mac_addr" style="plain"
type="xsd:string" required="false">

66
api-ref/src/wadls/compute-api/src/v2/ext/os-server-groups.wadl
View File

@@ -48,27 +48,6 @@
<para role="shortdesc">Creates a server group.</para>
</wadl:doc>
<request>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The server group name. A non-empty string
with no leading or trailing spaces. Maximum
length is 255 characters.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="policies" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A list of one or more policy names to
associate with the server group. The list must
contain at least one policy name.</para>
<para>Each policy name must be a non-empty string
with no leading or trailing spaces. Maximum
length is 255 characters.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -84,10 +63,34 @@
href="../api_samples/os-server-groups/server-groups-post-req.xml"
/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The server group name. A non-empty
string with no leading or trailing spaces.
Maximum length is 255
characters.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="policies" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A list of one or more policy names to
associate with the server group. The list
must contain at least one policy
name.</para>
<para>Each policy name must be a non-empty
string with no leading or trailing spaces.
Maximum length is 255
characters.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200"> &serverGroupsParameters;
<representation mediaType="application/json">
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
@@ -101,8 +104,7 @@
<xsdxt:code
href="../api_samples/os-server-groups/server-groups-post-resp.xml"
/>
</wadl:doc>
</representation>
</wadl:doc> &serverGroupsParameters; </representation>
</response>
</method>
<method name="GET" id="listServerGroups">
@@ -120,15 +122,14 @@
</wadl:doc>
</representation>
</response>
<response status="200"> &serverGroupsParameters;
<representation mediaType="application/xml">
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-server-groups/server-groups-list-resp.xml"
/>
</wadl:doc>
</representation>
</wadl:doc> &serverGroupsParameters; </representation>
</response>
</method>
<method name="GET" id="showServerGroup">
@@ -147,15 +148,14 @@
</wadl:doc>
</representation>
</response>
<response status="200"> &serverGroupsParameters;
<representation mediaType="application/xml">
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/os-server-groups/server-groups-get-resp.xml"
/>
</wadl:doc>
</representation>
</wadl:doc> &serverGroupsParameters; </representation>
</response>
</method>
<method name="DELETE" id="deleteServerGroup">

4
api-ref/src/wadls/compute-api/src/v2/ext/os-server-password.wadl
View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"
@@ -27,7 +26,6 @@
</resource>
</resource>
</resources>
<method name="GET" id="getPassword">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get server password">

33
api-ref/src/wadls/compute-api/src/v2/ext/os-server-shelve.wadl
View File

@@ -1,5 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
@@ -48,13 +50,6 @@
<code>shelveOffload</code> action.</para>
</wadl:doc>
<request>
<param name="shelve" style="plain" type="xsd:string"
required="true" id="os-shelve">
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
xml:lang="EN" title="Shelve action"><para>Specify
the <code>shelve</code> action in the request
body.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
xml:lang="EN" title="Shelve server: JSON request">
@@ -69,8 +64,7 @@
<xsdxt:code
href="../api_samples/os-shelve/os-shelve.xml"
/>
</wadl:doc>
</representation>
</wadl:doc> &shelveAction; </representation>
</request>
<response status="202"/>
</method>
@@ -85,14 +79,6 @@
usage.</para>
</wadl:doc>
<request>
<param name="shelveOffload" style="plain"
type="xsd:string" required="true"
id="os-shelveOffload">
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
xml:lang="EN" title="Shelve-offload action"
><para>Specify the <code>shelveOffload</code>
action in the request body.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
xml:lang="EN" title="Shelve server: JSON request">
@@ -107,8 +93,7 @@
<xsdxt:code
href="../api_samples/os-shelve/os-shelve-offload.xml"
/>
</wadl:doc>
</representation>
</wadl:doc> &shelveOffloadAction; </representation>
</request>
<response status="202"/>
</method>
@@ -118,13 +103,6 @@
<para role="shortdesc">Restores a shelved server.</para>
</wadl:doc>
<request>
<param name="unshelve" style="plain" type="xsd:string"
required="true" id="os-unshelve">
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
xml:lang="EN" title="Unshelve action"
><para>Specify the <code>unshelve</code>
action in the request body.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
xml:lang="EN"
@@ -140,8 +118,7 @@
<xsdxt:code
href="../api_samples/os-shelve/os-unshelve.xml"
/>
</wadl:doc>
</representation>
</wadl:doc> &unshelveAction; </representation>
</request>
<response status="202"/>
</method>

46
api-ref/src/wadls/compute-api/src/v2/ext/os-server-start-stop.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
@@ -12,9 +12,9 @@
<param name="tenant_id" style="template"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Tenant ID"><para>The ID for the
tenant or account in a multi-tenancy
cloud.</para></wadl:doc>
xml:lang="EN" title="Tenant ID"><para>The ID
for the tenant or account in a
multi-tenancy cloud.</para></wadl:doc>
</param>
<resource id="Servers" path="servers">
<resource path="{server_id}" id="server_id">
@@ -22,9 +22,9 @@
type="csapi:UUID">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Server UUID"><para>The
UUID for the server of interest to
you.</para></wadl:doc>
xml:lang="EN" title="Server UUID"
><para>The UUID for the server of
interest to you.</para></wadl:doc>
</param>
<resource path="action" id="action">
<method href="#start"/>
@@ -42,13 +42,6 @@
its status to ACTIVE.</para>
</wadl:doc>
<request>
<param name="os-start" style="plain" type="xsd:string"
required="true" id="os-start">
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
xml:lang="EN" title="Start action"><para>Specify
the <code>os-start</code> action in the
request body.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
xml:lang="EN" title="Start server: JSON request">
@@ -64,6 +57,15 @@
href="../api_samples/os-server-start-stop/server-stop-req.xml"
/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-start" style="plain" type="xsd:string"
required="true" id="os-start">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Specify the
<code>os-start</code> action in the
request body.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
@@ -75,13 +77,6 @@
its status to STOPPED.</para>
</wadl:doc>
<request>
<param name="os-stop" style="plain" type="xsd:string"
required="true" id="os-stop">
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
xml:lang="EN" title="Stop action"><para>Specify
the <code>os-stop</code> action in the request
body.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/wadl:docbook"
xml:lang="EN" title="Stop server: JSON request">
@@ -97,6 +92,15 @@
href="../api_samples/os-server-start-stop/server-stop-req.xml"
/>
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-stop" style="plain" type="xsd:string"
required="true" id="os-stop">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Specify the
<code>os-stop</code> action in the
request body.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202"/>

40
api-ref/src/wadls/compute-api/src/v2/ext/os-services.wadl
View File

@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
@@ -114,24 +112,6 @@
table about why a service was disabled.</para>
</wadl:doc>
<request>
<param name="host" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The host
name.</para></wadl:doc>
</param>
<param name="binary" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The service
name.</para></wadl:doc>
</param>
<param name="disabled_reason" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The reason the service was
disabled.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -147,6 +127,24 @@
href="../api_samples/os-services/service-disable-log-put-req.xml"
/>
</wadl:doc>
<param name="host" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The host
name.</para></wadl:doc>
</param>
<param name="binary" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The service
name.</para></wadl:doc>
</param>
<param name="disabled_reason" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The reason the service was
disabled.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200">

86
api-ref/src/wadls/compute-api/src/v2/ext/os-simple-tenant-usage.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
@@ -40,25 +40,29 @@
tenant.</para>
</wadl:doc>
<request>
<param name="start" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Tenant ID"><para
role="shortdesc">The start of a time range, in
date time format.</para></wadl:doc>
</param>
<param name="end" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Tenant ID"><para
role="shortdesc">The end of the time range, in
date time format.</para></wadl:doc>
</param>
<param name="detailed" style="plain" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Tenant ID"><para
role="shortdesc">Whether to return detailed
usage information. Defaults to
false.</para></wadl:doc>
</param>
<representation mediaType="application/xml">
<param name="start" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Tenant ID"><para
role="shortdesc">The start of a time
range, in date time
format.</para></wadl:doc>
</param>
<param name="end" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Tenant ID"><para
role="shortdesc">The end of the time
range, in date time
format.</para></wadl:doc>
</param>
<param name="detailed" style="plain" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Tenant ID"><para
role="shortdesc">Whether to return
detailed usage information. Defaults to
false.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
@@ -86,25 +90,29 @@
tenants.</para>
</wadl:doc>
<request>
<param name="start" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Tenant ID"><para
role="shortdesc">The start of a time range, in
date time format.</para></wadl:doc>
</param>
<param name="end" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Tenant ID"><para
role="shortdesc">The end of the time range, in
date time format.</para></wadl:doc>
</param>
<param name="detailed" style="plain" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Tenant ID"><para
role="shortdesc">Whether to return detailed
usage information. Defaults to
false.</para></wadl:doc>
</param>
<representation mediaType="application/xml">
<param name="start" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Tenant ID"><para
role="shortdesc">The start of a time
range, in date time
format.</para></wadl:doc>
</param>
<param name="end" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Tenant ID"><para
role="shortdesc">The end of the time
range, in date time
format.</para></wadl:doc>
</param>
<param name="detailed" style="plain" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Tenant ID"><para
role="shortdesc">Whether to return
detailed usage information. Defaults to
false.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">

2
api-ref/src/wadls/compute-api/src/v2/ext/os-used-limits-for-admins.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"

4
api-ref/src/wadls/compute-api/src/v2/ext/os-used-limits.wadl
View File

@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"

10
api-ref/src/wadls/compute-api/src/v2/ext/os-virtual-interfaces.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
@@ -76,18 +76,18 @@
</wadl:doc>
<response status="202">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/OS-EXT-VIF-NET/vifs-list-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/OS-EXT-VIF-NET/vifs-list-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

36
api-ref/src/wadls/compute-api/src/v2/ext/os-volume.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
@@ -86,14 +86,7 @@
<para role="shortdesc">Creates a volume.</para>
</wadl:doc>
<request>
<param name="volume" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A partial representation of a volume that is
used to create a volume.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -109,6 +102,14 @@
href="../api_samples/os-volume/volume_create.xml"
/>
</wadl:doc>
<param name="volume" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A partial representation of a volume
that is used to create a volume.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="201">
@@ -276,14 +277,7 @@
<para role="shortdesc">Creates a snapshot.</para>
</wadl:doc>
<request>
<param name="snapshot" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A partial representation of a snapshot that
is used to create a snapshot.</para>
</wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -299,6 +293,14 @@
href="../api_samples/os-volume/snapshot_create.xml"
/>
</wadl:doc>
<param name="snapshot" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A partial representation of a snapshot
that is used to create a snapshot.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="201">

45
api-ref/src/wadls/compute-api/src/v2/ext/os-volume_attachments.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2011-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2011-2014 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
@@ -92,26 +92,7 @@
<para role="shortdesc">Attaches a volume to the specified
server.</para></wadl:doc>
<request>
<param name="volumeId" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>ID of the volume to attach.
</para></wadl:doc>
</param>
<param name="device" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Name of the device such as, /dev/vdb. Use
"auto" for auto-assign (if
supported).</para></wadl:doc>
</param>
<param name="volumeAttachment" style="template"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A dictionary representation of a volume
attachment.</para></wadl:doc>
</param>
<representation mediaType="application/xml"
element="csapi:attachvolume">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -128,6 +109,28 @@
href="../api_samples/os-volumes/attach-volume-to-server-req.json"
/>
</wadl:doc>
<param name="volumeId" style="template"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>ID of the volume to attach.
</para></wadl:doc>
</param>
<param name="device" style="template"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Name of the device such as, /dev/vdb.
Use "auto" for auto-assign (if
supported).</para></wadl:doc>
</param>
<param name="volumeAttachment" style="template"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A dictionary representation of a volume
attachment.</para></wadl:doc>
</param>
</representation>
</request>
<response status="202">

758
api-ref/src/wadls/compute-api/src/v2/wadl/os-compute-2.wadl
View File

File diff suppressed because it is too large Load Diff

130
api-ref/src/wadls/compute-api/src/v3/wadl/os-admin-actions-v3.wadl
View File

@@ -1,8 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?><!-- (C) 2014 OpenStack Foundation, All Rights Reserved --><!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">%common;]>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0">
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
<resources base="https://servers.api.openstack.com"
xml:id="os-admin-actions-v3">
<resource id="v3" path="//v3">
@@ -36,18 +40,20 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-backup-server.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-backup-server.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>
@@ -60,18 +66,20 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-inject-network-info.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-inject-network-info.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>
@@ -84,18 +92,20 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-live-migrate.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-live-migrate.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>
@@ -107,18 +117,20 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-lock-server.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-lock-server.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>
@@ -131,18 +143,20 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-migrate.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-migrate.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>
@@ -155,18 +169,20 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-pause.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-pause.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>
@@ -179,18 +195,20 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-reset-network.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-reset-network.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>
@@ -203,18 +221,20 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-reset-server-state.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-reset-server-state.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>
@@ -227,18 +247,20 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-resume.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-resume.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>
@@ -251,18 +273,20 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-suspend.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-suspend.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>
@@ -274,18 +298,20 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-unlock-server.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-unlock-server.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>
@@ -298,18 +324,20 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-unpause.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-admin-actions/admin-actions-unpause.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>

58
api-ref/src/wadls/compute-api/src/v3/wadl/os-agents-v3.wadl
View File

@@ -1,11 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0">
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
<resources base="https://servers.api.openstack.com"
xml:id="os-agents-v3">
<resource id="v3" path="//v3">
@@ -27,34 +28,38 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-agents/agent-post-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-agents/agent-post-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="201">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-agents/agent-post-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-agents/agent-post-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -63,21 +68,22 @@
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists agent builds.</para>
</wadl:doc>
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-agents/agents-get-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-agents/agents-get-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -88,34 +94,38 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-agents/agent-update-put-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-agents/agent-update-put-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-agents/agent-update-put-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-agents/agent-update-put-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

150
api-ref/src/wadls/compute-api/src/v3/wadl/os-aggregates-v3.wadl
View File

@@ -1,11 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0">
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
<resources base="https://servers.api.openstack.com"
xml:id="os-aggregates-v3">
<resource id="v3" path="//v3">
@@ -35,40 +36,41 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-post-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-post-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="201">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-post-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-post-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
<method name="POST" id="addhost">
<wadl:doc xml:lang="EN" title="Add host"
xmlns="http://docbook.org/ns/docbook">
@@ -77,34 +79,38 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-add-host-post-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-add-host-post-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregates-add-host-post-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregates-add-host-post-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -117,34 +123,38 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-post-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-post-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregates-get-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregates-get-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -157,34 +167,38 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-post-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-post-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregates-list-get-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregates-list-get-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -198,34 +212,38 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-metadata-post-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-metadata-post-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregates-metadata-post-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregates-metadata-post-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -238,34 +256,38 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-remove-host-post-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-remove-host-post-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregates-remove-host-post-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregates-remove-host-post-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -278,34 +300,38 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-update-post-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-update-post-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-update-post-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-aggregates/aggregate-update-post-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

8
api-ref/src/wadls/compute-api/src/v3/wadl/os-cells-v3.wadl
View File

@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014 OpenStack Foundation, All Rights Reserved -->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0">
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
<resources base="https://servers.api.openstack.com"
xml:id="os-cell-v3">
<resource id="v3" path="//v3">

24
api-ref/src/wadls/compute-api/src/v3/wadl/os-certificates-v3.wadl
View File

@@ -26,34 +26,34 @@
</wadl:doc>
<!-- <request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-certificates/certificate-create-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-certificates/certificate-create-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request> -->
<response status="201">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-certificates/certificate-create-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-certificates/certificate-create-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -64,18 +64,18 @@
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-certificates/certificate-get-root-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-certificates/certificate-get-root-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

16
api-ref/src/wadls/compute-api/src/v3/wadl/os-config-drive-v3.wadl
View File

@@ -31,18 +31,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-config-drive/server-config-drive-get-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-config-drive/server-config-drive-get-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -55,18 +55,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-config-drive/servers-config-drive-details-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-config-drive/servers-config-drive-details-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

16
api-ref/src/wadls/compute-api/src/v3/wadl/os-deferred-delete-v3.wadl
View File

@@ -30,18 +30,18 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-deferred-delete/force-delete-post-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-deferred-delete/force-delete-post-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>
@@ -54,18 +54,18 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-deferred-delete/restore-post-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-deferred-delete/restore-post-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>

16
api-ref/src/wadls/compute-api/src/v3/wadl/os-evacuate-v3.wadl
View File

@@ -28,34 +28,34 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-evacuate/server-evacuate-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-evacuate/server-evacuate-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-evacuate/server-evacuate-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-evacuate/server-evacuate-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

16
api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-availability-zone-v3.wadl
View File

@@ -31,18 +31,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-availability-zone/server-get-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-availability-zone/server-get-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -55,18 +55,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-availability-zone/servers-detail-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-availability-zone/servers-detail-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

16
api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-server-attributes-v3.wadl
View File

@@ -30,18 +30,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-server-attributes/server-get-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-server-attributes/server-get-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -54,18 +54,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-server-attributes/servers-detail-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-server-attributes/servers-detail-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

16
api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-status-v3.wadl
View File

@@ -29,18 +29,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-status/server-get-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-status/server-get-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -52,18 +52,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-status/servers-detail-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-extended-status/servers-detail-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

84
api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-access-v3.wadl
View File

@@ -41,34 +41,34 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-add-tenant-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-add-tenant-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-add-tenant-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-add-tenant-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -81,34 +81,34 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-create-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-create-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-create-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-create-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -118,23 +118,23 @@
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Extends flavor detail to add
access attribute to the response of flavor detail.
</para>
</para>
</wadl:doc>
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-detail-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-detail-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -146,34 +146,34 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-add-tenant-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-add-tenant-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-list-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-list-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -181,38 +181,38 @@
<wadl:doc xml:lang="EN" title="Remove flavor access"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Removes flavor access for tenant.
</para>
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-remove-tenant-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-remove-tenant-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-remove-tenant-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-remove-tenant-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -226,18 +226,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-show-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-access/flavor-access-show-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

24
api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-manage-v3.wadl
View File

@@ -23,34 +23,34 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-manage/flavor-create-post-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-manage/flavor-create-post-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-manage/flavor-create-post-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-manage/flavor-create-post-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -61,18 +61,18 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-manage/flavor-create-post-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-manage/flavor-create-post-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="204"/>

32
api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-rxtx-v3.wadl
View File

@@ -32,18 +32,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-flavor-rxtx/flavor-rxtx-get-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-flavor-rxtx/flavor-rxtx-get-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -55,18 +55,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-flavor-rxtx/flavor-rxtx-list-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-flavor-rxtx/flavor-rxtx-list-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -77,34 +77,34 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-flavor-rxtx/flavor-rxtx-post-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-flavor-rxtx/flavor-rxtx-post-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-flavor-rxtx/flavor-rxtx-post-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-flavor-rxtx/flavor-rxtx-post-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

24
api-ref/src/wadls/compute-api/src/v3/wadl/os-flavors-v3.wadl
View File

@@ -32,18 +32,18 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavors/flavor-get-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavors/flavor-get-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200"/>
@@ -55,18 +55,18 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavors/flavors-detail-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavors/flavors-detail-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200"/>
@@ -78,18 +78,18 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavors/flavors-list-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavors/flavors-list-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200"/>

64
api-ref/src/wadls/compute-api/src/v3/wadl/os-flavorspecs-v3.wadl
View File

@@ -36,34 +36,34 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-extra-specs/flavor-extra-specs-create-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-extra-specs/flavor-extra-specs-create-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="201">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-extra-specs/flavor-extra-specs-create-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-extra-specs/flavor-extra-specs-create-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -75,34 +75,34 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-extra-specs/flavor-extra-specs-create-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-extra-specs/flavor-extra-specs-create-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-extra-specs/flavor-extra-specs-get-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-extra-specs/flavor-extra-specs-get-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -114,34 +114,34 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-extra-specs/flavor-extra-specs-create-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-extra-specs/flavor-extra-specs-create-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-extra-specs/flavor-extra-specs-list-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-extra-specs/flavor-extra-specs-list-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -153,34 +153,34 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-extra-specs/flavor-extra-specs-update-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-extra-specs/flavor-extra-specs-update-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-extra-specs/flavor-extra-specs-update-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/flavor-extra-specs/flavor-extra-specs-update-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

56
api-ref/src/wadls/compute-api/src/v3/wadl/os-hosts-v3.wadl
View File

@@ -38,18 +38,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-hosts/host-get-reboot.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-hosts/host-get-reboot.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -62,18 +62,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-hosts/host-get-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-hosts/host-get-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -85,18 +85,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-hosts/host-get-shutdown.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-hosts/host-get-shutdown.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -108,18 +108,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-hosts/host-get-startup.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-hosts/host-get-startup.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -131,34 +131,34 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-hosts/host-put-maintenance-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-hosts/host-put-maintenance-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-hosts/host-put-maintenance-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-hosts/host-put-maintenance-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -170,18 +170,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-hosts/hosts-list-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-hosts/hosts-list-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

16
api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-actions-v3.wadl
View File

@@ -34,18 +34,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-instance-actions/instance-action-get-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-instance-actions/instance-action-get-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -58,18 +58,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-instance-actions/instance-actions-list-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-instance-actions/instance-actions-list-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

8
api-ref/src/wadls/compute-api/src/v3/wadl/os-limits-v3.wadl
View File

@@ -22,18 +22,18 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/limits/limit-get-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/limits/limit-get-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200"/>

8
api-ref/src/wadls/compute-api/src/v3/wadl/os-migrations-v3.wadl
View File

@@ -26,18 +26,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-migrations/migrations-get.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-migrations/migrations-get.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

16
api-ref/src/wadls/compute-api/src/v3/wadl/os-multinic-v3.wadl
View File

@@ -26,18 +26,18 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-multinic/multinic-add-fixed-ip-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-multinic/multinic-add-fixed-ip-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>
@@ -50,18 +50,18 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-multinic/multinic-remove-fixed-ip-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-multinic/multinic-remove-fixed-ip-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="202"/>

24
api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-class-sets-v3.wadl
View File

@@ -30,18 +30,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-quota-class-sets/quota-classes-show-get-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-quota-class-sets/quota-classes-show-get-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -53,34 +53,34 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-quota-class-sets/quota-classes-update-post-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-quota-class-sets/quota-classes-update-post-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-quota-class-sets/quota-classes-update-post-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-quota-class-sets/quota-classes-update-post-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

32
api-ref/src/wadls/compute-api/src/v3/wadl/os-remote-consoles-v3.wadl
View File

@@ -29,34 +29,34 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-remote-consoles/get-spice-console-post-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-remote-consoles/get-spice-console-post-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-remote-consoles/get-spice-console-post-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-remote-consoles/get-spice-console-post-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -67,34 +67,34 @@
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-remote-consoles/get-vnc-console-post-req.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-remote-consoles/get-vnc-console-post-req.xml"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-remote-consoles/get-vnc-console-post-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-remote-consoles/get-vnc-console-post-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

16
api-ref/src/wadls/compute-api/src/v3/wadl/os-server-usage-v3.wadl
View File

@@ -30,18 +30,18 @@
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-server-usage/server-get-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-server-usage/server-get-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -54,18 +54,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-server-usage/servers-detail-resp.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-server-usage/servers-detail-resp.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

16
api-ref/src/wadls/compute-api/src/v3/wadl/os-simple-tenant-usage-v3.wadl
View File

@@ -31,18 +31,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-simple-tenant-usage/simple-tenant-usage-get.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-simple-tenant-usage/simple-tenant-usage-get.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
@@ -55,18 +55,18 @@
<request> </request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-simple-tenant-usage/simple-tenant-usage-get-specific.json"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../api_samples/os-simple-tenant-usage/simple-tenant-usage-get-specific.xml"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>

164
api-ref/src/wadls/databases-api/xsd/dbaas.wadl
View File

@@ -292,87 +292,6 @@
</itemizedlist></note>
</wadl:doc>
<request>
<param name="instance" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>An <code>instance</code>
object.</para></wadl:doc>
</param>
<param name="flavorRef" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Reference (href) to a flavor
as specified in the response from the list
Flavors API call. This is the actual URI as
specified by the href field in the
link.</para>
<para>Rather than the flavor URI, you can also
pass the flavor id (integer) as the value for
flavorRef. For example, the flavor id for the
flavor URI shown above is
"1".</para></wadl:doc>
</param>
<param name="size" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The volume size in gigabytes
(GB). The value specified must be between 1
and 50.</para></wadl:doc>
</param>
<param name="databases" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>A <code>databases</code>
object.</para></wadl:doc>
</param>
<param name="name" id="instance-name" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Name of the instance to
create. The length of the name is limited to
255 characters and any characters are
permitted.</para></wadl:doc>
</param>
<param name="name" id="database-name" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Specifies database names for
creating databases on instance
creation.</para></wadl:doc>
</param>
<param name="character_set" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Set of symbols and encodings.
The default character set is
<code>utf8</code>.</para></wadl:doc>
</param>
<param name="collate" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Set of rules for comparing
characters in a character set. The default
value for collate is
<code>utf8_general_ci</code>.</para></wadl:doc>
</param>
<param name="users" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>A <code>users</code>
object.</para></wadl:doc>
</param>
<param name="name" id="user-name" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The user name for the database
on instance creation.</para></wadl:doc>
</param>
<param name="password" id="user-password" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The password for those users
on instance creation.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -382,6 +301,89 @@
href="samples/db-create-instance-request.json"
/>
</wadl:doc>
<param name="instance" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>An <code>instance</code>
object.</para></wadl:doc>
</param>
<param name="flavorRef" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Reference (href) to a
flavor as specified in the response from
the list Flavors API call. This is the
actual URI as specified by the href field
in the link.</para>
<para>Rather than the flavor URI, you can also
pass the flavor id (integer) as the value
for flavorRef. For example, the flavor id
for the flavor URI shown above is
"1".</para></wadl:doc>
</param>
<param name="size" style="plain" type="xsd:int"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The volume size in
gigabytes (GB). The value specified must
be between 1 and 50.</para></wadl:doc>
</param>
<param name="databases" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>A <code>databases</code>
object.</para></wadl:doc>
</param>
<param name="name" id="instance-name" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Name of the instance to
create. The length of the name is limited
to 255 characters and any characters are
permitted.</para></wadl:doc>
</param>
<param name="name" id="database-name" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Specifies database names
for creating databases on instance
creation.</para></wadl:doc>
</param>
<param name="character_set" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Set of symbols and
encodings. The default character set is
<code>utf8</code>.</para></wadl:doc>
</param>
<param name="collate" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Set of rules for comparing
characters in a character set. The default
value for collate is
<code>utf8_general_ci</code>.</para></wadl:doc>
</param>
<param name="users" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>A <code>users</code>
object.</para></wadl:doc>
</param>
<param name="name" id="user-name" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The user name for the
database on instance
creation.</para></wadl:doc>
</param>
<param name="password" id="user-password"
style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The password for those
users on instance
creation.</para></wadl:doc>
</param>
</representation>
</request>
<response status="200">

52
api-ref/src/wadls/identity-api/src/v2.0/samples/validatetoken.json
View File

@@ -1,28 +1,30 @@
{
"access": {
"token": {
"id": "ab48a9efdfedb23ty3494",
"expires": "2010-11-01T03:32:15-05:00",
"tenant": {
"id": "345",
"name": "My Project"
"access":{
"token":{
"id":"ab48a9efdfedb23ty3494",
"expires":"2010-11-01T03:32:15-05:00",
"tenant":{
"id":"345",
"name":"My Project"
}
},
"user":{
"id":"123",
"name":"jqsmith",
"roles":[
{
"id":"234",
"name":"compute:admin"
},
{
"id":"234",
"name":"object-store:admin",
"tenantId":"1"
}
},
"user": {
"id": "123",
"name": "jqsmith",
"roles": [
{
"id": "234",
"name": "compute:admin"
},
{
"id": "234",
"name": "object-store:admin",
"tenantId": "1"
}
],
"roles_links": []
}
}
],
"roles_links":[
]
}
}
}

45
api-ref/src/wadls/identity-api/src/v2.0/wadl/HP-IDM-admin.wadl
View File

@@ -29,7 +29,8 @@
<!-- All Resources -->
<!--*******************************************************-->
<!-- We should use SSL in production -->
<resources base="http://localhost:35357" xml:id="HP-IDM-admin-v2.0">
<resources base="http://localhost:35357"
xml:id="HP-IDM-admin-v2.0">
<resource id="version" path="//v2.0">
<resource id="tokens" path="tokens">
<resource id="tokenById" path="{tokenId}">
@@ -37,13 +38,15 @@
type="xsd:string" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">A valid authentication token.</wadl:doc>
xml:lang="EN"><para>A valid authentication
token.</para></wadl:doc>
</param>
<param name="tokenId" style="template"
type="xsd:string" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The token ID.</wadl:doc>
xml:lang="EN"><para>The token
ID.</para></wadl:doc>
</param>
<param name="belongsTo" style="query"
required="false" type="xsd:string">
@@ -62,11 +65,13 @@
type="xsd:string" required="false">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">A comma-separated string of service IDs.
Checks the roles against the specified service
IDs. If a service ID is not valid or if no
roles are associated with a service ID, a
401 fault is returned.</wadl:doc>
xml:lang="EN"><para>A comma-separated
string of service IDs. Checks the
roles against the specified service
IDs. If a service ID is not valid or
if no roles are associated with a
service ID, a 401 fault is
returned.</para></wadl:doc>
</param>
<method href="#validateToken"/>
<method href="#checkToken"/>
@@ -81,36 +86,32 @@
<!-- Token Operations -->
<method name="GET" id="validateToken">
<wadl:doc
xmlns="http://docbook.org/ns/docbook" title="Validate Token">
<para role="shortdesc">
Validates a token and that it belongs to a
<wadl:doc xmlns="http://docbook.org/ns/docbook"
title="Validate token">
<para role="shortdesc">Validates that a token belongs to a
specified tenant and services. Returns the permissions
relevant to a particular client.</para>
</wadl:doc>
<response status="200 203">
<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/validatetoken.json"/>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="identity:access">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="../samples/validatetoken.xml"/>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="HEAD" id="checkToken">
<wadl:doc
xmlns="http://docbook.org/ns/docbook" title="Check Token">
<para role="shortdesc">
Validates a token and that it belongs to a
specified tenant and services, for performance.</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook"
title="Validate token for performance">
<para role="shortdesc">Validates that a token belongs to a
specified tenant and services. For performance.</para>
</wadl:doc>
<response status="200 203"/> &commonFaults; &getFaults;
</method>

83
api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSADM-admin.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2011-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2011-2014 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
@@ -18,8 +18,7 @@
xmlns:capi="http://docs.openstack.org/common/api/v1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
>
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0">
<grammars>
<include href="../xsd/OS-KSADM.xsd"/>
</grammars>
@@ -27,7 +26,8 @@
<!-- All Resources -->
<!--*******************************************************-->
<!-- We should use SSL in production -->
<resources base="http://localhost:35357" xml:id="OS-KSADM-admin-v2.0">
<resources base="http://localhost:35357"
xml:id="OS-KSADM-admin-v2.0">
<resource id="version-v2.0" path="//v2.0">
<param name="X-Auth-Token" style="header"
type="xsd:string" required="true">
@@ -118,10 +118,11 @@
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The page size.
</para></wadl:doc>
</para></wadl:doc>
</param>
<method href="#listUsersForTenant"/>
<resource id="userForTenant-v2.0" path="{userId}">
<resource id="userForTenant-v2.0"
path="{userId}">
<param name="userId" style="template"
type="xsd:string">
<wadl:doc
@@ -132,10 +133,10 @@
<resource id="userRolesForTenant-v2.0"
path="roles">
<resource
id="tenant-user-role-OS-KSADM-v2.0"
id="tenant-user-role-OS-KSADM-v2.0"
path="OS-KSADM">
<resource
id="userSpecificRoleForTenant-v2.0"
id="userSpecificRoleForTenant-v2.0"
path="{roleId}">
<param name="roleId"
style="template" type="xsd:string">
@@ -203,7 +204,7 @@
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The page size.
</para></wadl:doc>
</para></wadl:doc>
</param>
<method href="#listServices"/>
<method href="#addService"/>
@@ -575,15 +576,7 @@
<para role="shortdesc">Lists roles.</para>
</wadl:doc>
<response status="200 203">
<param name="roles" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Role object.</para></wadl:doc>
</param> &roleResponse; <param name="roles_links"
style="plain" required="true" type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Role links.</para></wadl:doc>
</param>
<representation mediaType="application/xml"
element="identity:roles">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -597,6 +590,17 @@
<xsdxt:code href="../OS-KSADM/samples/roles.json"
/>
</wadl:doc>
<param name="roles" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Role
object.</para></wadl:doc>
</param> &roleResponse; <param name="roles_links"
style="plain" required="true" type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Role
links.</para></wadl:doc>
</param>
</representation>
</response> &commonFaults; &getFaults; </method>
@@ -621,10 +625,7 @@
</representation>
</request>
<response status="201">
<param name="Location" type="xsd:anyURI" style="header">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The location.</wadl:doc>
</param>
<representation mediaType="application/xml"
element="identity:role">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -637,6 +638,11 @@
xml:lang="EN">
<xsdxt:code href="../OS-KSADM/samples/role.json"/>
</wadl:doc>
<param name="Location" type="xsd:anyURI"
style="header">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The location.</wadl:doc>
</param>
</representation>
</response> &commonFaults; &postPutFaults; &getFaults; </method>
<method name="GET" id="getRoleByName">
@@ -644,11 +650,7 @@
title="Get role information by name">
<para role="shortdesc">Gets a role by name.</para>
</wadl:doc>
<response status="200 203"> &roleResponse; <param
name="Location" type="xsd:anyURI" style="header">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The location.</wadl:doc>
</param>
<response status="200 203">
<representation mediaType="application/xml"
element="identity:role">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -660,7 +662,11 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="../OS-KSADM/samples/role.json"/>
</wadl:doc>
</wadl:doc> &roleResponse; <param name="Location"
type="xsd:anyURI" style="header">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The location.</wadl:doc>
</param>
</representation>
</response> &commonFaults; &postPutFaults; &getFaults; </method>
@@ -670,11 +676,7 @@
<para role="shortdesc">Gets information for a specified
role.</para>
</wadl:doc>
<response status="200 203"> &roleResponse; <param
name="Location" type="xsd:anyURI" style="header">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The location.</wadl:doc>
</param>
<response status="200 203">
<representation mediaType="application/xml"
element="identity:role">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -686,7 +688,11 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="../OS-KSADM/samples/role.json"/>
</wadl:doc>
</wadl:doc> &roleResponse; <param name="Location"
type="xsd:anyURI" style="header">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The location.</wadl:doc>
</param>
</representation>
</response> &commonFaults; &postPutFaults; &getFaults; </method>
@@ -789,10 +795,6 @@
</representation>
</request>
<response status="201">
<param name="Location" type="xsd:anyURI" style="header">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The location.</wadl:doc>
</param>
<representation mediaType="application/xml"
element="service">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -807,6 +809,11 @@
<xsdxt:code
href="../OS-KSADM/samples/service.json"/>
</wadl:doc>
<param name="Location" type="xsd:anyURI"
style="header">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The location.</wadl:doc>
</param>
</representation>
</response> &commonFaults; &postPutFaults; &getFaults; </method>
<method name="DELETE" id="deleteService">

431
api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSCATALOG-admin.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2011-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2011-2014 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
@@ -30,33 +30,77 @@
<!--*******************************************************-->
<!-- We should use SSL in production -->
<resources base="http://localhost:35357" xml:id="OS-KSCATALOG-admin-v2.0">
<resources base="http://localhost:35357"
xml:id="OS-KSCATALOG-admin-v2.0">
<resource id="version" path="//v2.0">
<resource id="tenants" path="tenants">
<param name="X-Auth-Token" style="header" type="xsd:string" required="true"><doc>A valid authentication token for an administrative user.</doc></param>
<param name="X-Auth-Token" style="header"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>A valid authentication
token for an administrative
user.</para></wadl:doc>
</param>
<resource id="tenantId" path="{tenantId}">
<param name="tenantId" style="template" type="xsd:string"><doc>The tenant ID.</doc></param>
<resource id="endpoints-OS-KSCATALOG" path="OS-KSCATALOG">
<param name="tenantId" style="template"
type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The tenant
ID.</para></wadl:doc>
</param>
<resource id="endpoints-OS-KSCATALOG"
path="OS-KSCATALOG">
<resource id="endpoints" path="endpoints">
<method href="#listEndpoints"/>
<method href="#addEndpoint"/>
<resource id="endpoint" path="{endpointId}">
<param name="endpointId" style="template" type="xsd:string"><doc>The endpoint ID.</doc></param>
<resource id="endpoint"
path="{endpointId}">
<param name="endpointId"
style="template" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The endpoint
ID.</para></wadl:doc>
</param>
<method href="#getEndpoint"/>
<method href="#deleteEndpoint"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resource>
<resource id="role-service-OS-KSCATALOG" path="OS-KSCATALOG">
<resource id="endpointTemplates" path="endpointTemplates">
<param name="X-Auth-Token" style="header" type="xsd:string" required="true"><doc>A valid authentication token for an administrative user.</doc></param>
<param name="serviceId" style="query" required="false" type="xsd:string"><doc>The service ID.</doc></param><method href="#listEndpointTemplates"/>
<resource id="role-service-OS-KSCATALOG"
path="OS-KSCATALOG">
<resource id="endpointTemplates"
path="endpointTemplates">
<param name="X-Auth-Token" style="header"
type="xsd:string" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>A valid authentication
token for an administrative
user.</para></wadl:doc>
</param>
<param name="serviceId" style="query"
required="false" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The service
ID.</para></wadl:doc>
</param>
<method href="#listEndpointTemplates"/>
<method href="#addEndpointTemplate"/>
<resource id="endpointTemplateId" path="{endpointTemplateId}">
<!-- <param name="X-Auth-Token" style="header" type="xsd:string" required="true"/> -->
<param name="endpointTemplateId" style="template" type="xsd:string"><doc>The endpoint template ID.</doc></param>
<resource id="endpointTemplateId"
path="{endpointTemplateId}">
<!-- <param name="X-Auth-Token" style="header" type="xsd:string" required="true"/> -->
<param name="endpointTemplateId"
style="template" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The endpoint
template ID.</para></wadl:doc>
</param>
<method href="#getEndpointTemplate"/>
<method href="#updateEndpointTemplate"/>
<method href="#deleteEndpointTemplate"/>
@@ -73,205 +117,256 @@
<!-- EndPoint Templates -->
<method name="GET" id="listEndpointTemplates">
<doc xml:lang="EN" title="List Endpoint Templates">
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc">Lists endpoint templates.</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List endpoint templates">
<para role="shortdesc">Lists endpoint templates.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/xml" element="endpointTemplates">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplates.xml"/>
</doc>
</representation>
<representation mediaType="application/xml"
element="endpointTemplates">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpointTemplates.xml"
/>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplates.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
</method>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpointTemplates.json"
/>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="GET" id="getEndpointTemplate">
<doc xml:lang="EN" title="Get Endpoint Template">
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc">Gets endpoint templates.</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get endpoint template">
<para role="shortdesc">Gets endpoint templates.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/xml" element="endpointTemplate">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplate.xml"/>
</doc>
</representation>
<representation mediaType="application/xml"
element="endpointTemplate">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpointTemplate.xml"
/>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplate.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
</method>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpointTemplate.json"
/>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="POST" id="addEndpointTemplate">
<doc xml:lang="EN" title="Add Endpoint Template">
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc">Adds endpoint template.</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add endpoint template">
<para role="shortdesc">Adds endpoint template.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="endpointTemplate">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplate.xml"/>
</doc>
</representation>
<representation mediaType="application/xml"
element="endpointTemplate">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpointTemplate.xml"
/>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplate.json"/>
</doc>
</representation>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpointTemplate.json"
/>
</wadl:doc>
</representation>
</request>
<response status="201">
<representation mediaType="application/xml" element="endpointTemplate">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplate.xml"/>
</doc>
<param name="Location" type="xsd:anyURI" style="header"/>
<representation mediaType="application/xml"
element="endpointTemplate">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpointTemplate.xml"
/>
</wadl:doc>
<param name="Location" type="xsd:anyURI"
style="header"/>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplate.json"/>
</doc>
<param name="Location" type="xsd:anyURI" style="header"/>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpointTemplate.json"
/>
</wadl:doc>
<param name="Location" type="xsd:anyURI"
style="header"/>
</representation>
</response>
&commonFaults;
&getFaults;
&postPutFaults;
</method>
</response> &commonFaults; &getFaults; &postPutFaults; </method>
<method name="PUT" id="updateEndpointTemplate">
<doc xml:lang="EN" title="Update Endpoint Template">
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc">Updates endpoint template.</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update endpoint template">
<para role="shortdesc">Updates endpoint template.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="endpointTemplate">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplate.xml"/>
</doc>
<representation mediaType="application/xml"
element="endpointTemplate">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpointTemplate.xml"
/>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplate.json"/>
</doc>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpointTemplate.json"
/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="endpointTemplate">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplate.xml"/>
</doc>
<representation mediaType="application/xml"
element="endpointTemplate">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpointTemplate.xml"
/>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplate.json"/>
</doc>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpointTemplate.json"
/>
</wadl:doc>
</representation>
</response>
&commonFaults;
&getFaults;
&postPutFaults;
</method>
</response> &commonFaults; &getFaults; &postPutFaults; </method>
<method name="DELETE" id="deleteEndpointTemplate">
<doc xml:lang="EN" title="Delete Endpoint Template.">
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc">Deletes an endpoint template.</p>
</doc>
<response status="204"/>
&commonFaults;
&getFaults;
</method>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete endpoint template.">
<para role="shortdesc">Deletes an endpoint
template.</para>
</wadl:doc>
<response status="204"/> &commonFaults; &getFaults; </method>
<method name="POST" id="addEndpoint">
<doc xml:lang="EN" title="Add Endpoint">
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc">Adds endpoint to a tenant.</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add endpoint">
<para role="shortdesc">Adds endpoint to a tenant.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="endpointTemplate">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplateWithOnlyId.xml"/>
</doc>
<param name="endpoint" style="plain" path="/"
type="EndpointTemplateWithOnlyId"/>
</representation>
<representation mediaType="application/xml"
element="endpointTemplate">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpointTemplateWithOnlyId.xml"
/>
</wadl:doc>
<param name="endpoint" style="plain" path="/"
type="EndpointTemplateWithOnlyId"/>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpointTemplateWithOnlyId.json"/>
</doc>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpointTemplateWithOnlyId.json"
/>
</wadl:doc>
</representation>
</request>
<response status="201">
<representation mediaType="application/xml" element="identity:endpoint">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpoint.xml"/>
</doc>
<param name="Location" type="xsd:anyURI" style="header"/>
<representation mediaType="application/xml"
element="identity:endpoint">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpoint.xml"/>
</wadl:doc>
<param name="Location" type="xsd:anyURI"
style="header"/>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpoint.json"/>
</doc>
<param name="Location" type="xsd:anyURI" style="header"/>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpoint.json"/>
</wadl:doc>
<param name="Location" type="xsd:anyURI"
style="header"/>
</representation>
</response>
&commonFaults;
&getFaults;
&postPutFaults;
</method>
</response> &commonFaults; &getFaults; &postPutFaults; </method>
<method name="GET" id="listEndpoints">
<doc xml:lang="EN" title="List Endpoints">
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc">Lists endpoints for a tenant.</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List endpoints">
<para role="shortdesc">Lists endpoints for a
tenant.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/xml" element="identity:endpoints">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpoints.xml"/>
</doc>
</representation>
<representation mediaType="application/xml"
element="identity:endpoints">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpoints.xml"/>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpoints.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
</method>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpoints.json"
/>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="GET" id="getEndpoint">
<doc xml:lang="EN" title="Get Endpoint">
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc">Gets endpoint for a tenant.</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get endpoint">
<para role="shortdesc">Gets endpoint for a tenant.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/xml" element="identity:endpoint">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpoint.xml"/>
</doc>
</representation>
<representation mediaType="application/xml"
element="identity:endpoint">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpoint.xml"/>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../OS-KSCATALOG/samples/endpoint.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
</method>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../OS-KSCATALOG/samples/endpoint.json"/>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="DELETE" id="deleteEndpoint">
<doc xml:lang="EN" title="Delete Endpoint.">
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc">Deletes an endpoint from a tenant.</p>
</doc>
<response status="204"/>
&commonFaults;
&getFaults;
</method>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete endpoint">
<para role="shortdesc">Deletes an endpoint from a
tenant.</para>
</wadl:doc>
<response status="204"/> &commonFaults; &getFaults; </method>
</application>

56
api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSEC2-admin.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2011-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2011-2014 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
@@ -31,13 +31,14 @@
<!--*******************************************************-->
<!-- We should use SSL in production -->
<resources base="http://localhost:35357" xml:id="OS-KSEC2-admin-v2.0">
<resources base="http://localhost:35357"
xml:id="OS-KSEC2-admin-v2.0">
<resource id="version" path="//v2.0">
<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.</wadl:doc>
xml:lang="EN"><para>A valid authentication
token.</para></wadl:doc>
</param>
<resource id="users" path="users">
<resource id="userById" path="{userId}">
@@ -45,7 +46,8 @@
required="true" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The user ID.</wadl:doc>
xml:lang="EN"><para>The user
ID.</para></wadl:doc>
</param>
<resource id="user-OS-KSADM" path="OS-KSADM">
<resource id="userCredentials"
@@ -54,34 +56,38 @@
<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>
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The ID of the
last item in the previous
list.</para></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.
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The page
size.</para>
</wadl:doc>
</param>
<method href="#listCredentials"/>
<method href="#listCredentials"/>
<method href="#addUserCredential"/>
<resource id="userCredentialsByType"
path="OS-KSEC2:ec2Credentials">
<method href="#getUserCredential"/>
<method href="#updateUserCredential"/>
<method href="#deleteUserCredential"/>
<resource id="type" path="{type}"> <param name="type" style="query"
required="true" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The credential type.
</para></wadl:doc>
</param><method href="#listCredentialsByType"/></resource>
<resource id="userCredentialsByType"
path="OS-KSEC2:ec2Credentials">
<method href="#getUserCredential"/>
<method href="#updateUserCredential"/>
<method href="#deleteUserCredential"/>
<resource id="type" path="{type}">
<param name="type" style="query"
required="true" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The credential
type.</para></wadl:doc>
</param>
<method
href="#listCredentialsByType"/>
</resource>
</resource>
</resource>
</resource>
</resource>

54
api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSS3-admin.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2011-2013 OpenStack Foundation., All Rights Reserved -->
<!-- (C) 2011-2014 OpenStack Foundation., All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
@@ -30,13 +30,14 @@
<!--*******************************************************-->
<!-- We should use SSL in production -->
<resources base="http://localhost:35357" xml:id="OS-KSS3-admin-v2.0">
<resources base="http://localhost:35357"
xml:id="OS-KSS3-admin-v2.0">
<resource id="version" path="//v2.0">
<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.</wadl:doc>
xml:lang="EN"><para>A valid authentication
token.</para></wadl:doc>
</param>
<resource id="users" path="users">
<resource id="userById" path="{userId}">
@@ -44,7 +45,8 @@
required="true" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The user ID.</wadl:doc>
xml:lang="EN"><para>The user
ID.</para></wadl:doc>
</param>
<resource id="user-OS-OS-KSS3" path="OS-OS-KSS3">
<resource id="userCredentials"
@@ -53,15 +55,16 @@
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>
xml:lang="EN"><para>The ID of the
last item in the previous
list.</para></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.
xml:lang="EN"><para>The page
size.</para>
</wadl:doc>
</param>
<method href="#listCredentials"/>
@@ -71,13 +74,17 @@
<method href="#getUserCredential"/>
<method href="#updateUserCredential"/>
<method href="#deleteUserCredential"/>
<resource id="type" path="{type}"> <param name="type" style="query"
required="true" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The credential type.
</para></wadl:doc>
</param><method href="#listCredentialsByType"/></resource>
<resource id="type" path="{type}">
<param name="type" style="query"
required="true" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The credential
type.</para></wadl:doc>
</param>
<method
href="#listCredentialsByType"/>
</resource>
</resource>
</resource>
</resource>
@@ -90,10 +97,10 @@
<!-- All Methods -->
<!--*******************************************************-->
<!-- User Credentials-->
<!-- user credentials-->
<method name="POST" id="addUserCredential">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add User Credential.">
title="Add user credential">
<para role="shortdesc">Adds a credential to a user.</para>
</wadl:doc>
<request>
@@ -133,10 +140,9 @@
<method name="GET" id="listCredentials">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Credentials">
title="List credentials">
<para role="shortdesc">Lists credentials.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/xml"
element="identity:credentials">
@@ -159,7 +165,7 @@
<method name="GET" id="listCredentialsByType">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Credentials by Type">
title="List credentials by type">
<para role="shortdesc" class="shortdesc">Lists credentials
by type.</para>
</wadl:doc>
@@ -185,7 +191,7 @@
<method name="POST" id="updateUserCredential">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update User Credentials">
title="Update user credentials">
<para role="shortdesc" class="shortdesc">Updates
credentials.</para>
</wadl:doc>
@@ -226,7 +232,7 @@
<method name="DELETE" id="deleteUserCredential">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete User Credentials">
title="Delete user credentials">
<para role="shortdesc" class="shortdesc">Deletes user
credentials.</para>
</wadl:doc>
@@ -235,7 +241,7 @@
<method name="GET" id="getUserCredential">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get User Credentials">
title="Get user credentials">
<para role="shortdesc" class="shortdesc">Gets user
credentials.</para>
</wadl:doc>

117
api-ref/src/wadls/identity-api/src/v2.0/wadl/OS-KSVALIDATE-admin.wadl
View File

@@ -10,7 +10,6 @@
<!ENTITY % common SYSTEM "common.ent">
%common;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:identity="http://docs.openstack.org/identity/api/v2.0"
xmlns:HP-IDM="http://docs.openstack.org/identity/api/ext/HP-IDM/v1.0"
@@ -29,7 +28,8 @@
<!--*******************************************************-->
<!-- We should use SSL in production -->
<resources base="http://localhost:35357" xml:id="OS-KSVALIDATE-admin-v2.0">
<resources base="http://localhost:35357"
xml:id="OS-KSVALIDATE-admin-v2.0">
<resource id="version" path="//v2.0">
<resource id="extension" path="OS-KSVALIDATE">
<resource id="token" path="token">
@@ -38,14 +38,18 @@
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>
xml:lang="EN"><para>A valid
authentication token for an
administrative
user.</para></wadl:doc>
</param>
<param name="X-Subject-Token" style="header"
type="xsd:string" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">A valid authentication token.</wadl:doc>
xml:lang="EN"><para>A valid
authentication
token.</para></wadl:doc>
</param>
<param name="belongsTo" style="query"
required="false" type="xsd:string">
@@ -71,25 +75,30 @@
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>
xml:lang="EN"><para>A valid
authentication token for an
administrative
user.</para></wadl:doc>
</param>
<param name="X-Subject-Token" style="header"
type="xsd:string" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">A valid authentication token.</wadl:doc>
xml:lang="EN"><para>A valid
authentication
token.</para></wadl:doc>
</param>
<param name="HP-IDM-serviceId" style="query"
type="xsd:string" required="false">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">A comma-separated string of service
IDs. Checks the roles against the
specified service IDs. If a service ID
is not valid or if no roles are
associated with a service ID, a 401
fault is returned.</wadl:doc>
xml:lang="EN"><para>A comma-separated
string of service IDs. Checks the
roles against the specified service
IDs. If a service ID is not valid
or if no roles are associated with
a service ID, a 401 fault is
returned.</para></wadl:doc>
</param>
<method href="#listEndpointsForToken"/>
</resource>
@@ -102,31 +111,30 @@
<!-- All Methods -->
<!--*******************************************************-->
<!-- Token Operations -->
<!-- token Operations -->
<method name="GET" id="validateToken">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Validate Token">
<para role="shortdesc">
Checks that a token is valid and that it belongs to a
specified tenant and service IDs. Returns the
permissions for a particular client.</para>
<para>Behavior is
similar to <code>/tokens/{tokenId}</code>. An
itemNotFound (<code>404</code>) fault is returned for
a token that is not valid.</para>
<para>This extension
might decrypt <code>X-Subject-Token</code> header and internally
call the normal validation for Identity,
passing in all headers and query parameters. It should
therefore support all existing calls on
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Validate token">
<para role="shortdesc">Checks that a token is valid and
that it belongs to a specified tenant and service IDs.
Returns the permissions for a particular
client.</para>
<para>Behavior is similar to
<code>/tokens/{tokenId}</code>. An itemNotFound
(<code>404</code>) fault is returned for a token
that is not valid.</para>
<para>This extension might decrypt
<code>X-Subject-Token</code> header and internally
call the normal validation for Identity, passing in
all headers and query parameters. It should therefore
support all existing calls on
<code>/tokens/{tokenId}</code>, including
extensions such as HP-IDM.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/xml"
element="identity:access">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../OS-KSVALIDATE/samples/validatetoken.xml"
@@ -134,8 +142,7 @@
</wadl:doc>
</representation>
<representation mediaType="application/json">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../OS-KSVALIDATE/samples/validatetoken.json"
@@ -144,35 +151,34 @@
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="HEAD" id="checkToken">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Check Token">
<para role="shortdesc">
Checks that a token is valid and that it belongs to a
specified tenant and service IDs, for performance.</para>
<para>Behavior is
similar to <code>/tokens/{tokenId}</code>. An
itemNotFound (<code>404</code>) fault is returned for
a token that is not valid.</para>
<para>This extension
might decrypt <code>X-Subject-Token</code> header and internally
call the normal validation for Identity,
passing in all headers and query parameters. It should
therefore support all existing calls on
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Check token">
<para role="shortdesc">Checks that a token is valid and
that it belongs to a specified tenant and service IDs,
for performance.</para>
<para>Behavior is similar to
<code>/tokens/{tokenId}</code>. An itemNotFound
(<code>404</code>) fault is returned for a token
that is not valid.</para>
<para>This extension might decrypt
<code>X-Subject-Token</code> header and internally
call the normal validation for Identity, passing in
all headers and query parameters. It should therefore
support all existing calls on
<code>/tokens/{tokenId}</code>, including
extensions such as HP-IDM.</para>
</wadl:doc>
<response status="200 203"/> &commonFaults; &getFaults; </method>
<method name="GET" id="listEndpointsForToken">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="List Endpoints for a Token">
<para>Lists endpoints
associated with a specific token.</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List endpoints for a token">
<para role="shortdesc">Lists endpoints associated with a
specific token.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/xml"
element="identity:endpoints">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../OS-KSVALIDATE/samples/endpoints.xml"
@@ -180,8 +186,7 @@
</wadl:doc>
</representation>
<representation mediaType="application/json">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../OS-KSVALIDATE/samples/endpoints.json"

387
api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-GRPADM.wadl
View File

@@ -12,12 +12,13 @@
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:identity="http://docs.openstack.org/identity/api/v2.0"
xmlns:grp="http://docs.rackspace.com/identity/api/ext/RAX-KSGRP/v1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:db="http://docbook.org/ns/docbook"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0">
xmlns:identity="http://docs.openstack.org/identity/api/v2.0"
xmlns:grp="http://docs.rackspace.com/identity/api/ext/RAX-KSGRP/v1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:db="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0">
<grammars>
<include href="../xsd/api.xsd"/>
</grammars>
@@ -26,33 +27,38 @@
<resource id="version" path="//v2.0">
<resource id="RAX-GRPADM" path="RAX-GRPADM">
<resource id="groups" path="groups" type="#GroupList">
<param name="X-Auth-Token" style="header" type="xsd:string" required="true">
<doc xml:lang="EN" title="Auth Token">
<p xmlns="http://www.w3.org/1999/xhtml">
A valid authentication token for an administrative user.
</p>
</doc>
<param name="X-Auth-Token" style="header"
type="xsd:string" required="true">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>A valid authentication token for an
administrative user.</para>
</wadl:doc>
</param>
<method href="#addGroup"/>
<resource id="group" path="{groupId}">
<param name="groupId" style="template" type="xsd:string">
<doc xml:lang="EN" title="GroupId">
<p xmlns="http://www.w3.org/1999/xhtml">
The group ID.
</p>
</doc>
<param name="groupId" style="template"
type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="GroupId">
<para>The group ID.</para>
</wadl:doc>
</param>
<method href="#getGroup"/>
<method href="#updateGroup"/>
<method href="#deleteGroup"/>
<resource id="users" path="users" type="#UserList">
<resource id="users" path="users"
type="#UserList">
<resource id="user" path="{userId}">
<param name="userId" style="template" type="xsd:string">
<doc xml:lang="EN" title="GroupId">
<p xmlns="http://www.w3.org/1999/xhtml">
The user ID.
</p>
</doc>
<param name="userId" style="template"
type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="GroupId">
<para>The user ID.</para>
</wadl:doc>
</param>
<method href="#addUserToGroup"/>
<method href="#removeUserFromGroup"/>
@@ -65,233 +71,248 @@
</resources>
<resource_type id="UserList">
<doc xml:lang="EN" title="Volume List">
<p xmlns="http://www.w3.org/1999/xhtml">
A list of users.
</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Volume List">
<para>A list of users.</para>
</wadl:doc>
<method href="#listUsersForGroup"/>
</resource_type>
<resource_type id="GroupList">
<doc xml:lang="EN" title="Volume List">
<p xmlns="http://www.w3.org/1999/xhtml">
A list of groups.
</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Volume List">
<para>A list of groups.</para>
</wadl:doc>
<param name="marker" style="query" required="false"
type="xsd:string">
<doc>The ID of the last item in the previous
list.</doc>
<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">
<doc>The page size. </doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The page size. </wadl:doc>
</param>
<param name="name" style="query" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">The group name.</wadl:doc>
</param>
<param name="name" style="query" required="false" type="xsd:string"><doc>The group name.</doc></param>
<method href="#listGroups"/>
</resource_type>
<!-- Methods -->
<method id="listGroups" name="GET">
<doc xml:lang="EN" title="List Groups">
<p xmlns="http://www.w3.org/1999/xhtml" role="shortdesc">
Lists groups.
</p>
</doc>
<method id="listGroups" name="GET">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List groups">
<para role="shortdesc">Lists groups.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/xml" element="grp:groups">
<doc xml:lang="EN">
<xsdxt:code href="../RAX-GRPADM/samples/groups.xml"/>
</doc>
<representation mediaType="application/xml"
element="grp:groups">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-GRPADM/samples/groups.xml"/>
</wadl:doc>
<param name="next" style="plain" type="xsd:anyURI"
path="/grp:groups/atom:link[@rel='next']/@href">
path="/grp:groups/atom:link[@rel='next']/@href">
<link resource_type="#GroupList" rel="next"/>
</param>
<param name="previous" style="plain" type="xsd:anyURI"
path="/grp:groups/atom:link[@rel='previous']/@href">
path="/grp:groups/atom:link[@rel='previous']/@href">
<link resource_type="#GroupList" rel="previous"/>
</param>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../RAX-GRPADM/samples/groups.json"/>
</doc>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-GRPADM/samples/groups.json"/>
</wadl:doc>
</representation>
</response>
<!-- commonFaults -->
&commonFaults;
</method>
<method id="addGroup" name="POST">
<doc xml:lang="EN" title="Add a New Group">
<p xmlns="http://www.w3.org/1999/xhtml" role="shortdesc">
Adds a group.
</p>
</doc>
<!-- commonFaults --> &commonFaults; </method>
<method id="addGroup" name="POST">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add group">
<para role="shortdesc">Adds a group.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="grp:group">
<doc xml:lang="EN">
<xsdxt:code href="../RAX-GRPADM/samples/group-for-create.xml" />
</doc>
<representation mediaType="application/xml"
element="grp:group">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-GRPADM/samples/group-for-create.xml"
/>
</wadl:doc>
<param name="group" style="plain" required="true"
type="grp:GroupForCreate"
path="/grp:group"/>
type="grp:GroupForCreate" path="/grp:group"/>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../RAX-GRPADM/samples/group-for-create.json" />
</doc>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-GRPADM/samples/group-for-create.json"
/>
</wadl:doc>
</representation>
</request>
<response status="201">
<param name="Location" style="header"
required="true" type="xsd:anyURI">
<doc xml:lang="EN" title="Location Header">
<p xmlns="http://www.w3.org/1999/xhtml">
The full URL to the new group is
returned in the <code>Location</code>
header.
</p>
</doc>
</param>
<representation mediaType="application/xml" element="grp:group">
<doc xml:lang="EN">
<xsdxt:code href="../RAX-GRPADM/samples/group.xml" />
</doc>
<representation mediaType="application/xml"
element="grp:group">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="../RAX-GRPADM/samples/group.xml"
/>
</wadl:doc>
<param name="Location" style="header" required="true"
type="xsd:anyURI">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Location Header">
<para>The full URL to the new group is
returned in the <code>Location</code>
header.</para>
</wadl:doc>
</param>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../RAX-GRPADM/samples/group.json" />
</doc>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-GRPADM/samples/group.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults;
&getFaults;
&postPutFaults;
</method>
</response> &commonFaults; &getFaults; &postPutFaults; </method>
<method id="getGroup" name="GET">
<doc xml:lang="EN" title="Get Group Information">
<p xmlns="http://www.w3.org/1999/xhtml" role="shortdesc">
Gets information for a group by ID.
</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get group information">
<para role="shortdesc">Gets information for a group by
ID.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/xml" element="grp:group">
<doc xml:lang="EN">
<xsdxt:code href="../RAX-GRPADM/samples/group.xml"/>
</doc>
<representation mediaType="application/xml"
element="grp:group">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="../RAX-GRPADM/samples/group.xml"
/>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../RAX-GRPADM/samples/group.json"/>
</doc>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-GRPADM/samples/group.json"/>
</wadl:doc>
</representation>
</response>
<!-- Common, GET -->
&commonFaults;
&getFaults;
</method>
<method id="updateGroup" name="PUT">
<doc xml:lang="EN" title="Update Group">
<p xmlns="http://www.w3.org/1999/xhtml" role="shortdesc">
Updates a group.
</p>
</doc>
<!-- Common, GET --> &commonFaults; &getFaults; </method>
<method id="updateGroup" name="PUT">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update group">
<para role="shortdesc">Updates a group.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="grp:group">
<doc xml:lang="EN">
<xsdxt:code href="../RAX-GRPADM/samples/group-for-update.xml" />
</doc>
<representation mediaType="application/xml"
element="grp:group">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-GRPADM/samples/group-for-update.xml"
/>
</wadl:doc>
<param name="group" style="plain" required="true"
type="grp:GroupForUpdate"
path="/grp:group"/>
type="grp:GroupForUpdate" path="/grp:group"/>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../RAX-GRPADM/samples/group-for-update.json" />
</doc>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-GRPADM/samples/group-for-update.json"
/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="grp:group">
<doc xml:lang="EN">
<xsdxt:code href="../RAX-GRPADM/samples/group-updated.xml" />
</doc>
<representation mediaType="application/xml"
element="grp:group">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-GRPADM/samples/group-updated.xml"
/>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../RAX-GRPADM/samples/group-updated.json" />
</doc>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-GRPADM/samples/group-updated.json"
/>
</wadl:doc>
</representation>
</response>
&commonFaults;
&getFaults;
&postPutFaults;
</method>
</response> &commonFaults; &getFaults; &postPutFaults; </method>
<method id="deleteGroup" name="DELETE">
<doc xml:lang="EN" title="Delete Group">
<p xmlns="http://www.w3.org/1999/xhtml" role="shortdesc">
Deletes a group.
</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete group">
<para role="shortdesc">Deletes a group.</para>
</wadl:doc>
<response status="204"/>
<!-- Common, GET -->
&commonFaults;
&getFaults;
</method>
<!-- Common, GET --> &commonFaults; &getFaults; </method>
<method id="listUsersForGroup" name="GET">
<doc xml:lang="EN" title="List Users for Group">
<p xmlns="http://www.w3.org/1999/xhtml" role="shortdesc">
Lists users for a group.
</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List users for group">
<para role="shortdesc">Lists users for a group.</para>
</wadl:doc>
<request>
<param name="marker" style="query" required="false" type="xsd:string"/>
<param name="limit" style="query" required="false" type="xsd:int"/>
<representation mediaType="application/xml">
<param name="marker" style="query" required="false"
type="xsd:string"/>
<param name="limit" style="query" required="false"
type="xsd:int"/>
</representation>
</request>
<response status="200 203">
<representation mediaType="application/xml" element="identity:users">
<doc xml:lang="EN">
<xsdxt:code href="../RAX-GRPADM/samples/users.xml"/>
</doc>
<representation mediaType="application/xml"
element="identity:users">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="../RAX-GRPADM/samples/users.xml"
/>
</wadl:doc>
<param name="next" style="plain" type="xsd:anyURI"
path="/identity:users/atom:link[@rel='next']/@href">
path="/identity:users/atom:link[@rel='next']/@href">
<link resource_type="#UserList" rel="next"/>
</param>
<param name="previous" style="plain" type="xsd:anyURI"
path="/identity:users/atom:link[@rel='previous']/@href">
path="/identity:users/atom:link[@rel='previous']/@href">
<link resource_type="#UserList" rel="previous"/>
</param>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="../RAX-GRPADM/samples/users.json"/>
</doc>
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-GRPADM/samples/users.json"/>
</wadl:doc>
</representation>
</response>
<!-- commonFaults -->
&commonFaults;
</method>
<!-- commonFaults --> &commonFaults; </method>
<method id="addUserToGroup" name="PUT">
<doc xml:lang="EN" title="Add User to Group">
<p xmlns="http://www.w3.org/1999/xhtml" role="shortdesc">
Adds a user to a group.
</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add user to group">
<para role="shortdesc">Adds a user to a group.</para>
</wadl:doc>
<response status="204"/>
<!-- Common, GET -->
&commonFaults;
&getFaults;
</method>
<!-- Common, GET --> &commonFaults; &getFaults; </method>
<method id="removeUserFromGroup" name="DELETE">
<doc xml:lang="EN" title="Remove User from Group">
<p xmlns="http://www.w3.org/1999/xhtml" role="shortdesc">
Removes a user from a group.
</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Remove user from group">
<para role="shortdesc">Removes a user from a group.</para>
</wadl:doc>
<response status="204"/>
<!-- Common, GET -->
&commonFaults;
&getFaults;
</method>
<!-- Common, GET --> &commonFaults; &getFaults; </method>
</application>

50
api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-KSGRP-admin.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2011-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2011-2014 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
@@ -29,15 +29,26 @@
<!--*******************************************************-->
<!-- We should use SSL in production -->
<resources base="http://localhost:35357" xml:id="RAX-KSGRP-admin-v2.0">
<resources base="http://localhost:35357"
xml:id="RAX-KSGRP-admin-v2.0">
<resource id="version" path="//v2.0">
<param name="X-Auth-Token" style="header" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook">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"><para>A valid authentication token
for an administrative user.</para></wadl:doc>
</param>
<resource id="users" path="users">
<resource id="userById" path="{userId}">
<param name="userId" style="template" type="xsd:string"><wadl:doc xmlns="http://docbook.org/ns/docbook">The user ID.</wadl:doc></param>
<resource id="user-groups-RAX-KSGRP" path="RAX-KSGRP">
<param name="userId" style="template"
type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The user
ID.</para></wadl:doc>
</param>
<resource id="user-groups-RAX-KSGRP"
path="RAX-KSGRP">
<method href="#listUserGroups"/>
</resource>
</resource>
@@ -45,22 +56,27 @@
</resource>
</resources>
<method name="GET" id="listUserGroups">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List Groups for a User">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List groups for a user">
<para role="shortdesc">Lists groups for a user.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/xml" element="groups">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../RAX-KSGRP/samples/RAX-KSGRP-groups.xml"/>
<representation mediaType="application/xml"
element="groups">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../RAX-KSGRP/samples/RAX-KSGRP-groups.xml"
/>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../RAX-KSGRP/samples/RAX-KSGRP-groups.json"/>
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../RAX-KSGRP/samples/RAX-KSGRP-groups.json"
/>
</wadl:doc>
</representation>
</response>
&commonFaults;
&getFaults;
</method>
</application>
</response> &commonFaults; &getFaults; </method>
</application>

137
api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-KSKEY-admin.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2011-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2011-2014 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
@@ -28,18 +28,23 @@
<!-- All Resources -->
<!--*******************************************************-->
<!-- We should use SSL in production -->
<resources base="http://localhost:35357" xml:id="RAX-KSKEY-admin-v2.0">
<resources base="http://localhost:35357"
xml:id="RAX-KSKEY-admin-v2.0">
<resource id="version" path="//v2.0">
<param name="X-Auth-Token" style="header"
type="xsd:string" required="true">
<doc>A valid authentication token for an
administrative user.</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>A valid authentication token
for an administrative user.</para></wadl:doc>
</param>
<resource id="users" path="users">
<resource id="userById" path="{userId}">
<param name="userId" style="template"
required="true" type="xsd:string">
<doc>The user ID.</doc>
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The user
ID.</para></wadl:doc>
</param>
<resource id="user-OS-RAX-KSKEY"
path="OS-RAX-KSKEY">
@@ -50,17 +55,27 @@
<param name="X-Auth-Token"
style="header" type="xsd:string"
required="true">
<doc>A valid authentication token
for an administrative user.</doc>
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>A valid
authentication token for an
administrative
user.</para></wadl:doc>
</param>
<param name="marker" style="query"
required="false" type="xsd:string">
<doc>The ID of the last item in the
previous list.</doc>
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The ID of the
last item in the previous
list.</para></wadl:doc>
</param>
<param name="limit" style="query"
required="false" type="xsd:int">
<doc>The page size. </doc>
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The page
size.</para></wadl:doc>
</param>
<method href="#listCredentials"/>
</resource>
@@ -81,138 +96,150 @@
<!-- All Methods -->
<!--*******************************************************-->
<!-- User Credentials-->
<!-- user credentials-->
<method name="POST" id="addUserCredential">
<doc xml:lang="EN" title="Add user Credential">
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc"
>Adds a credential to a user.</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add user credential">
<para role="shortdesc">Adds a credential to a user.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml"
element="apiKeyCredentials">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSKEY/samples/apiKeyCredentials.xml"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSKEY/samples/apiKeyCredentials.json"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="201">
<representation mediaType="application/xml"
element="apiKeyCredentials">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSKEY/samples/apiKeyCredentials.xml"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSKEY/samples/apiKeyCredentials.json"
/>
</doc>
</wadl:doc>
</representation>
</response> &commonFaults; &postPutFaults; &getFaults; </method>
<method name="GET" id="listCredentials">
<doc xml:lang="EN" title="List Credentials">
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc"
>Lists credentials.</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List credentials">
<para role="shortdesc">Lists credentials.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/xml"
element="identity:credentials">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSKEY/samples/credentialswithapikey.xml"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSKEY/samples/credentialswithapikey.json"
/>
</doc>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="POST" id="updateUserCredential">
<doc xml:lang="EN" title="Update User Credentials">
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc"
>Updates credentials.</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update user credentials">
<para role="shortdesc">Updates credentials.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml"
element="apiKeyCredentials">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSKEY/samples/apiKeyCredentials.xml"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSKEY/samples/apiKeyCredentials.json"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml"
element="apiKeyCredentials">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSKEY/samples/apiKeyCredentials.xml"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSKEY/samples/apiKeyCredentials.json"
/>
</doc>
</wadl:doc>
</representation>
</response> &commonFaults; &postPutFaults; &getFaults; </method>
<method name="DELETE" id="deleteUserCredential">
<doc xml:lang="EN" title="Delete User Credentials">
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc"
>Deletes user credentials.</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete user credentials">
<para role="shortdesc">Deletes user credentials.</para>
</wadl:doc>
<response status="204"/> &commonFaults; &postPutFaults;
&getFaults; </method>
<method name="GET" id="getUserCredential">
<doc xml:lang="EN" title="Get User Credentials">
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc"
>Gets user credentials.</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get user credentials">
<para role="shortdesc">Gets user credentials.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/xml"
element="apiKeyCredentials">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSKEY/samples//apiKeyCredentials.xml"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSKEY/samples//apiKeyCredentials.json"
/>
</doc>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
</application>

63
api-ref/src/wadls/identity-api/src/v2.0/wadl/RAX-KSQA-admin.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2011-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2011-2014 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
@@ -34,14 +34,18 @@
<resource id="version" path="//v2.0">
<param name="X-Auth-Token" style="header"
type="xsd:string" required="true">
<doc>A valid authentication token for an
administrative user.</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>A valid authentication token
for an administrative user.</para></wadl:doc>
</param>
<resource id="users" path="users">
<resource id="userById" path="{userId}">
<param name="userId" style="template"
type="xsd:string">
<doc>The user ID.</doc>
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The user
ID.</para></wadl:doc>
</param>
<resource id="user-RAX-KSQA" path="RAX-KSQA">
<resource id="secretqa" path="secretqa">
@@ -54,67 +58,72 @@
</resource>
</resources>
<method name="GET" id="getUserSecretQA">
<doc xml:lang="EN" title="Get User Secret Question and Answer">
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc"
>Gets a secret question and answer for a specified
user.</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get user secret question and answer">
<para role="shortdesc">Gets a secret question and answer
for a specified user.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/xml"
element="secretQA">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSQA/samples/RAX-KSQA-secretQA.xml"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSQA/samples/RAX-KSQA-secretQA.json"
/>
</doc>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="PUT" id="updateUserSecretQA">
<doc xml:lang="EN"
title="Update User Secret Question and Answer">
<p xmlns="http://www.w3.org/1999/xhtml" class="shortdesc"
>Updates a secret question and answer for a specified
user.</p>
</doc>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update user secret question and answer">
<para role="shortdesc">Updates a secret question and
answer for a specified user.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml"
element="secretQA">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSQA/samples/RAX-KSQA-secretQA.xml"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSQA/samples/RAX-KSQA-secretQA.json"
/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml"
element="secretQA">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSQA/samples/RAX-KSQA-secretQA.xml"
/>
</doc>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../RAX-KSQA/samples/RAX-KSQA-secretQA.json"
/>
</doc>
</wadl:doc>
</representation>
</response> &commonFaults; &postPutFaults; </method>
</application>

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

@@ -199,11 +199,7 @@
of the Identity API.</para>
</wadl:doc>
<response status="200 203">
<!-- <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> -->
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
@@ -220,6 +216,11 @@
<xsdxt:code href="../samples/version.xml"/>
</xsdxt:sample>
</wadl:doc>
<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>
</representation>
</response> &commonFaults; &getFaults; </method>
<!-- Extensions -->
@@ -229,20 +230,7 @@
<para>Lists available extensions.</para>
</wadl:doc>
<response status="200 203">
<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>
<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"/>
</param>
<representation mediaType="application/json"
element="capi:extensions">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
@@ -252,6 +240,21 @@
/>
</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>
<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"/>
</param>
</representation>
<!-- <representation mediaType="application/xml"
element="capi:extensions">
@@ -318,67 +321,7 @@
are stored.</para>
</wadl:doc>
<request>
<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>
<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="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
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>
<representation mediaType="application/json"
element="identity:auth">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
@@ -400,6 +343,74 @@
/>
</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>
<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
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="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
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>
</representation>
<representation mediaType="application/json"
element="identity:auth">
@@ -424,114 +435,7 @@
</representation>
</request>
<response status="200 203">
<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>
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>
<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>
<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>
<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>
<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>
<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="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="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="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>
object.</para></wadl:doc>
</param>
<representation mediaType="application/json"
element="identity:access">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
@@ -550,6 +454,115 @@
<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>
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>
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>
<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>
<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>
<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>
<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>
<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="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="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="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>
object.</para></wadl:doc>
</param>
</representation>
</response>
<response status="403">
@@ -592,7 +605,7 @@
title="Validate token (admin)">
<para role="shortdesc">Validates a token and confirms that
it belongs to a specified tenant, for performance.
</para>
</para>
</wadl:doc>
<response status="200 203 204"/> &commonFaults; &getFaults; </method>
<method name="GET" id="listEndpointsForToken">
@@ -727,7 +740,6 @@
</xsdxt:sample>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="GET" id="getTenantByName">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
@@ -736,11 +748,14 @@
specified tenant by name.</para>
</wadl:doc>
<request>
<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 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
tenant.</wadl:doc>
</param>
</representation>
</request>
<response status="200 203">
<representation mediaType="application/json">

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

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2011-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2011-2014 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
@@ -146,27 +146,7 @@
<para role="shortdesc">Lists available extensions.</para>
</wadl:doc>
<response status="200 203">
<param name="next" style="plain" type="xsd:anyURI"
path="/capi:extensions/atom:link[@rel='next']/@href">
<wadl:doc
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Moves to the next item in the list.</para>
</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:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Moves to the previous item in the
list.</para>
</wadl:doc>
<link resource_type="#ExtensionList" rel="previous"/>
</param>
<representation mediaType="application/json"
element="capi:extensions">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
@@ -185,6 +165,29 @@
<xsdxt:code href="../samples/extensions.xml"/>
</xsdxt:sample>
</wadl:doc>
<param name="next" style="plain" type="xsd:anyURI"
path="/capi:extensions/atom:link[@rel='next']/@href">
<wadl:doc
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Moves to the next item in the
list.</para>
</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:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>Moves to the previous item in the
list.</para>
</wadl:doc>
<link resource_type="#ExtensionList"
rel="previous"/>
</param>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="GET" id="getExtension-v2.0">
@@ -241,67 +244,6 @@
are stored.</para>
</wadl:doc>
<request>
<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>
<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="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
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>
<representation mediaType="application/json"
element="identity:auth">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
@@ -321,6 +263,74 @@
href="../samples/auth_credentials.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>
<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
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="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
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>
</representation>
<representation mediaType="application/json"
element="identity:auth">
@@ -345,114 +355,7 @@
</representation>
</request>
<response status="200 203">
<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>
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>
<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>
<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>
<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>
<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>
<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="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="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="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>
object.</para></wadl:doc>
</param>
<representation mediaType="application/json"
element="identity:access">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
@@ -470,6 +373,115 @@
<xsdxt:code href="../samples/auth.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>
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>
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>
<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>
<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>
<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>
<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>
<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="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="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="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>
object.</para></wadl:doc>
</param>
</representation>
</response>
<response status="403">

2
api-ref/src/wadls/identity-api/src/v3/wadl/OS-OAUTH1-v3.wadl
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2011-2013 OpenStack Foundation, All Rights Reserved -->
<!-- (C) 2011-2014 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->

514
api-ref/src/wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl
View File

File diff suppressed because it is too large Load Diff

Some files were not shown because too many files have changed in this diff Show More