openstack/openstack-manuals
Code Issues Proposed changes

Bug #1030039 - added os-volumes, os-snapshots, os-volume-types

Browse Source 
Patchset:
moved the os-volume wadl to be a compute extension
renamed the volume API wadl to just volume-api.wadl
so that the os-volume extension wadl can be os-volume.wadl
fixes some problems with xml:lang referring to E instead of EN
Updates the pom to find the right new file name

Change-Id: I5f09526b329037a5862157751694d90abf9af13e
This commit is contained in:
Diane Fleming 2012-08-10 11:47:22 -05:00 committed by annegentle
parent 4b598f2e71
commit 5c5a47abdf
29 changed files with 1329 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/src/docbkx/openstack-api-site/pom.xml
View File

@ -105,7 +105,7 @@
<transformationSet>
<dir>src/wadls/volume-api/src</dir>
<includes>
<include>os-volume-*.wadl</include>
<include>volume-*.wadl</include>
</includes>
<stylesheet>${project.build.directory}/generated-resources/cloud/normalizeWadl/normalizeWadl.xsl</stylesheet>
</transformationSet>

186
doc/src/docbkx/openstack-api-site/src/docbkx/index.xml
View File

@ -1,11 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<book
xmlns="http://docbook.org/ns/docbook"
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org">
version="5.0-extension RackBook-2.0" xml:id="api.openstack.org">
<info>
<title>OpenStack APIs</title>
<copyright>
@ -24,25 +22,29 @@
OpenStack Identity Service, and OpenStack Image Service.</para>
<para>This page covers the basics for working with your OpenStack
cloud through the Compute API and Image API after authorizing with
the Identity Service API. You can build a cloud by launching
images and assigning metadata to instances, all through an
API. See the <link
xlink:href="http://docs.openstack.org/api/quick-start/content/">API Quick Start
Guide</link> for details about using the APIs referenced here, and
go to <link
xlink:href="http://docs.openstack.org/api/">docs.openstack.org/api</link>
for specifications of each API.
cloud through the Compute API and Image API after authorizing
with the Identity Service API. You can build a cloud by
launching images and assigning metadata to instances, all
through an API. See the <link
xlink:href="http://docs.openstack.org/api/quick-start/content/"
>API Quick Start Guide</link> for details about using the APIs
referenced here, and go to <link
xlink:href="http://docs.openstack.org/api/"
>docs.openstack.org/api</link> for specifications of each API.
</para>
</preface>
<chapter xml:id="identity">
<title>Identity</title>
<para>With the Identity API, you obtain a token that lasts 24 hours so you can gain access to the Compute API. The version of the Identity API is 2.0.</para>
<para>With the Identity API, you obtain a token that lasts 24
hours so you can gain access to the Compute API. The version of
the Identity API is 2.0.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/identity-api/src/service/identity.wadl#tokens" >
<wadl:resource
href="../wadls/identity-api/src/service/identity.wadl#tokens">
<wadl:method href="#authenticate"/>
</wadl:resource>
<wadl:resource href="../wadls/identity-api/src/service/identity.wadl#tenants" >
<wadl:resource
href="../wadls/identity-api/src/service/identity.wadl#tenants">
<wadl:method href="#listTenants"/>
</wadl:resource>
</wadl:resources>
@ -54,8 +56,7 @@
when needed, resize it larger or smaller, and connect to the
server securely through SSH once it is started. The v1.1 API is
identical to the v2 API.</para>
<wadl:resources
href="../wadls/compute-api/src/os-compute-2.wadl"
<wadl:resources href="../wadls/compute-api/src/os-compute-2.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</chapter>
<chapter xml:id="compute-ext">
@ -68,7 +69,8 @@
available with a GET request to v1.1/extensions.</para>
<section xml:id="ext-os-disk-config">
<title>Disk Config</title>
<para>Extends servers and images with a diskConfig attribute.</para>
<para>Extends servers and images with a diskConfig
attribute.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-disk-config.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
@ -103,16 +105,18 @@
</section>
<section xml:id="ext-os-extended-status">
<title>Extended Instance Status</title>
<para>Adds vm_state, task_state, and power_state to detailed server responses.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-extended-status.wadl"
<para>Adds vm_state, task_state, and power_state to detailed
server responses.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-extended-status.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-extended-server-attributes">
<title>Extended Server Attributes</title>
<para>Adds additional metadata to servers detail and show response.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-extended-server-attributes.wadl"
<para>Adds additional metadata to servers detail and show
response.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-extended-server-attributes.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-server-start-stop">
@ -124,19 +128,17 @@
</section>
<section xml:id="ext-os-deferred-delete">
<title>Server Force Delete/Restore</title>
<para>
When Nova is deployed with deferred delete on, restores or forces the deletion of a server.
</para>
<para> When Nova is deployed with deferred delete on, restores
or forces the deletion of a server. </para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-deferred-delete.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-floating-ip-addresses">
<title>Floating IPs</title>
<para>
The Floating IPs extension enables assigning and allocation of
floating IP addresses to instances running in an OpenStack cloud.
</para>
<para> The Floating IPs extension enables assigning and
allocation of floating IP addresses to instances running in an
OpenStack cloud. </para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-floating-ips.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
@ -150,32 +152,27 @@
</section>
<section xml:id="ext-os-floating-ip-dns">
<title>Floating IP DNS</title>
<para>
The Floating IP DNS extension provides an interface for
managing DNS records associated with IP addresses allocated
by the Floating Ips extension. Requests are dispatched to a
DNS driver selected at startup.
</para>
<para> The Floating IP DNS extension provides an interface for
managing DNS records associated with IP addresses allocated by
the Floating Ips extension. Requests are dispatched to a DNS
driver selected at startup. </para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-floating-ip-dns.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-networks">
<title>Networks</title>
<para>
The Networks extension allows you to view and delete networks. It
also provides an action to disassociate a network from a project
if you are using vlan mode.
</para>
<para> The Networks extension allows you to view and delete
networks. It also provides an action to disassociate a network
from a project if you are using vlan mode. </para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-networks.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-scheduler-hints">
<title>Scheduler Hints</title>
<para>
Provides information directly to the scheduler when creating a server.
</para>
<para> Provides information directly to the scheduler when
creating a server. </para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-scheduler-hints.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
@ -196,7 +193,8 @@
</section>
<section xml:id="ext-os-security-groups">
<title>Security Groups</title>
<para>Creates, modifies, and deletes security groups and rules.</para>
<para>Creates, modifies, and deletes security groups and
rules.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-security-groups.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
@ -211,58 +209,49 @@
<section xml:id="ext-os-hosts">
<title>Hosts</title>
<para>Manages physical hosts.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-hosts.wadl"
<wadl:resources
href="../wadls/compute-api/src/ext/os-hosts.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-flavormanage">
<title>Flavor Management</title>
<para>Creates and deletes flavors.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-flavormanage.wadl"
<wadl:resources
href="../wadls/compute-api/src/ext/os-flavormanage.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-flavorextradata">
<title>Flavors - Extra Data</title>
<para>
Allows extra attributes to be returned with flavor objects. This includes
'swap', 'rxtx_factor' and 'OS-FLV-EXT-DATA:ephemeral'.
</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-flavorextradata.wadl"
<para> Allows extra attributes to be returned with flavor
objects. This includes 'swap', 'rxtx_factor' and
'OS-FLV-EXT-DATA:ephemeral'. </para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-flavorextradata.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-aggregates">
<title>Host Aggregates</title>
<para>
Enables the creation and management of host aggregates. An aggregate
allows assigning metadata to groups of compute nodes. Aggregates are
only visible to the cloud provider.
</para>
<para> Enables the creation and management of host aggregates.
An aggregate allows assigning metadata to groups of compute
nodes. Aggregates are only visible to the cloud provider. </para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-aggregates.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-virtual-interfaces">
<title>Virtual Interfaces</title>
<para>Enables listing of Virtual Interfaces of running instances.</para>
<para>Enables listing of Virtual Interfaces of running
instances.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-virtual-interfaces.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="volume_attachments">
<title>Volume Attachments</title>
<para>Enables you to attach volumes created through the volume API to server instances. You can also
list volume attachments for a server instance, get volume details for a volume attachment, and delete a volume attachment.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-volume_attachments.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-used-limits">
<title>Used Limits</title>
<para>Extends limits to include information on the usage of per project
limits. Such as information on how much of the ram or instances quotas are
currently being used.</para>
<para>Extends limits to include information on the usage of per
project limits. Such as information on how much of the ram or
instances quotas are currently being used.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-used-limits.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
@ -270,28 +259,47 @@
</chapter>
<chapter xml:id="image">
<title>Image</title>
<para>Loads images for use at launch time
by the Compute API. Some cloud implementations do not expose
this API and offer pre-tested images only. You can also assign
metadata to images with this API. </para>
<wadl:resources
href="../wadls/image-api/src/os-image-1.0.wadl"
<para>Loads images for use at launch time by the Compute API. Some
cloud implementations do not expose this API and offer
pre-tested images only. You can also assign metadata to images
with this API. </para>
<wadl:resources href="../wadls/image-api/src/os-image-1.0.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</chapter>
<chapter xml:id="volume">
<title>Volume</title>
<para>Allows you to manage volumes and snapshots
that can be used with the Compute API.</para>
<wadl:resources
href="../wadls/volume-api/src/os-volume-1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
<chapter xml:id="volumes">
<title>Volumes</title>
<section xml:id="volume">
<title>Volume</title>
<para>Allows you to manage volumes and snapshots that can be
used with the Compute API.</para>
<wadl:resources href="../wadls/volume-api/src/volume-api.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-volume">
<title>Volume Extension to the Compute API</title>
<para>Allows you to manage volumes and snapshots that can be
used with the Compute API through an extension to the API.</para>
<wadl:resources href="../wadls/compute-api/src/ext/os-volume.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="volume_attachments">
<title>Volume Attachments</title>
<para>Enables you to attach volumes created through the volume
API to server instances. You can also list volume attachments
for a server instance, get volume details for a volume
attachment, and delete a volume attachment.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-volume_attachments.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
</chapter>
<chapter xml:id="object">
<title>Object Storage</title>
<para>Enables you to manage the accounts, containers and objects in the object storage system with APIs.</para>
<para>Enables you to manage the accounts, containers and objects
in the object storage system with APIs.</para>
<wadl:resources
href="../wadls/object-api/src/os-object-api-1.0.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</chapter>
</book>

84
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-flavormanage.wadl.bak Normal file
View File

@ -0,0 +1,84 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012 OpenStack LLC., 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">
<resources base="https://servers.api.openstack.com/">
<resource id="version" path="v1.1">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the tenant or account.
</p>
</doc>
</param>
<resource id="flavors" path="flavors">
<method href="#createFlavor" />
<resource id="flavor" path="{flavor_id}">
<param name="flavor_id" style="template">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the flavor.
</p></doc>
</param>
<method href="#deleteFlavor" />
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="POST" id="createFlavor">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Create a flavor.
</p>
</wadl:doc>
<request>
<param style="plain" name="name" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Enter a name for the new flavor you want to create</p></doc>
</param>
<param style="plain" name="ram" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Enter a MB value for the amount of RAM for this flavor.</p></doc>
</param>
<param style="plain" name="vcpus" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Enter a whole integer value for the virtual CPUs for the new flavor you want to create.</p></doc>
</param>
<param style="plain" name="disk" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Enter a GB value for the amount of disk space.</p></doc>
</param>
<param style="plain" name="id" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Enter a unique integer value for the identifier for the new flavor.</p></doc>
</param>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/os-flavormanage-request.json" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/os-flavormanage-response.json" />
</doc>
</representation>
</response>
</method>
<method name="DELETE" id="deleteFlavor">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">Delete a flavor.</p>
</wadl:doc>
<response status="204" />
</method>
</application>

147
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-floating-ip-dns.wadl.bak Normal file
View File

@ -0,0 +1,147 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012 OpenStack LLC., 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">
<resources base="https://servers.api.openstack.com">
<resource id="version" type="#VersionDetails" path="v1.1">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the tenant or account.
</p>
</doc>
</param>
<resource id="os-floating-ip-dns" path="os-floating-ip-dns">
<method href="#ListDomains" />
<resource path="{domain}">
<param name="domain" style="template" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
Registered DNS Domain published by the DNS drivers.
</p></doc>
</param>
<method href="#CreateDomain" />
<method href="#DeleteDomain" />
<resource id="entries" path="entries">
<resource path="{name}">
<param name="name" style="template" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
DNS entry name assigned under a domain.
</p></doc>
</param>
<method href="#CreateEntry" />
<method href="#FindUniqueEntry" />
<method href="#DeleteEntry" />
</resource>
<resource path="{ip}">
<method href="#FindEntriesbyIP" />
</resource>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="ListDomains">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="List DNS Domains">
<p xmlns="http://www.w3.org/1999/xhtml">Get a list of registered DNS Domains published by the DNS drivers.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_dns_list_response.json" />
</doc>
</representation>
</response>
</method>
<method name="PUT" id="CreateDomain">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Create a Domain">
<p xmlns="http://www.w3.org/1999/xhtml">Create or modify a DNS domain.</p>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_dns_create_domain_request.json" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_dns_create_domain_response.json" />
</doc>
</representation>
</response>
</method>
<method name="DELETE" id="DeleteDomain">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Delete a Domain">
<p xmlns="http://www.w3.org/1999/xhtml">Delete a DNS domain and all associated host entries.</p>
</wadl:doc>
<response status="200" />
</method>
<method name="PUT" id="CreateEntry">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Create DNS Entry">
<p xmlns="http://www.w3.org/1999/xhtml">Create or modify a DNS entry.</p>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_dns_create_dns_request.json" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_dns_create_dns_response.json" />
</doc>
</representation>
</response>
</method>
<method name="GET" id="FindUniqueEntry">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Find Unique DNS Entry">
<p xmlns="http://www.w3.org/1999/xhtml">Find unique DNS entry for a given domain and name.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_dns_finduniqentry_response.json" />
</doc>
</representation>
</response>
</method>
<method name="GET" id="FindEntriesbyIP">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Find DNS Entries">
<p xmlns="http://www.w3.org/1999/xhtml">Find DNS entries for a given domain and IP.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_dns_findentries_response.json" />
</doc>
</representation>
</response>
</method>
<method name="DELETE" id="DeleteEntry">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Delete a DNS entry">
<p xmlns="http://www.w3.org/1999/xhtml">Delete a DNS entry.</p>
</wadl:doc>
<response status="200" />
</method>
</application>

44
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-floating-ip-pools.wadl.bak Normal file
View File

@ -0,0 +1,44 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012 OpenStack LLC., 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">
<resources base="https://floatingippools.example.com/">
<resource id="version" path="v1.1">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the tenant or account.
</p>
</doc>
</param>
<resource id="floating-ip-pools" path="os-floating-ip-pools">
<method href="#listFloatingIpPools" />
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="listFloatingIpPools">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="List Floating IP Pools">
<p xmlns="http://www.w3.org/1999/xhtml">
View a list of Floating IP Pools.
</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_pools_list.json" />
</doc>
</representation>
</response>
</method>
</application>

102
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-floating-ips.wadl.bak Normal file
View File

@ -0,0 +1,102 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012 OpenStack LLC., 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">
<resources base="https://servers.api.openstack.com">
<resource id="version" type="#VersionDetails" path="v1.1">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the tenant or account.
</p>
</doc>
</param>
<resource id="os-floating-ips" path="os-floating-ips">
<method href="#ListFloatingIPs" />
<method href="#AllocateFloatingIP" />
<resource path="{id}">
<param name="id" style="template" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier associated with allocated floating IP address.
</p></doc>
</param>
<method href="#DetailFloatingIP" />
<method href="#DeallocateFloatingIP" />
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="ListFloatingIPs">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="List Floating IPs">
<p xmlns="http://www.w3.org/1999/xhtml">Lists floating IP addresses associated with the tenant or account.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/list_floating_ips.json" />
</doc>
</representation>
</response>
</method>
<method name="POST" id="AllocateFloatingIP">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Allocate Floating IP">
<p xmlns="http://www.w3.org/1999/xhtml">Allocate a new floating IP address to a tenant or account.</p>
</wadl:doc>
<request>
<param name="pool" style="plain">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">
Pool to allocate ip from. Will use default pool if not specified.
</p>
</doc>
</param>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/allocate_floating_ip_request.json" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/allocate_floating_ip_response.json" />
</doc>
</representation>
</response>
<response status="400"><doc xml:lang="EN"><p xmlns="http://www.w3.org/1999/xhtml">If there are no floating IPs available, the
extension returns an error code 400 with a message indicating that no more floating IPs are available.</p></doc></response>
</method>
<method name="GET" id="DetailFloatingIP">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="List Floating IP Detail">
<p xmlns="http://www.w3.org/1999/xhtml">Lists details of the floating IP address associated with floating_IP_address_ID.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_detail.json" />
</doc>
</representation>
</response>
</method>
<method name="DELETE" id="DeallocateFloatingIP">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Deallocate Floating IP">
<p xmlns="http://www.w3.org/1999/xhtml">Deallocates the floating IP address associated with floating_IP_address_ID.</p>
</wadl:doc>
<response status="202" />
</method>
</application>

8
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/snapshot_create.json Normal file
View File

@ -0,0 +1,8 @@
{
"snapshot": {
"display_name": "snap-001",
"display_description": "Daily backup",
"volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
"force": true
}
}

7
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/snapshot_create.xml Normal file
View File

@ -0,0 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<snapshot xmlns="http://docs.openstack.org/volume/api/v1"
name="snap-001"
display_name="snap-001"
display_description="Daily backup"
volume_id="521752a6-acf6-4b2d-bc7a-119f9148cd8c"
force="true" />

4
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/snapshot_delete.json Normal file
View File

@ -0,0 +1,4 @@
HTTP/1.1 202 Accepted
Content-Type: text/html; charset=UTF-8
Content-Length: 0
Date: Mon, 05 Dec 2011 16:23:10 GMT

22
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/snapshot_list_simple.json Normal file
View File

@ -0,0 +1,22 @@
{
"snapshots": [
{
"id": "3fbbcccf-d058-4502-8844-6feeffdf4cb5",
"display_name": "snap-001",
"display_description": "Daily backup",
"volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
"status": "available",
"size": 30,
"created_at": "2012-02-29T03:50:07Z"
},
{
"id": "e479997c-650b-40a4-9dfe-77655818b0d2",
"display_name": "snap-002",
"display_description": "Weekly backup",
"volume_id": "76b8950a-8594-4e5b-8dce-0dfa9c696358",
"status": "available",
"size": 25,
"created_at": "2012-03-19T01:52:47Z"
}
]
}

17
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/snapshot_list_simple.xml Normal file
View File

@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<snapshots xmlns="http://docs.openstack.org/volume/api/v1">
<snapshot id="3fbbcccf-d058-4502-8844-6feeffdf4cb5"
display_name="snap-001"
display_description="Daily backup"
volume_id="521752a6-acf6-4b2d-bc7a-119f9148cd8c"
status="available"
size="30"
created_at="2012-02-29T03:50:07Z" />
<snapshot id="e479997c-650b-40a4-9dfe-77655818b0d2"
display_name="snap-002"
display_description="Weekly backup"
volume_id="76b8950a-8594-4e5b-8dce-0dfa9c696358"
status="available"
size="25"
created_at="2012-03-19T01:52:47Z" />
</snapshots>

11
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/snapshot_show.json Normal file
View File

@ -0,0 +1,11 @@
{
"snapshot": {
"id": "3fbbcccf-d058-4502-8844-6feeffdf4cb5",
"display_name": "snap-001",
"display_description": "Daily backup",
"volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
"status": "available",
"size": 30,
"created_at": "2012-02-29T03:50:07Z"
}
}

9
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/snapshot_show.xml Normal file
View File

@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<snapshot xmlns="http://docs.openstack.org/volume/api/v1"
id="3fbbcccf-d058-4502-8844-6feeffdf4cb5"
display_name="snap-001"
display_description="Daily backup"
volume_id="521752a6-acf6-4b2d-bc7a-119f9148cd8c"
status="available"
size="30"
created_at="2012-02-29T03:50:07Z" />

10
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/volume_create.json Normal file
View File

@ -0,0 +1,10 @@
{
"volume": {
"display_name": "vol-001",
"display_description": "Another volume.",
"size": 30,
"volume_type": "289da7f8-6440-407c-9fb4-7db01ec49164",
"metadata": {"contents": "junk"},
"availability_zone": "us-east1"
}
}

11
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/volume_create.xml Normal file
View File

@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<volume xmlns="http://docs.openstack.org/volume/api/v1"
display_name="vol-001"
display_description="Another volume."
size="30"
volume_type="289da7f8-6440-407c-9fb4-7db01ec49164"
availability_zone="us-east1">
<metadata>
<meta key="contents">junk</meta>
</metadata>
</volume>

4
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/volume_delete.json Normal file
View File

@ -0,0 +1,4 @@
HTTP/1.1 202 Accepted
Content-Type: text/html; charset=UTF-8
Content-Length: 0
Date: Fri, 02 Dec 2011 00:39:32 GMT

28
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/volume_list_simple.json Normal file
View File

@ -0,0 +1,28 @@
{
"volumes": [
{
"id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
"display_name": "vol-001",
"display_description": "Another volume.",
"size": 30,
"volume_type": "289da7f8-6440-407c-9fb4-7db01ec49164",
"metadata": {"contents": "junk"},
"availability_zone": "us-east1",
"snapshot_id": null,
"attachments": [],
"created_at": "2012-02-14T20:53:07Z"
},
{
"id": "76b8950a-8594-4e5b-8dce-0dfa9c696358",
"display_name": "vol-002",
"display_description": "Yet another volume.",
"size": 25,
"volume_type": "96c3bda7-c82a-4f50-be73-ca7621794835",
"metadata": {},
"availability_zone": "us-east2",
"snapshot_id": null,
"attachments": [],
"created_at": "2012-03-15T19:10:03Z"
}
]
}

25
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/volume_list_simple.xml Normal file
View File

@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<volumes xmlns="http://docs.openstack.org/volume/api/v1">
<volume xmlns="http://docs.openstack.org/volume/api/v1"
id="521752a6-acf6-4b2d-bc7a-119f9148cd8c"
display_name="vol-001"
display_description="Another volume."
status="active"
size="30"
volume_type="289da7f8-6440-407c-9fb4-7db01ec49164"
availability_zone="us-east1"
created_at="2012-02-14T20:53:07Z">
<metadata>
<meta key="contents">junk</meta>
</metadata>
</volume>
<volume xmlns="http://docs.openstack.org/volume/api/v1"
id="76b8950a-8594-4e5b-8dce-0dfa9c696358"
display_name="vol-002"
display_description="Yet another volume."
status="active"
size="25"
volume_type="96c3bda7-c82a-4f50-be73-ca7621794835"
availability_zone="us-east2"
created_at="2012-03-15T19:10:03Z" />
</volumes>

14
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/volume_show.json Normal file
View File

@ -0,0 +1,14 @@
{
"volume": {
"id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
"display_name": "vol-001",
"display_description": "Another volume.",
"size": 30,
"volume_type": "289da7f8-6440-407c-9fb4-7db01ec49164",
"metadata": {"contents": "junk"},
"availability_zone": "us-east1",
"snapshot_id": null,
"attachments": [],
"created_at": "2012-02-14T20:53:07Z"
}
}

14
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/volume_show.xml Normal file
View File

@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<volume xmlns="http://docs.openstack.org/volume/api/v1"
id="521752a6-acf6-4b2d-bc7a-119f9148cd8c"
display_name="vol-001"
display_description="Another volume."
status="active"
size="30"
volume_type="289da7f8-6440-407c-9fb4-7db01ec49164"
availability_zone="us-east1"
created_at="2012-02-14T20:53:07Z">
<metadata>
<meta key="contents">junk</meta>
</metadata>
</volume>

14
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/volume_type_list.json Normal file
View File

@ -0,0 +1,14 @@
{
"volume_types": [
{
"id": "289da7f8-6440-407c-9fb4-7db01ec49164",
"name": "vol-type-001",
"extra_specs": {"capabilities": "gpu"}
},
{
"id": "96c3bda7-c82a-4f50-be73-ca7621794835",
"name": "vol-type-002",
"extra_specs": {}
}
]
}

11
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/volume_type_list.xml Normal file
View File

@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<volume_types xmlns="http://docs.openstack.org/volume/api/v1">
<volume_type id="289da7f8-6440-407c-9fb4-7db01ec49164"
name="vol-type-001">
<extra_specs>
<extra_spec key="capabilities">gpu</extra_spec>
</extra_specs>
</volume_type>
<volume_type id="96c3bda7-c82a-4f50-be73-ca7621794835"
name="vol-type-002" />
</volume_types>

7
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/volume_type_show.json Normal file
View File

@ -0,0 +1,7 @@
{
"volume_type": {
"id": "289da7f8-6440-407c-9fb4-7db01ec49164",
"name": "vol-type-001",
"extra_specs": {"capabilities": "gpu"}
}
}

8
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-samples/volume_type_show.xml Normal file
View File

@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<volume_type xmlns="http://docs.openstack.org/volume/api/v1"
id="289da7f8-6440-407c-9fb4-7db01ec49164"
name="vol-type-001">
<extra_specs>
<extra_spec key="capabilities">gpu</extra_spec>
</extra_specs>
</volume_type>

204
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-security-groups.wadl.bak Normal file
View File

@ -0,0 +1,204 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012 OpenStack LLC., 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">
<resources base="https://servers.api.openstack.com/">
<resource id="version" path="v1.1">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the tenant or account.
</p>
</doc>
</param>
<resource id="security_groups" path="os-security-groups">
<method href="#listSecGroups" />
<method href="#createSecGroup" />
<resource id="get_security_group" path="{security_group_id}">
<param name="security_group_id" style="template">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the security group.
</p></doc>
</param>
<method href="#getSecGroup" />
<method href="#deleteSecGroup" />
</resource>
</resource>
<resource id="security_groups" path="os-security-group-rules">
<method href="#createSecGroupRule" />
<resource path="{security_group_rule_id}">
<param name="security_group_rule_id" style="template">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the security group rule.
</p></doc>
</param>
<method href="#deleteSecGroupRule" />
</resource>
</resource>
<resource id="Servers" path="servers">
<resource path="{server_id}">
<param name="server_id" style="template" type="csapi:UUID">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">
The UUID for the server of interest to you.
</p>
</doc>
</param>
<resource path="os-security-groups">
<method href="#listSecGroupsByServer"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="listSecGroups">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">List security groups.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_groups_list.xml" />
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_groups_list.json" />
</doc>
</representation>
</response>
</method>
<method name="GET" id="listSecGroupsByServer">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
List security groups for a specific server.
</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_groups_list.xml" />
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_groups_list.json" />
</doc>
</representation>
</response>
</method>
<method name="GET" id="getSecGroup">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Get specific security group.
</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_get.xml" />
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_get.json" />
</doc>
</representation>
</response>
</method>
<method name="POST" id="createSecGroup">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Create a new security group.
</p>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_create_request.xml" />
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_create_request.json" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_create.xml" />
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_create.json" />
</doc>
</representation>
</response>
</method>
<method name="DELETE" id="deleteSecGroup">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">Delete a security group.</p>
</wadl:doc>
<response status="202" />
</method>
<method name="POST" id="createSecGroupRule">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Create security group rule.
</p>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_rule_create_request.json" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_rule_create.xml" />
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_rule_create.json" />
</doc>
</representation>
</response>
</method>
<method name="DELETE" id="deleteSecGroupRule">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Delete security group rule.
</p>
</wadl:doc>
<response status="202" />
</method>
</application>

394
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-volume.wadl Normal file
View File

@ -0,0 +1,394 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012 OpenStack LLC., 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"
xmlns:db="http://docbook.org/ns/docbook"
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:common="http://docs.openstack.org/common/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:atom="http://www.w3.org/2005/Atom">
<!-- <grammars>
<include href="xsd/api.xsd"/>
<include href="xsd/api-common.xsd"/>
</grammars> -->
<resources base="https://volume.example.com/">
<resource id="version" path="v1.1">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template" type="xsd:string">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml"> The
unique identifier of the tenant or
account. </p>
</doc>
</param>
<resource id="os-volumes" path="os-volumes">
<method href="#getVolumesSimple"/>
<resource path="detail">
<method href="#getVolumesDetail"/>
</resource>
<resource path="{volume_id}">
<param name="volume_id" style="template"
required="true" type="xsd:string">
<doc>
<p
xmlns="http://www.w3.org/1999/xhtml"
> The unique identifier for a
volume. </p>
</doc>
</param>
<method href="#createVolume"/>
<method href="#getVolume"/>
<method href="#deleteVolume"/>
</resource>
</resource>
<resource id="os-volume-types" path="os-volume-types">
<method href="#getVolumeTypes"/>
<resource path="{volume_type_id}">
<param name="volume_type_id" style="template"
required="true" type="xsd:string">
<doc>
<p
xmlns="http://www.w3.org/1999/xhtml"
>The unique identifier for a volume
type. </p>
</doc>
</param>
<method href="#getVolumeType"/>
</resource>
</resource>
<resource id="os-snapshots" path="os-snapshots">
<method href="#createSnapshot"/>
<method href="#getSnapshotsSimple"/>
<resource path="detail">
<method href="#getSnapshotsDetail"/>
</resource>
<resource path="{snapshot_id}">
<param name="snapshot_id" style="template"
required="true" type="xsd:string">
<doc>
<p
xmlns="http://www.w3.org/1999/xhtml"
> The unique identifier for a
snapshot. </p>
</doc>
</param>
<method href="#getSnapshot"/>
<method href="#deleteSnapshot"/>
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="POST" id="createVolume">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="Create Volume">
<p xmlns="http://www.w3.org/1999/xhtml">Creates a volume.
The operation requires a request body. </p>
</wadl:doc>
<request>
<param name="volume" style="plain" required="true" type="xsd:string">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">A partial
representation of a volume that is used to
create a volume. </p>
</doc>
</param>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="os-samples/volume_create.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="os-samples/volume_create.json"/>
</doc>
</representation>
</request>
<response status="201">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="os-samples/volume_show.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="os-samples/volume_show.json"/>
</doc>
</representation>
</response>
</method>
<method name="GET" id="getVolumesSimple">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="List Volumes">
<p xmlns="http://www.w3.org/1999/xhtml">Lists the volumes
associated with the account. The operation does not
require a request body. </p>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="os-samples/volume_list_simple.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="os-samples/volume_list_simple.json"/>
</doc>
</representation>
</response>
</method>
<method name="GET" id="getVolumesDetail">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="List Volumes (Detailed)">
<p xmlns="http://www.w3.org/1999/xhtml">Lists details for
a specified volume. The operation does not require a
request body. </p>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="os-samples/volume_list_simple.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="os-samples/volume_list_simple.json"/>
</doc>
</representation>
</response>
</method>
<method name="GET" id="getVolume">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="Show Volume">
<p xmlns="http://www.w3.org/1999/xhtml">Shows information
for a specified volume.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="os-samples/volume_show.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="os-samples/volume_show.json"/>
</doc>
</representation>
</response>
</method>
<method name="DELETE" id="deleteVolume">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="Delete Volume">
<p xmlns="http://www.w3.org/1999/xhtml">Deletes a
specified volume.</p>
</wadl:doc>
<response status="202">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="os-samples/volume_delete.json"/>
</doc>
</representation>
</response>
</method>
<method name="GET" id="getVolumeTypes">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="List Volume Types">
<p xmlns="http://www.w3.org/1999/xhtml">Lists volume
types.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="os-samples/volume_type_list.xml"
/>
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="os-samples/volume_type_list.json"/>
</doc>
</representation>
</response>
</method>
<method name="GET" id="getVolumeType">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="Show Volume Type">
<p xmlns="http://www.w3.org/1999/xhtml">Shows information
for a specified volume type.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="os-samples/volume_type_show.xml"
/>
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="os-samples/volume_type_show.json"/>
</doc>
</representation>
</response>
</method>
<method name="POST" id="createSnapshot">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="Create Snapshot">
<p xmlns="http://www.w3.org/1999/xhtml">Creates a
snapshot.</p>
</wadl:doc>
<request>
<param name="snapshot" style="plain" required="true" type="xsd:string">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">A partial
representation of a snapshot that is used to
create a snapshot. </p>
</doc>
</param>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="os-samples/snapshot_create.xml"
/>
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="os-samples/snapshot_create.json"
/>
</doc>
</representation>
</request>
<response status="201">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="os-samples/snapshot_show.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="os-samples/snapshot_show.json"/>
</doc>
</representation>
</response>
</method>
<method name="GET" id="getSnapshotsSimple">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="List Snapshots">
<p xmlns="http://www.w3.org/1999/xhtml">Lists snapshots.
</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="os-samples/snapshot_list_simple.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="os-samples/snapshot_list_simple.json"/>
</doc>
</representation>
</response>
</method>
<method name="GET" id="getSnapshotsDetail">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="List Snapshots (Detailed)">
<p xmlns="http://www.w3.org/1999/xhtml">Lists details for
a specified snapshot. The operation does not require a
request body.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="os-samples/snapshot_list_simple.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="os-samples/snapshot_list_simple.json"/>
</doc>
</representation>
</response>
</method>
<method name="GET" id="getSnapshot">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="Show Snapshot">
<p xmlns="http://www.w3.org/1999/xhtml">Shows information
for a specified snapshot.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="os-samples/snapshot_show.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="os-samples/snapshot_show.json"/>
</doc>
</representation>
</response>
</method>
<method name="DELETE" id="deleteSnapshot">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="Delete Snapshot">
<p xmlns="http://www.w3.org/1999/xhtml">Deletes a
specified snapshot from the account. The operation
does not require a request body and does not return a
response body. </p>
<p>This operation is asynchronous. You must list snapshots
repeatedly to determine whether the snapshot was
deleted. </p>
</wadl:doc>
<response status="202">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="os-samples/snapshot_delete.json"
/>
</doc>
</representation>
</response>
</method>
</application>

8
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/samples/os-hypervisors-response.json Normal file
View File

@ -0,0 +1,8 @@
{
"hypervisors":
{
"id": 1,
"hypervisor_hostname": "precise."
}
}

13
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/samples/os-hypervisors-stats-list.json Normal file
View File

@ -0,0 +1,13 @@
{
"hypervisors":
{
"id": 1,
"hypervisor_hostname": "precise.",
"servers":
{"uuid": "9643a2c9-c1e9-4281-bcff-2ff175e33ba9",
"name": "instance-00000001"
}
}
}

22
doc/src/docbkx/openstack-api-site/src/wadls/volume-api/src/os-volume-1.wadl → doc/src/docbkx/openstack-api-site/src/wadls/volume-api/src/volume-api.wadl
View File

@ -113,7 +113,7 @@
</method>
<method name="GET" id="getVolumesSimple">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="E" title="List Volumes">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="List Volumes">
<p xmlns="http://www.w3.org/1999/xhtml">View a list of simple Volume entities.</p>
</wadl:doc>
<response status="200">
@ -131,7 +131,7 @@
</method>
<method name="GET" id="getVolumesDetail">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="E"
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="List Volumes (Detailed)">
<p xmlns="http://www.w3.org/1999/xhtml">View a list of detailed Volume entities.</p>
</wadl:doc>
@ -151,7 +151,7 @@
<method name="GET" id="getVolume">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="E" title="Describe Volume">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Describe Volume">
<p xmlns="http://www.w3.org/1999/xhtml">View all information about a single Volume.</p>
</wadl:doc>
<response status="200">
@ -169,14 +169,14 @@
</method>
<method name="DELETE" id="deleteVolume">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="E" title="Delete Volume">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Delete Volume">
<p xmlns="http://www.w3.org/1999/xhtml">Delete a single Volume.</p>
</wadl:doc>
<response status="202" />
</method>
<method name="GET" id="getVolumeTypes">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="E" title="List Volume Types">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="List Volume Types">
<p xmlns="http://www.w3.org/1999/xhtml">Request a list of Volume Types.</p>
</wadl:doc>
<response status="200">
@ -194,7 +194,7 @@
</method>
<method name="GET" id="getVolumeType">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="E" title="Describe Volume Type">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Describe Volume Type">
<p xmlns="http://www.w3.org/1999/xhtml">Request a single Volume Type.</p>
</wadl:doc>
<response status="200">
@ -212,7 +212,7 @@
</method>
<method name="POST" id="createSnapshot">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="E"
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="Create Snapshot">
<p xmlns="http://www.w3.org/1999/xhtml">Create a Snapshot.</p>
</wadl:doc>
@ -248,7 +248,7 @@
</method>
<method name="GET" id="getSnapshotsSimple">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="E"
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="List Snapshots">
<p xmlns="http://www.w3.org/1999/xhtml">
View a list of simple Snapshot entities.
@ -269,7 +269,7 @@
</method>
<method name="GET" id="getSnapshotsDetail">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="E"
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="List Snapshots (Detailed)">
<p xmlns="http://www.w3.org/1999/xhtml">
View a list of detailed Snapshot entities.
@ -291,7 +291,7 @@
<method name="GET" id="getSnapshot">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="E"
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="Describe Snapshot">
<p xmlns="http://www.w3.org/1999/xhtml">
View all information about a single Snapshot.
@ -312,7 +312,7 @@
</method>
<method name="DELETE" id="deleteSnapshot">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="E"
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="Delete Snapshot">
<p xmlns="http://www.w3.org/1999/xhtml">Delete a single Snapshot.</p>
</wadl:doc>