openstack/api-site
Code Issues Proposed changes

Merge "Fix versions and version calls for all projects"

Browse Source
This commit is contained in:
Jenkins 2014-04-26 15:00:33 +00:00 committed by Gerrit Code Review
commit 513aa1dc0c
62 changed files with 2787 additions and 897 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
api-ref/src/docbkx/ch_blockstorage-api-v1.xml
View File

@ -10,6 +10,19 @@
<title>Block Storage API v1</title>
<para>Manage volumes and snapshots for use with the Block Storage
API, also known as cinder services.</para>
<section xml:id="versions-cinder-v1">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/volume-api/src/v1/volume-api-v1.wadl#versions">
<wadl:method href="#listVersionsv1"/>
</wadl:resource>
<wadl:resource
href="../wadls/volume-api/src/v1/volume-api-v1.wadl#version">
<wadl:method href="#showVersionDetailsv1"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="volumes-v1">
<title>Volumes</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">

13
api-ref/src/docbkx/ch_blockstorage-api-v2.xml
View File

@ -10,6 +10,19 @@
<title>Block Storage API v2</title>
<para>Manage volumes and snapshots for use with the Block Storage
API, also known as cinder services.</para>
<section xml:id="versions-cinder-v2">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/volume-api/src/v2/volume-api-v2.wadl#versions">
<wadl:method href="#listVersions"/>
</wadl:resource>
<wadl:resource
href="../wadls/volume-api/src/v2/volume-api-v2.wadl#version">
<wadl:method href="#versionDetails"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="volumes-v2">
<title>Volumes</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">

23
api-ref/src/docbkx/ch_compute-v2-ext.xml
View File

@ -8,12 +8,27 @@
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="compute-ext-v2" role="api-reference">
version="5.0-extension RackBook-2.0" xml:id="compute-ext-v2"
role="api-reference">
<title>Compute API v2 extensions</title>
<para>Extensions add features, MIME types, actions, states,
headers, parameters, and resources to the core Compute API.
Query the Compute API to list available extensions with a
&GET; request to v2/extensions.</para>
headers, parameters, and resources to the core Compute API
without requiring a version change.</para>
<section xml:id="compute_extensions">
<title>Extensions</title>
<para>List available Compute API v2 extensions and show details for a
specified extension.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#extensions">
<wadl:method href="#listExtensionsv2"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#extension">
<wadl:method href="#getExtensionv2"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="ext-action">
<title>Server admin actions (action)</title>
<para>Administrator only. Perform actions on a server. Specify

33
api-ref/src/docbkx/ch_compute-v2.xml
View File

@ -5,38 +5,27 @@
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="compute-core-v2" role="api-reference">
version="5.0-extension RackBook-2.0" xml:id="compute-core-v2"
role="api-reference">
<title>Compute API v2</title>
<para>Launch virtual machines from images or images stored on
persistent volumes. API v1.1 is identical to API v2.</para>
<section xml:id="compute_versions">
<title>Versions</title>
<para>Get information about a specific version of the
API.</para>
<title>API versions</title>
<para>List information for all API versions and show details
about API v2.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#versions">
<wadl:method href="#listVersionsv2"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#version">
<wadl:method href="#versionDetails"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="compute_extensions">
<title>Extensions</title>
<para>List all available extensions and get details for a
specified extension. Extensions introduce features and
vendor-specific functionality in the API without requiring
a version change.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#extensions">
<wadl:method href="#listExtensions"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#extension">
<wadl:method href="#getExtension"/>
<wadl:method href="#getVersionDetailsv2"/>
</wadl:resource>
</wadl:resources>
</section>
<!-- moved extensions to compute v2 extensions page -->
<section xml:id="compute_limits">
<title>Limits</title>
<para>Get rate and absolute limits.</para>

19
api-ref/src/docbkx/ch_compute-v3.xml
View File

@ -12,8 +12,23 @@
version="5.0-extension RackBook-2.0" xml:id="compute-ext-v3"
role="api-reference">
<title>Compute API v3 (EXPERIMENTAL)</title>
<para>Query the Compute API to list available extensions with a
&GET; request to <code>v3/extensions</code>.</para>
<!-- GET v3/extensions does not work -->
<!-- <para>Query the Compute API to list available extensions with a
&GET; request to <code>v3/extensions</code>.</para>-->
<section xml:id="v3versions">
<title>API versions</title>
<para>List information for all API versions.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/compute-api/src/v3/wadl/os-versions-v3.wadl#versions">
<wadl:method href="#listVersionsv3"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/src/v3/wadl/os-versions-v3.wadl#version">
<wadl:method href="#showVersionDetailsv3"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v3server">
<title>Server admin actions (servers)</title>
<para>Administrators only. Perform actions on a server. Specify

14
api-ref/src/docbkx/ch_databases-v1.xml
View File

@ -11,7 +11,9 @@
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/databases-api/xsd/dbaas.wadl#versions"/>
href="../wadls/databases-api/xsd/dbaas.wadl#versions">
<wadl:method href="#getVersions"/>
</wadl:resource>
<wadl:resource
href="../wadls/databases-api/xsd/dbaas.wadl#version">
<wadl:method href="#getVersionInfo"/>
@ -20,7 +22,7 @@
</section>
<!-- add back later - validation errors -->
<section xml:id="Database_Instances">
<title>Database instances</title>
<title>Database instances (instances)</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/databases-api/xsd/dbaas.wadl#instances">
@ -40,7 +42,7 @@
</wadl:resources>
</section>
<section xml:id="Database_Instances_Actions">
<title>Database instance actions</title>
<title>Database instance actions (action)</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/databases-api/xsd/dbaas.wadl#instanceAction">
@ -51,7 +53,7 @@
</wadl:resources>
</section>
<section xml:id="databases">
<title>Databases</title>
<title>Databases (databases)</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/databases-api/xsd/dbaas.wadl#databases">
@ -65,7 +67,7 @@
</wadl:resources>
</section>
<section xml:id="user_management">
<title>Users</title>
<title>Users (users)</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/databases-api/xsd/dbaas.wadl#users">
@ -79,7 +81,7 @@
</wadl:resources>
</section>
<section xml:id="flavors">
<title>Flavors</title>
<title>Flavors (flavors)</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/databases-api/xsd/dbaas.wadl#flavors">

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

@ -10,7 +10,43 @@
<title>Identity API v2.0</title>
<para>Get an authentication token that permits access to the
Compute API.</para>
<wadl:resources
href="../wadls/identity-api/src/v2.0/wadl/identity.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
<section xml:id="identity-v2-versions">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/identity-api/src/v2.0/wadl/identity.wadl#versions">
<wadl:method href="#getVersions-v2"/>
</wadl:resource>
<wadl:resource
href="../wadls/identity-api/src/v2.0/wadl/identity.wadl#version">
<wadl:method href="#getVersionInfo-v2.0"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="identity-api-extensions">
<title>Extensions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/identity-api/src/v2.0/wadl/identity.wadl#extensions">
<wadl:method href="#listExtensions-v2.0"/>
</wadl:resource>
<wadl:resource
href="../wadls/identity-api/src/v2.0/wadl/identity.wadl#extension">
<wadl:method href="#getExtension-v2.0"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="identity-auth-v2">
<title>Tokens</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/identity-api/src/v2.0/wadl/identity.wadl#tokens">
<wadl:method href="#authenticate-v2.0"/>
</wadl:resource>
<wadl:resource
href="../wadls/identity-api/src/v2.0/wadl/identity.wadl#tenants">
<wadl:method href="#listTenants"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

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

@ -10,13 +10,17 @@
<title>Identity API v3</title>
<para>Get an authentication token that permits access to the
Compute API.</para>
<section xml:id="Version_Calls">
<title>Versions</title>
<section xml:id="versions-identity-v3">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- list version -->
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#versions">
<wadl:method href="#getVersionDetails"/>
<wadl:method href="#getVersions-identity-v3"/>
</wadl:resource>
<!-- list version -->
<wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#version">
<wadl:method href="#showVersionDetails-identity-v3"/>
</wadl:resource>
</wadl:resources>
</section>

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

@ -12,6 +12,60 @@
assign metadata to images.</para>
<para>Some cloud implementations do not expose this API and offer
pretested images only.</para>
<wadl:resources href="../wadls/image-api/src/v1/os-image-1.0.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
<section xml:id="versions-v1">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/image-api/src/v1/os-image-1.0.wadl#versions">
<wadl:method href="#listVersions-image-v1"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v1/os-image-1.0.wadl#version">
<wadl:method href="#showVersionDetails-image-v1"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="images-v1">
<title>Images</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/image-api/src/v1/os-image-1.0.wadl#Images">
<wadl:method href="#createImage-v1"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v1/os-image-1.0.wadl#detail">
<wadl:method href="#listDetailImage-v1"/>
</wadl:resource>
<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="#updateImage-v1"/>
<wadl:method href="#deleteImage-v1"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="members-v1">
<title>Members</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/image-api/src/v1/os-image-1.0.wadl#members">
<wadl:method href="#replaceMember-v1"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v1/os-image-1.0.wadl#owner-id">
<wadl:method href="#addMember-v1"/>
<wadl:method href="#removeMember-v1"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="shared_images_v1">
<title>Shared images</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/image-api/src/v1/os-image-1.0.wadl#owner-2">
<wadl:method href="#getSharedImages-v1"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

73
api-ref/src/docbkx/ch_images-v2.xml
View File

@ -8,20 +8,79 @@
version="5.0-extension RackBook-2.0" xml:id="image-v2">
<title>Image Service API v2</title>
<para>Image Service API v2.0, API v2.1, and API v2.2.</para>
<section xml:id="versions-images-v2">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/image-api/src/v2/os-image-v2.wadl#versions">
<wadl:method href="#listVersions-image-v2"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="images-v2">
<title>Images</title>
<para>Create, update, and delete image metadata records.
Enable users to share images with each other. Also,
upload and download raw image data.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/image-api/src/v2/os-image-v2.wadl"/>
Enable users to share images with each other. Also, upload
and download raw image data.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/image-api/src/v2/os-image-v2.wadl#Images">
<wadl:method href="#createImage-v2"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-image-v2.wadl#image_id">
<wadl:method href="#getImage-v2"/>
<wadl:method href="#updateImage-v2"/>
<wadl:method href="#deleteImage-v2"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-image-v2.wadl#file">
<wadl:method href="#storeImageFile-v2"/>
<wadl:method href="#getImageFile-v2"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-image-v2.wadl#tag">
<wadl:method href="#addImageTag-v2"/>
<wadl:method href="#deleteImageTag-v2"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="members-v2">
<title>Members</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/image-api/src/v2/os-image-v2.wadl#Members">
<wadl:method href="#createImageMember-v2"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-image-v2.wadl#member_id">
<wadl:method href="#getImageMember-v2"/>
<wadl:method href="#deleteImageMember-v2"/>
<wadl:method href="#updateImageMember-v2"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="image-schemas-v2">
<title>Image schemas</title>
<para>Get a JSON-schema document that represents an images or
image entity.</para>
<wadl:resources
href="../wadls/image-api/src/v2/os-image-schemas-v2.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/image-api/src/v2/os-image-schemas-v2.wadl#Image-schemas">
<wadl:method href="#getImagesSchema-v2"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-image-schemas-v2.wadl#Image-schema">
<wadl:method href="#getImageSchema-v2"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-image-schemas-v2.wadl#Image-members-schema">
<wadl:method href="#getImageMembersSchema-v2"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/src/v2/os-image-schemas-v2.wadl#Image-member-schema">
<wadl:method href="#getImageMemberSchema-v2"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

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

@ -16,6 +16,21 @@
Networking network. You can choose a specific IP address from
the block or let OpenStack Networking choose the first
available IP address.</para>
<section xml:id="neutron-versions-v2">
<title>API versions</title>
<para>List information for all Networking API versions and show details
about API v2.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/netconn-api/src/os-networks.wadl#versions">
<wadl:method href="#listVersionsv2-neutron"/>
</wadl:resource>
<wadl:resource
href="../wadls/netconn-api/src/os-networks.wadl#version">
<wadl:method href="#showVersionDetailsv2-neutron"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="networks">
<title>Networks</title>
<para>List, show information for, create, update, and delete

14
api-ref/src/docbkx/ch_objectstorage-v1.xml
View File

@ -46,8 +46,8 @@ Accept-Ranges: bytes</programlisting>
>Header Field Definitions</link>.</para>
<section xml:id="storage_account_services">
<title>Accounts</title>
<para>List containers for a specified account. Create,
update, show, and delete account metadata.</para>
<para>List containers for a specified account. Create, update,
show, and delete account metadata.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/object-api/src/os-object-api-1.0.wadl#account">
@ -60,8 +60,8 @@ Accept-Ranges: bytes</programlisting>
<section xml:id="storage_container_services">
<title>Containers</title>
<para>List objects in a specified container. Create, show
details for, and delete containers. Create, update,
show, and delete container metadata.</para>
details for, and delete containers. Create, update, show,
and delete container metadata.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/object-api/src/os-object-api-1.0.wadl#container">
@ -75,9 +75,9 @@ Accept-Ranges: bytes</programlisting>
</section>
<section xml:id="storage_object_services">
<title>Objects</title>
<para>Create, replace, show details for, and delete
objects. Copy objects from another object with a new or
different name. Update object metadata.</para>
<para>Create, replace, show details for, and delete objects.
Copy objects from another object with a new or different
name. Update object metadata.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/object-api/src/os-object-api-1.0.wadl#object">

12
api-ref/src/docbkx/ch_orchestration-v1.xml
View File

@ -9,6 +9,15 @@
<title>Orchestration API v1</title>
<para>Use a template language to orchestrate OpenStack
services.</para>
<section xml:id="heat-versions">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#versions">
<wadl:method href="#getVersions-heat-v1"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="stacks">
<title>Stacks</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
@ -41,7 +50,8 @@
</section>
<section xml:id="stack-actions">
<title>Stack actions</title>
<para>Performs non-lifecycle operations on the stack. Specify the action in the request body.</para>
<para>Performs non-lifecycle operations on the stack. Specify
the action in the request body.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#actions">

1440
api-ref/src/wadls/compute-api/src/v2/api_samples/all_extensions/extensions-get-resp.json
View File

File diff suppressed because it is too large Load Diff

33
api-ref/src/wadls/compute-api/src/v2/api_samples/version-get-resp.json Normal file
View File

@ -0,0 +1,33 @@
{
"version":{
"status":"CURRENT",
"updated":"2011-01-21T11:33:21Z",
"media-types":[
{
"base":"application/xml",
"type":"application/vnd.openstack.compute+xml;version=2"
},
{
"base":"application/json",
"type":"application/vnd.openstack.compute+json;version=2"
}
],
"id":"v2.0",
"links":[
{
"href":"http://23.253.228.211:8774/v2/",
"rel":"self"
},
{
"href":"http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf",
"type":"application/pdf",
"rel":"describedby"
},
{
"href":"http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
"type":"application/vnd.sun.wadl+xml",
"rel":"describedby"
}
]
}
}

18
api-ref/src/wadls/compute-api/src/v2/api_samples/version-get-resp.xml Normal file
View File

@ -0,0 +1,18 @@
<?xml version='1.0' encoding='UTF-8'?>
<version xmlns:atom="http://www.w3.org/2005/Atom"
xmlns="http://docs.openstack.org/common/api/v1.0" status="CURRENT"
updated="2011-01-21T11:33:21Z" id="v2.0">
<media-types>
<media-type base="application/xml"
type="application/vnd.openstack.compute+xml;version=2"/>
<media-type base="application/json"
type="application/vnd.openstack.compute+json;version=2"/>
</media-types>
<atom:link href="http://23.253.228.211:8774/v2/" rel="self"/>
<atom:link
href="http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf"
type="application/pdf" rel="describedby"/>
<atom:link
href="http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl"
type="application/vnd.sun.wadl+xml" rel="describedby"/>
</version>

55
api-ref/src/wadls/compute-api/src/v2/api_samples/versions-get-resp.json
View File

@ -1,26 +1,33 @@
{
"versions": [
{
"id": "v2.0",
"links": [
{
"href": "http://openstack.example.com/v2/",
"rel": "self"
}
],
"status": "CURRENT",
"updated": "2011-01-21T11:33:21Z"
},
{
"id": "v3.0",
"links": [
{
"href": "http://openstack.example.com/v3/",
"rel": "self"
}
],
"status": "EXPERIMENTAL",
"updated": "2013-07-23T11:33:21Z"
}
]
"version":{
"status":"CURRENT",
"updated":"2011-01-21T11:33:21Z",
"media-types":[
{
"base":"application/xml",
"type":"application/vnd.openstack.compute+xml;version=2"
},
{
"base":"application/json",
"type":"application/vnd.openstack.compute+json;version=2"
}
],
"id":"v2.0",
"links":[
{
"href":"http://23.253.228.211:8774/v2/",
"rel":"self"
},
{
"href":"http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf",
"type":"application/pdf",
"rel":"describedby"
},
{
"href":"http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
"type":"application/vnd.sun.wadl+xml",
"rel":"describedby"
}
]
}
}

25
api-ref/src/wadls/compute-api/src/v2/api_samples/versions-get-resp.xml
View File

@ -1,9 +1,22 @@
<?xml version='1.0' encoding='UTF-8'?>
<versions xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/common/api/v1.0">
<version status="CURRENT" updated="2011-01-21T11:33:21Z" id="v2.0">
<atom:link href="http://openstack.example.com/v2/" rel="self"/>
<choices xmlns:atom="http://www.w3.org/2005/Atom"
xmlns="http://docs.openstack.org/common/api/v1.0">
<version status="EXPERIMENTAL" id="v3.0">
<media-types>
<media-type base="application/json"
type="application/vnd.openstack.compute+json;version=3"/>
</media-types>
<atom:link href="http://23.253.228.211:8774/v3/v2.xml" rel="self"
/>
</version>
<version status="EXPERIMENTAL" updated="2013-07-23T11:33:21Z" id="v3.0">
<atom:link href="http://openstack.example.com/v3/" rel="self"/>
<version status="CURRENT" id="v2.0">
<media-types>
<media-type base="application/xml"
type="application/vnd.openstack.compute+xml;version=2"/>
<media-type base="application/json"
type="application/vnd.openstack.compute+json;version=2"/>
</media-types>
<atom:link href="http://23.253.228.211:8774/v2/v2.xml" rel="self"
/>
</version>
</versions>
</choices>

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

@ -25,7 +25,10 @@
<!--*******************************************************-->
<resources base="https://servers.api.openstack.com"
xml:id="os-compute-v2">
<resource id="version" type="#VersionDetails" path="//v2">
<resource id="versions" path="//">
<method href="#listVersionsv2"/>
</resource>
<resource id="version" type="#versionDetailsv2" path="//v2">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template"
type="csapi:UUID">
@ -49,7 +52,7 @@
extension.</para>
</wadl:doc>
</param>
<method href="#getExtension"/>
<method href="#getExtensionv2"/>
</resource>
</resource>
<resource id="limits" path="limits">
@ -184,24 +187,22 @@
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- Resource Types -->
<!--*******************************************************-->
<resource_type id="VersionDetails">
<resource_type id="versionDetailsv2">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Version details">
<para>Details for a version.</para>
</wadl:doc>
<method href="#versionDetails"/>
<method href="#getVersionDetailsv2"/>
</resource_type>
<resource_type id="ExtensionList">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Detail image list">
<para>A list of supported extensions.</para>
</wadl:doc>
<method href="#listExtensions"/>
<method href="#listExtensionsv2"/>
</resource_type>
<resource_type id="DetailServerList">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
@ -285,20 +286,41 @@
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<!-- Version -->
<method name="GET" id="versionDetails">
<method name="GET" id="listVersionsv2">
<wadl:doc xml:lang="EN" title="List API versions"
xmlns="http://docbook.org/ns/docbook"><para
role="shortdesc">Lists information about all Compute API
versions.</para>
</wadl:doc>
<response status="200 300">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/compute-versions-response.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/compute-versions-response.xml"/>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="GET" id="getVersionDetailsv2">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get version details">
<para role="shortdesc">Gets details about this specific
version of the API.</para>
title="Show API version details">
<para role="shortdesc">Shows details for Compute API v2.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/versions-get-resp.json"/>
href="../api_samples/version-get-resp.json"/>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
@ -306,7 +328,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/versions-get-resp.xml"/>
href="../api_samples/version-get-resp.xml"/>
</wadl:doc>
<param name="location" style="plain" type="xsd:anyURI"
required="true"
@ -314,7 +336,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Location"><para>Full URL
to a service or server.</para></wadl:doc>
<link resource_type="#VersionDetails" rel="self"/>
<link resource_type="#versionDetailsv2" rel="self"
/>
</param>
</representation>
</response>
@ -345,7 +368,7 @@
</response>
<!-- Common Faults --> &commonFaults; </method>
<!-- Extensions -->
<method name="GET" id="listExtensions">
<method name="GET" id="listExtensionsv2">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List extensions">
<para role="shortdesc">Lists available extensions.</para>
@ -384,7 +407,7 @@
</representation>
</response>
<!-- Common Faults --> &commonFaults; </method>
<method name="GET" id="getExtension">
<method name="GET" id="getExtensionv2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get extension">
<para role="shortdesc">Gets details about the specified
@ -414,10 +437,8 @@
title="Create server">
<para role="shortdesc">Creates a server.</para>
</wadl:doc>
<request>
&serverCreateParameters;
<representation mediaType="application/xml"
element="csapi:server"> </representation>
<request> &serverCreateParameters; <representation
mediaType="application/xml" element="csapi:server"> </representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">

26
api-ref/src/wadls/compute-api/src/v2/wadl/samples/compute-versions-response.json Normal file
View File

@ -0,0 +1,26 @@
{
"versions":[
{
"status":"CURRENT",
"updated":"2011-01-21T11:33:21Z",
"id":"v2.0",
"links":[
{
"href":"http://23.253.228.211:8774/v2/",
"rel":"self"
}
]
},
{
"status":"EXPERIMENTAL",
"updated":"2013-07-23T11:33:21Z",
"id":"v3.0",
"links":[
{
"href":"http://23.253.228.211:8774/v3/",
"rel":"self"
}
]
}
]
}

24
api-ref/src/wadls/compute-api/src/v2/wadl/samples/compute-versions-response.xml Normal file
View File

@ -0,0 +1,24 @@
<?xml version='1.0' encoding='UTF-8'?>
<choices xmlns:atom="http://www.w3.org/2005/Atom"
xmlns="http://docs.openstack.org/common/api/v1.0">
<version status="EXPERIMENTAL" id="v3.0">
<media-types>
<media-type base="application/json"
type="application/vnd.openstack.compute+json;version=3"
/>
</media-types>
<atom:link href="http://23.253.228.211:8774/v3/.xml"
rel="self"/>
</version>
<version status="CURRENT" id="v2.0">
<media-types>
<media-type base="application/xml"
type="application/vnd.openstack.compute+xml;version=2"/>
<media-type base="application/json"
type="application/vnd.openstack.compute+json;version=2"
/>
</media-types>
<atom:link href="http://23.253.228.211:8774/v2/.xml"
rel="self"/>
</version>
</choices>

26
api-ref/src/wadls/compute-api/src/v3/api_samples/compute-versions-response.json Normal file
View File

@ -0,0 +1,26 @@
{
"versions":[
{
"status":"CURRENT",
"updated":"2011-01-21T11:33:21Z",
"id":"v2.0",
"links":[
{
"href":"http://23.253.228.211:8774/v2/",
"rel":"self"
}
]
},
{
"status":"EXPERIMENTAL",
"updated":"2013-07-23T11:33:21Z",
"id":"v3.0",
"links":[
{
"href":"http://23.253.228.211:8774/v3/",
"rel":"self"
}
]
}
]
}

24
api-ref/src/wadls/compute-api/src/v3/api_samples/compute-versions-response.xml Normal file
View File

@ -0,0 +1,24 @@
<?xml version='1.0' encoding='UTF-8'?>
<choices xmlns:atom="http://www.w3.org/2005/Atom"
xmlns="http://docs.openstack.org/common/api/v1.0">
<version status="EXPERIMENTAL" id="v3.0">
<media-types>
<media-type base="application/json"
type="application/vnd.openstack.compute+json;version=3"
/>
</media-types>
<atom:link href="http://23.253.228.211:8774/v3/.xml"
rel="self"/>
</version>
<version status="CURRENT" id="v2.0">
<media-types>
<media-type base="application/xml"
type="application/vnd.openstack.compute+xml;version=2"/>
<media-type base="application/json"
type="application/vnd.openstack.compute+json;version=2"
/>
</media-types>
<atom:link href="http://23.253.228.211:8774/v2/.xml"
rel="self"/>
</version>
</choices>

29
api-ref/src/wadls/compute-api/src/v3/api_samples/compute-versionsv3-response.json Normal file
View File

@ -0,0 +1,29 @@
{
"version":{
"status":"EXPERIMENTAL",
"updated":"2013-07-23T11:33:21Z",
"media-types":[
{
"base":"application/json",
"type":"application/vnd.openstack.compute+json;version=3"
}
],
"id":"v3.0",
"links":[
{
"href":"http://23.253.228.211:8774/v3/",
"rel":"self"
},
{
"href":"http://docs.openstack.org/api/openstack-compute/3/os-compute-devguide-3.pdf",
"type":"application/pdf",
"rel":"describedby"
},
{
"href":"http://docs.openstack.org/api/openstack-compute/3/wadl/os-compute-3.wadl",
"type":"application/vnd.sun.wadl+xml",
"rel":"describedby"
}
]
}
}

28
api-ref/src/wadls/compute-api/src/v3/api_samples/version-get-resp.xml Normal file
View File

@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?>
<version>
<status>EXPERIMENTAL</status>
<updated>2013-07-23T11:33:21Z</updated>
<media-types>
<media-type>
<base>application/json</base>
<type>application/vnd.openstack.compute+json;version=3</type>
</media-type>
</media-types>
<id>v3.0</id>
<links>
<link>
<href>http://23.253.228.211:8774/v3/</href>
<rel>self</rel>
</link>
<link>
<href>http://docs.openstack.org/api/openstack-compute/3/os-compute-devguide-3.pdf</href>
<type>application/pdf</type>
<rel>describedby</rel>
</link>
<link>
<href>http://docs.openstack.org/api/openstack-compute/3/wadl/os-compute-3.wadl</href>
<type>application/vnd.sun.wadl+xml</type>
<rel>describedby</rel>
</link>
</links>
</version>

129
api-ref/src/wadls/compute-api/src/v3/wadl/os-extensions-v3.wadl Normal file
View File

@ -0,0 +1,129 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
<!-- You can resolve the entites with xmllint -->
<!-- -->
<!-- xmllint -noent os-extensions-v3.wadl -->
<!--*******************************************************-->
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
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">
<resources base="https://servers.api.openstack.com"
xml:id="os-extensions-v3">
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resource id="version" type="#VersionDetails" path="//v3">
<resource id="extensions" type="#ExtensionList"
path="extensions">
<resource id="extension" path="{alias}">
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alias" style="template"
type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>An alias, which is a
name for a pointer to a resource. For
example, a named extension.</para>
</wadl:doc>
</param>
<method href="#getExtension"/>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- Resource Types -->
<!--*******************************************************-->
<resource_type id="VersionDetails">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Version details">
<para>Details for a version.</para>
</wadl:doc>
<method href="#versionDetails"/>
</resource_type>
<resource_type id="ExtensionList">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Detail image list">
<para>A list of supported extensions.</para>
</wadl:doc>
<method href="#listExtensions"/>
</resource_type>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<!-- Extensions -->
<method name="GET" id="listExtensions">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List extensions">
<para role="shortdesc">Lists available extensions.</para>
</wadl:doc>
<response status="200 203">
<param name="next" style="plain" type="xsd:anyURI"
path="/common:extensions/atom:link[@rel='next']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the next metadata
item.</para></wadl:doc>
<link resource_type="#ExtensionList" rel="next"/>
</param>
<param name="previous" style="plain" type="xsd:anyURI"
path="/common:extensions/atom:link[@rel='previous']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the previous metadata
item.</para></wadl:doc>
<link resource_type="#ExtensionList" rel="previous"/>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/all_extensions/extensionsv3-get-resp.json"
/>
</wadl:doc>
</representation>
<!-- <representation mediaType="application/xml"
element="common:extensions">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/all_extensions/extensionsv3-get-resp.xml"
/>
</wadl:doc>
</representation>-->
</response>
</method>
<method name="GET" id="getExtension">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get extension">
<para role="shortdesc">Shows details about a specified
extension.</para>
<para>Extensions introduce features and vendor-specific
functionality to the API without requiring a version
change.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="../api_samples/extensionv3.json"
/>
</wadl:doc>
</representation>
<!-- <representation mediaType="application/xml"
element="common:extension">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="../api_samples/extensionv3.xml"
/>
</wadl:doc>
</representation>-->
</response>
</method>
</application>

81
api-ref/src/wadls/compute-api/src/v3/wadl/os-versions-v3.wadl Executable file
View File

@ -0,0 +1,81 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
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">
<resources base="https://servers.api.openstack.com"
xml:id="versions-v3">
<resource id="versions" path="//">
<method href="#listVersionsv3"/>
</resource>
<resource id="version" type="#VersionDetails" path="//v3"/>
</resources>
<resource_type id="VersionDetails">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Version details">
<para>Details for a version.</para>
</wadl:doc>
<method href="#showVersionDetailsv3"/>
</resource_type>
<!-- *******************************************************-->
<!-- Versions -->
<!--*******************************************************-->
<method name="GET" id="listVersionsv3">
<wadl:doc xml:lang="EN" title="List API versions"
xmlns="http://docbook.org/ns/docbook"><para
role="shortdesc">Lists information about all Compute API
versions.</para>
</wadl:doc>
<response status="200 300">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/compute-versions-response.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/compute-versions-response.xml"
/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="showVersionDetailsv3">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show API v3 details">
<para role="shortdesc">Shows details for Compute API
v3.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/compute-versionsv3-response.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/version-get-resp.xml"/>
</wadl:doc>
<param name="location" style="plain" type="xsd:anyURI"
required="true"
path="/common:version/atom:link[@rel='self']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Location"><para>Full URL
to a service or server.</para></wadl:doc>
<link resource_type="#VersionDetails" rel="self"/>
</param>
</representation>
</response>
</method>
</application>

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

@ -100,15 +100,13 @@
</resource>
</resource>
</resources>
<!--Token Methods... -->
<!-- Version -->
<method name="GET" id="getVersionInfo">
<wadl:doc xml:lang="EN" title="Show version details"
xmlns="http://docbook.org/ns/docbook"><para
role="shortdesc">Shows details for a specified API
version.</para>
<remark>Reviewer: in the DNS project, we have been
role="shortdesc">Shows details for the Database
Service API v1.0.</para>
<!-- <remark>Reviewer: in the DNS project, we have been
requested by the customer to provide a table of
parameters (should be pulled automatically if parms
defined in wadl) and a table of attributes (for calls
@ -117,7 +115,7 @@
too.</remark>
<remark>Reviewer: These tables probably need 4 columns:
name; parameter type: e.g. template, query, etc.; data
type: string, etc.; required?; description.</remark>
type: string, etc.; required?; description.</remark>-->
</wadl:doc>
<request>
<representation mediaType="application/json">
@ -143,8 +141,8 @@
<method name="GET" id="getVersions">
<wadl:doc xml:lang="EN" title="List versions"
xmlns="http://docbook.org/ns/docbook"><para
role="shortdesc">Lists information about all API
versions.</para>
role="shortdesc">Lists information about all Database
Service API versions.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
@ -327,12 +325,13 @@
role="shortdesc">Deletes a specified database
instance, including any associated data.</para>
<note><para>This operation does not delete any read
slaves.</para></note><remark>Reviewer: please
slaves.</para></note>
<!--<remark>Reviewer: please
provide a description of read slaves that I can add to
the previous note.</remark><note><para>This operation
is not allowed when the instance state is either
<code>REBUILDING</code> or
<code>BUILDING</code>.</para></note>
the previous note.</remark>-->
<note><para>This operation is not allowed when the
instance state is either <code>REBUILDING</code>
or <code>BUILDING</code>.</para></note>
</wadl:doc>
<request>
<representation mediaType="application/json">
@ -1126,9 +1125,9 @@
<para>This resource is identical to the flavors found in
the OpenStack Nova API, but without the disk
property.</para>
<remark>Reviewer: please check that the xml example below
<!-- <remark>Reviewer: please check that the xml example below
is now correct. Previously it was reported to be
incorrect.</remark>
incorrect.</remark>-->
</wadl:doc>
<request>
<representation mediaType="application/json">

4
api-ref/src/wadls/databases-api/xsd/samples/db-version-response-json-http.txt
View File

@ -1,4 +1,4 @@
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 150
Date: Wed, 25 Jan 2012 21:53:04 GMT
Content-Length: 158
Date: Tue, 22 Apr 2014 19:02:58 GMT

26
api-ref/src/wadls/databases-api/xsd/samples/db-version-response.json
View File

@ -1,13 +1,15 @@
{
"version":{
"id":"v1.0",
"links":[
{
"href":"https://openstack.example.com/v1.0/",
"rel":"self"
}
],
"status":"CURRENT",
"updated":"2012-01-01T00:00:00Z"
}
}
"versions":[
{
"status":"CURRENT",
"updated":"2012-08-01T00:00:00Z",
"id":"v1.0",
"links":[
{
"href":"http://23.253.228.211:8779/v1.0/",
"rel":"self"
}
]
}
]
}

23
api-ref/src/wadls/identity-api/src/v2.0/samples/identity-version-response.json Normal file
View File

@ -0,0 +1,23 @@
{
"version":{
"status":"stable",
"updated":"2013-03-06T00:00:00Z",
"media-types":[
{
"base":"application/json",
"type":"application/vnd.openstack.identity-v3+json"
},
{
"base":"application/xml",
"type":"application/vnd.openstack.identity-v3+xml"
}
],
"id":"v3.0",
"links":[
{
"href":"http://23.253.228.211:35357/v3/",
"rel":"self"
}
]
}
}

13
api-ref/src/wadls/identity-api/src/v2.0/samples/identity-version-response.xml Normal file
View File

@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<version xmlns="http://docs.openstack.org/identity/api/v3"
status="stable" updated="2013-03-06T00:00:00Z" id="v3.0">
<media-types>
<media-type base="application/json"
type="application/vnd.openstack.identity-v3+json"/>
<media-type base="application/xml"
type="application/vnd.openstack.identity-v3+xml"/>
</media-types>
<links>
<link href="http://23.253.228.211:35357/v3/" rel="self"/>
</links>
</version>

33
api-ref/src/wadls/identity-api/src/v2.0/samples/identity-versions-response.json Normal file
View File

@ -0,0 +1,33 @@
{
"version":{
"status":"stable",
"updated":"2014-04-17T00:00:00Z",
"media-types":[
{
"base":"application/json",
"type":"application/vnd.openstack.identity-v2.0+json"
},
{
"base":"application/xml",
"type":"application/vnd.openstack.identity-v2.0+xml"
}
],
"id":"v2.0",
"links":[
{
"href":"http://23.253.228.211:5000/v2.0/",
"rel":"self"
},
{
"href":"http://docs.openstack.org/api/openstack-identity-service/2.0/content/",
"type":"text/html",
"rel":"describedby"
},
{
"href":"http://docs.openstack.org/api/openstack-identity-service/2.0/identity-dev-guide-2.0.pdf",
"type":"application/pdf",
"rel":"describedby"
}
]
}
}

26
api-ref/src/wadls/identity-api/src/v2.0/samples/identity-versions-response.xml Normal file
View File

@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<version xmlns="http://docs.openstack.org/identity/api/v2.0"
status="stable" updated="2014-04-17T00:00:00Z" id="v2.0">
<media-types>
<media-type base="application/json"
type="application/vnd.openstack.identity-v2.0+json"/>
<media-type base="application/xml"
type="application/vnd.openstack.identity-v2.0+xml"/>
</media-types>
<links>
<link href="http://23.253.228.211:5000/v2.0/" rel="self"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/2.0/content/"
type="text/html" rel="describedby"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/2.0/identity-dev-guide-2.0.pdf"
type="application/pdf" rel="describedby"/>
</links>
<link href="http://23.253.228.211:5000/v2.0/" rel="self"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/2.0/content/"
type="text/html" rel="describedby"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/2.0/identity-dev-guide-2.0.pdf"
type="application/pdf" rel="describedby"/>
</version>

23
api-ref/src/wadls/identity-api/src/v2.0/samples/version-resp.json Normal file
View File

@ -0,0 +1,23 @@
{
"version":{
"status":"stable",
"updated":"2013-03-06T00:00:00Z",
"media-types":[
{
"base":"application/json",
"type":"application/vnd.openstack.identity-v3+json"
},
{
"base":"application/xml",
"type":"application/vnd.openstack.identity-v3+xml"
}
],
"id":"v3.0",
"links":[
{
"href":"http://localhost:5000/v3/",
"rel":"self"
}
]
}
}

20
api-ref/src/wadls/identity-api/src/v2.0/samples/version-resp.xml Normal file
View File

@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<version xmlns="http://docs.openstack.org/identity/api/v3"
status="stable" updated="2013-03-06T00:00:00Z" id="v3">
<media-types>
<media-type base="application/json"
type="application/vnd.openstack.identity-v3+json"/>
<media-type base="application/xml"
type="application/vnd.openstack.identity-v3+xml"/>
</media-types>
<links>
<link href="http://localhost:5000/v3/" rel="self"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/3/content/"
type="text/html" rel="describedby"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/3/identity-dev-guide-3.pdf"
type="application/pdf" rel="describedby"/>
</links>
</version>

4
api-ref/src/wadls/identity-api/src/v2.0/samples/version.json
View File

@ -1,7 +1,7 @@
{
"version":{
"status":"stable",
"updated":"2013-03-06T00:00:00Z",
"updated":"2014-04-17T00:00:00Z",
"media-types":[
{
"base":"application/json",
@ -15,7 +15,7 @@
"id":"v2.0",
"links":[
{
"href":"http://localhost:5000/v2.0/",
"href":"http://23.253.228.211:5000/v2.0/",
"rel":"self"
},
{

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

@ -27,6 +27,9 @@
<!-- All Resources -->
<!--*******************************************************-->
<resources base="http://localhost:5000" xml:id="identity-v2.0">
<resource id="versions" path="//">
<method href="#getVersions-v2"/>
</resource>
<resource id="version" type="#VersionDetails" path="//v2.0">
<resource id="extensions" type="#ExtensionList"
path="extensions">
@ -66,11 +69,9 @@
</resource>
</resource>
</resources>
<!--***************************************************-->
<!-- Resource Types -->
<!--*******************************************************-->
<resource_type id="VersionDetails">
<method href="#getVersionInfo-v2.0"/>
</resource_type>
@ -85,18 +86,44 @@
<!-- All Methods -->
<!--*******************************************************-->
<!-- Version -->
<method name="GET" id="getVersions-v2">
<wadl:doc xml:lang="EN" title="List versions"
xmlns="http://docbook.org/ns/docbook"><para
role="shortdesc">Lists information about all Identity
API versions.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/identity-versions-response.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/identity-versions-response.xml"
/>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="GET" id="getVersionInfo-v2.0">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get version details">
<para role="shortdesc">Gets detailed information about a
specified version of the Identity API.</para>
title="Show version details">
<para role="shortdesc">Shows details for the Identity API
v2.0.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Get version information: JSON response">
<xsdxt:code href="../samples/version.json"/>
<xsdxt:code
href="../samples/identity-version-response.json"
/>
</xsdxt:sample>
</wadl:doc>
</representation>
@ -105,7 +132,9 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<xsdxt:sample
title="Get version information: XML response">
<xsdxt:code href="../samples/version.xml"/>
<xsdxt:code
href="../samples/identity-version-response.xml"
/>
</xsdxt:sample>
</wadl:doc>
</representation>

23
api-ref/src/wadls/identity-api/src/v3/samples/identity-version-resp.json Normal file
View File

@ -0,0 +1,23 @@
{
"version":{
"status":"stable",
"updated":"2013-03-06T00:00:00Z",
"media-types":[
{
"base":"application/json",
"type":"application/vnd.openstack.identity-v3+json"
},
{
"base":"application/xml",
"type":"application/vnd.openstack.identity-v3+xml"
}
],
"id":"v3.0",
"links":[
{
"href":"http://23.253.228.211:35357/v3/",
"rel":"self"
}
]
}
}

13
api-ref/src/wadls/identity-api/src/v3/samples/identity-version-resp.xml Normal file
View File

@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<version xmlns="http://docs.openstack.org/identity/api/v3"
status="stable" updated="2013-03-06T00:00:00Z" id="v3.0">
<media-types>
<media-type base="application/json"
type="application/vnd.openstack.identity-v3+json"/>
<media-type base="application/xml"
type="application/vnd.openstack.identity-v3+xml"/>
</media-types>
<links>
<link href="http://23.253.228.211:35357/v3/" rel="self"/>
</links>
</version>

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

@ -34,8 +34,11 @@
<resources base="http://localhost:35357"
xml:id="identity-admin-v3">
<!-- FYI: double slash needed in path to get a single slash to display -->
<resource id="versions" path="//v3">
<method href="#getVersionDetails"/>
<resource id="versions" path="//">
<method href="#getVersions-identity-v3"/>
</resource>
<resource id="version" path="//v3">
<method href="#showVersionDetails-identity-v3"/>
<resource id="tokens" path="auth/tokens">
<method href="#authenticate"/>
<method href="#validateTokens"/>
@ -436,27 +439,48 @@
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<!--Version Operations-->
<method name="GET" id="getVersionDetails">
<method name="GET" id="getVersions-identity-v3">
<wadl:doc xml:lang="EN" title="List versions"
xmlns="http://docbook.org/ns/docbook"><para
role="shortdesc">Lists information about all Identity
API versions.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/identity-versions-response.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/identity-versions-response.xml"
/>
</wadl:doc>
</representation>
</response> &commonFaults; &getFaults; </method>
<method name="GET" id="showVersionDetails-identity-v3">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show version details">
<para>Shows details for a specified version of the
API.</para></wadl:doc> &commonFaults; &getFaults;
<response status="200"> &versionParam; &statusParam;
&updatedParam; &media-typesParam; &version-idParam;
&version-linksParam; <representation
mediaType="application/json">
title="Show API version details">
<para>Shows details for the Identity API
v3.</para></wadl:doc> &commonFaults; &getFaults; <response
status="200"> &versionParam; &statusParam; &updatedParam;
&media-typesParam; &version-idParam; &version-linksParam;
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:sample>
<xsdxt:code
href="../samples/version-resp.json"/>
href="../samples/identity-version-resp.json"
/>
</xsdxt:sample>
</wadl:doc>
</representation>
@ -464,7 +488,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:sample>
<xsdxt:code href="../samples/version-resp.xml"
<xsdxt:code
href="../samples/identity-version-resp.xml"
/>
</xsdxt:sample>
</wadl:doc>

58
api-ref/src/wadls/identity-api/src/v3/wadl/samples/identity-versions-response.json Normal file
View File

@ -0,0 +1,58 @@
{
"versions":{
"values":[
{
"status":"stable",
"updated":"2013-03-06T00:00:00Z",
"media-types":[
{
"base":"application/json",
"type":"application/vnd.openstack.identity-v3+json"
},
{
"base":"application/xml",
"type":"application/vnd.openstack.identity-v3+xml"
}
],
"id":"v3.0",
"links":[
{
"href":"http://23.253.228.211:5000/v3/",
"rel":"self"
}
]
},
{
"status":"stable",
"updated":"2014-04-17T00:00:00Z",
"media-types":[
{
"base":"application/json",
"type":"application/vnd.openstack.identity-v2.0+json"
},
{
"base":"application/xml",
"type":"application/vnd.openstack.identity-v2.0+xml"
}
],
"id":"v2.0",
"links":[
{
"href":"http://23.253.228.211:5000/v2.0/",
"rel":"self"
},
{
"href":"http://docs.openstack.org/api/openstack-identity-service/2.0/content/",
"type":"text/html",
"rel":"describedby"
},
{
"href":"http://docs.openstack.org/api/openstack-identity-service/2.0/identity-dev-guide-2.0.pdf",
"type":"application/pdf",
"rel":"describedby"
}
]
}
]
}
}

38
api-ref/src/wadls/identity-api/src/v3/wadl/samples/identity-versions-response.xml Normal file
View File

@ -0,0 +1,38 @@
<?xml version="1.0" encoding="UTF-8"?>
<versions xmlns="http://docs.openstack.org/identity/api/v2.0">
<version status="stable" updated="2013-03-06T00:00:00Z" id="v3.0">
<media-types>
<media-type base="application/json"
type="application/vnd.openstack.identity-v3+json"/>
<media-type base="application/xml"
type="application/vnd.openstack.identity-v3+xml"/>
</media-types>
<links>
<link href="http://23.253.228.211:5000/v3/" rel="self"/>
</links>
</version>
<version status="stable" updated="2014-04-17T00:00:00Z" id="v2.0">
<media-types>
<media-type base="application/json"
type="application/vnd.openstack.identity-v2.0+json"/>
<media-type base="application/xml"
type="application/vnd.openstack.identity-v2.0+xml"/>
</media-types>
<links>
<link href="http://23.253.228.211:5000/v2.0/" rel="self"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/2.0/content/"
type="text/html" rel="describedby"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/2.0/identity-dev-guide-2.0.pdf"
type="application/pdf" rel="describedby"/>
</links>
<link href="http://23.253.228.211:5000/v2.0/" rel="self"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/2.0/content/"
type="text/html" rel="describedby"/>
<link
href="http://docs.openstack.org/api/openstack-identity-service/2.0/identity-dev-guide-2.0.pdf"
type="application/pdf" rel="describedby"/>
</version>
</versions>

114
api-ref/src/wadls/image-api/src/v1/os-image-1.0.wadl
View File

@ -1,6 +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 -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
@ -23,16 +22,17 @@
<include href="../v2/xsd/api.xsd"/>
<include href="../v2/xsd/api-common.xsd"/>
</grammars>
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://glance.example.com/"
xml:id="os-image-v1.0">
<resource id="info" path="//v1">
<resource id="versions" path="//">
<method href="#listVersions-image-v1"/>
</resource>
<resource id="version" type="#VersionDetails" path="//v1">
<resource id="Images" type="#ImageList" path="images">
<method href="#createImage"/>
<method href="#createImage-v1"/>
<resource path="detail" type="#DetailImageList"
id="detail"/>
<resource path="{image_id}" id="image_id">
@ -44,12 +44,12 @@
stored through the image API. Typically a
UUID.</wadl:doc>
</param>
<method href="#getImage"/>
<method href="#getImageHeaders"/>
<method href="#updateImage"/>
<method href="#deleteImage"/>
<method href="#getImage-v1"/>
<method href="#getImageHeaders-v1"/>
<method href="#updateImage-v1"/>
<method href="#deleteImage-v1"/>
<resource id="members" path="members">
<method href="#replaceMember"/>
<method href="#replaceMember-v1"/>
<resource path="{owner_id}" id="owner-id">
<param name="owner_id" style="template"
type="xsd:string">
@ -59,8 +59,8 @@
>Owner ID, which is the tenant
ID.</wadl:doc>
</param>
<method href="#addMember"/>
<method href="#removeMember"/>
<method href="#addMember-v1"/>
<method href="#removeMember-v1"/>
</resource>
</resource>
</resource>
@ -76,27 +76,81 @@
ID.</para>
</wadl:doc>
</param>
<method href="#getSharedImages"/>
<method href="#getSharedImages-v1"/>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- Resource Types -->
<!--*******************************************************-->
<resource_type id="ImageList">
<method href="#listImage"/>
<method href="#listImage-v1"/>
</resource_type>
<resource_type id="DetailImageList">
<method href="#listDetailImage"/>
<method href="#listDetailImage-v1"/>
</resource_type>
<resource_type id="VersionDetails">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Version details">
<para>Details for a version.</para>
</wadl:doc>
<method href="#showVersionDetails-image-v1"/>
</resource_type>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<method name="POST" id="createImage">
<method name="GET" id="listVersions-image-v1">
<wadl:doc xml:lang="EN" title="List API versions"
xmlns="http://docbook.org/ns/docbook"><para
role="shortdesc">Lists information about all Image
Service API versions.</para>
</wadl:doc>
<response status="200 300">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/image-versions-response.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="showVersionDetails-image-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show API v1 details">
<para role="shortdesc">Shows details for Image Service API
v1.</para>
</wadl:doc>
<response status="200 203">
<!-- <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/versionv1-get-resp.json"
/>
</wadl:doc>
</representation>-->
<!-- this call fails - opened bug 1311243 -->
<!--<representation mediaType="application/xml"
element="common:version">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/version-get-resp.xml"/>
</wadl:doc>
<param name="location" style="plain" type="xsd:anyURI"
required="true"
path="/common:version/atom:link[@rel='self']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Location"><para>Full URL
to a service or server.</para></wadl:doc>
<link resource_type="#VersionDetails" rel="self"/>
</param>
</representation>-->
</response>
</method>
<method name="POST" id="createImage-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create image">
<para role="shortdesc">Registers a virtual machine (VM)
@ -258,7 +312,7 @@
<representation mediaType="application/json"/>
</response>
</method>
<method name="PUT" id="updateImage">
<method name="PUT" id="updateImage-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update image">
<para role="shortdesc">Updates an image, uploads an image
@ -276,7 +330,7 @@
<representation mediaType="application/json"/>
</response>
</method>
<method name="GET" id="getImage">
<method name="GET" id="getImage-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get image details and image binary">
<para role="shortdesc">Returns the image details as
@ -294,7 +348,7 @@
</representation>
</response>
</method>
<method name="HEAD" id="getImageHeaders">
<method name="HEAD" id="getImageHeaders-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get image details as headers">
<para role="shortdesc">Returns the image details as
@ -305,14 +359,14 @@
element="imageapi:image"/>
</response>
</method>
<method name="DELETE" id="deleteImage">
<method name="DELETE" id="deleteImage-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete image">
<para role="shortdesc">Deletes the specified image.</para>
</wadl:doc>
<response status="204"/>
</method>
<method name="GET" id="getSharedImages">
<method name="GET" id="getSharedImages-v1">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="List shared images">
<para role="shortdesc">Lists the VM images shared with a
@ -352,7 +406,7 @@
</representation>
</response>
</method>
<method name="GET" id="listImage">
<method name="GET" id="listImage-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List image">
<para role="shortdesc">Lists public VM images.</para>
@ -425,7 +479,7 @@
</response>
</method>
<method name="GET" id="listDetailImage">
<method name="GET" id="listDetailImage-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List image details">
<para role="shortdesc">Lists details for available
@ -523,7 +577,7 @@
<representation mediaType="application/json"/>
</response>
</method>
<method name="PUT" id="addMember">
<method name="PUT" id="addMember-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add member">
<para role="shortdesc">Adds a member to an image.</para>
@ -549,7 +603,7 @@
</request>
<response status="204"/>
</method>
<method name="PUT" id="replaceMember">
<method name="PUT" id="replaceMember-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Replace member">
<para role="shortdesc">Replaces a membership list for an
@ -567,7 +621,7 @@
</request>
<response status="204"/>
</method>
<method name="DELETE" id="removeMember">
<method name="DELETE" id="removeMember-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete image">
<para role="shortdesc">Removes a member from an

54
api-ref/src/wadls/image-api/src/v1/samples/image-versions-response.json Normal file
View File

@ -0,0 +1,54 @@
{
"versions":[
{
"status":"CURRENT",
"id":"v2.2",
"links":[
{
"href":"http://23.253.228.211:9292/v2/",
"rel":"self"
}
]
},
{
"status":"SUPPORTED",
"id":"v2.1",
"links":[
{
"href":"http://23.253.228.211:9292/v2/",
"rel":"self"
}
]
},
{
"status":"SUPPORTED",
"id":"v2.0",
"links":[
{
"href":"http://23.253.228.211:9292/v2/",
"rel":"self"
}
]
},
{
"status":"CURRENT",
"id":"v1.1",
"links":[
{
"href":"http://23.253.228.211:9292/v1/",
"rel":"self"
}
]
},
{
"status":"SUPPORTED",
"id":"v1.0",
"links":[
{
"href":"http://23.253.228.211:9292/v1/",
"rel":"self"
}
]
}
]
}

78
api-ref/src/wadls/image-api/src/v2.0/os-image-2.0.wadl
View File

@ -31,8 +31,8 @@
xml:id="os-image-v2.0">
<resource id="info" path="//v2">
<resource id="images" path="images">
<method href="#createImage"/>
<method href="#listImages"/>
<method href="#createImage-v2"/>
<method href="#listImages-v2"/>
<resource path="{image_id}" id="image_id">
<param name="image_id" style="template"
type="csapi:uuid">
@ -43,12 +43,12 @@
API. Typically a UUID.</para>
</wadl:doc>
</param>
<method href="#getImage"/>
<method href="#updateImage"/>
<method href="#deleteImage"/>
<method href="#getImage-v2"/>
<method href="#updateImage-v2"/>
<method href="#deleteImage-v2"/>
<resource id="file" path="file">
<method href="#storeImageFile"/>
<method href="#getImageFile"/>
<method href="#storeImageFile-v2"/>
<method href="#getImageFile-v2"/>
</resource>
<resource id="Tags" path="tags">
<resource path="{tag}" id="tag">
@ -59,8 +59,8 @@
xml:lang="EN" title="Image tag"
><para>Image tag.</para></wadl:doc>
</param>
<method href="#addImageTag"/>
<method href="#deleteImageTag"/>
<method href="#addImageTag-v2"/>
<method href="#deleteImageTag-v2"/>
</resource>
</resource>
</resource>
@ -70,7 +70,7 @@
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<method name="POST" id="createImage">
<method name="POST" id="createImage-v2">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create image">
<para role="shortdesc">Creates a virtual machine (VM)
@ -110,19 +110,21 @@
</wadl:doc>
</param>
<representation mediaType="application/json">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../v2/samples/image-create-req.json"/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="201">
<doc xml:lang="EN">Successful HTTP response is 201.
Created with a Location header that contains the
newly-created URI for the image. Response body
represents the created image entity. <xsdxt:code
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">Successful HTTP
response is 201. Created with a Location header that
contains the newly-created URI for the image. Response
body represents the created image entity. <xsdxt:code
href="../v2/samples/image-create-response.json"/>
</doc>
</wadl:doc>
<param name="location" style="plain" type="xsd:anyURI"
required="true"
path="/common:version/atom:link[@rel='self']/@href">
@ -135,16 +137,16 @@
</param>
<representation mediaType="application/json"
element="image">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../v2/samples/image-create-response.json"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
<method name="PATCH" id="updateImage">
<method name="PATCH" id="updateImage-v2">
<wadl:doc xml:lang="EN" title="Update image"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Updates a specified image.</para>
@ -192,25 +194,27 @@
</param>
<representation mediaType="application/json"
element="image">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../v2/samples/image-update-req.json"/>
</doc>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json"
element="image">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../v2/samples/image-details-response.json"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
<!-- Get Image -->
<method name="GET" id="getImage">
<method name="GET" id="getImage-v2">
<wadl:doc xml:lang="EN" title="Get image details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Gets details for a specified
@ -220,15 +224,16 @@
<response status="200">
<representation mediaType="application/json"
element="image">
<doc xml:lang="EN">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code
href="../v2/samples/image-details-response.json"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="listImages">
<method name="GET" id="listImages-v2">
<wadl:doc xml:lang="EN" title="List images"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists public virtual machine (VM)
@ -370,15 +375,16 @@
</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="../v2/samples/image-list-response.json"
/>
</doc>
</wadl:doc>
</representation>
</response>
</method>
<method name="DELETE" id="deleteImage">
<method name="DELETE" id="deleteImage-v2">
<wadl:doc xml:lang="EN" title="Delete image"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Deletes a specified image.</para>
@ -392,7 +398,7 @@
</wadl:doc>
<response status="204"/>
</method>
<method name="PUT" id="storeImageFile">
<method name="PUT" id="storeImageFile-v2">
<wadl:doc xml:lang="EN" title="Upload binary image data"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Uploads binary image data.</para>
@ -406,7 +412,7 @@
</wadl:doc>
<response status="204"/>
</method>
<method name="GET" id="getImageFile">
<method name="GET" id="getImageFile-v2">
<wadl:doc xml:lang="EN" title="Download binary image data"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Downloads binary image data.</para>
@ -423,7 +429,7 @@
</wadl:doc>
<response status="200"/>
</method>
<method name="PUT" id="addImageTag">
<method name="PUT" id="addImageTag-v2">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add image tag">
<para role="shortdesc">Adds a specified tag to a specified
@ -445,7 +451,7 @@
</wadl:doc>
<response status="204"/>
</method>
<method name="DELETE" id="deleteImageTag">
<method name="DELETE" id="deleteImageTag-v2">
<wadl:doc xml:lang="EN" title="Delete image tag"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Deletes a specified tag from a

88
api-ref/src/wadls/image-api/src/v2/os-image-v2.wadl
View File

@ -21,15 +21,16 @@
<include href="xsd/api.xsd"/>
<include href="xsd/api-common.xsd"/>
</grammars>
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://glance.example.com/" xml:id="os-image-v2">
<resource id="info" path="//v2">
<resource id="Images" type="#ImageList"
path="images">
<method href="#createImage"/>
<resource id="versions" path="//">
<method href="#listVersions-image-v2"/>
</resource>
<resource id="version" path="//v2">
<resource id="Images" type="#ImageList" path="images">
<method href="#createImage-v2"/>
<resource path="{image_id}" id="image_id">
<param name="image_id" style="template"
type="csapi:uuid">
@ -38,12 +39,12 @@
stored through the image API. Typically a
UUID.</wadl:doc>
</param>
<method href="#getImage"/>
<method href="#updateImage"/>
<method href="#deleteImage"/>
<method href="#getImage-v2"/>
<method href="#updateImage-v2"/>
<method href="#deleteImage-v2"/>
<resource id="file" path="file">
<method href="#storeImageFile"/>
<method href="#getImageFile"/>
<method href="#storeImageFile-v2"/>
<method href="#getImageFile-v2"/>
</resource>
<resource id="Tags" path="tags">
<resource path="{tag}" id="tag">
@ -53,13 +54,13 @@
xmlns="http://www.w3.org/1999/xhtml"
title="Tag">Image tag.</wadl:doc>
</param>
<method href="#addImageTag"/>
<method href="#deleteImageTag"/>
<method href="#addImageTag-v2"/>
<method href="#deleteImageTag-v2"/>
</resource>
</resource>
<resource id="Members" type="#MemberList"
path="members">
<method href="#createImageMember"/>
<method href="#createImageMember-v2"/>
<resource path="{member_id}" id="member_id">
<param name="member_id" style="template"
type="xsd:string">
@ -70,9 +71,9 @@
ID of the user with whom the image
is being shared.</wadl:doc>
</param>
<method href="#getImageMember"/>
<method href="#deleteImageMember"/>
<method href="#updateImageMember"/>
<method href="#getImageMember-v2"/>
<method href="#deleteImageMember-v2"/>
<method href="#updateImageMember-v2"/>
</resource>
</resource>
</resource>
@ -83,15 +84,31 @@
<!-- Resource Types -->
<!--*******************************************************-->
<resource_type id="ImageList">
<method href="#listImages"/>
<method href="#listImages-v2"/>
</resource_type>
<resource_type id="MemberList">
<method href="#listImageMembers"/>
<method href="#listImageMembers-v2"/>
</resource_type>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<method name="POST" id="createImage">
<method name="GET" id="listVersions-image-v2">
<wadl:doc xml:lang="EN" title="List API versions"
xmlns="http://docbook.org/ns/docbook"><para
role="shortdesc">Lists information about all Image
Service API versions.</para>
</wadl:doc>
<response status="200 300">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/image-versions-response.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="POST" id="createImage-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create image">
<para role="shortdesc">Creates a virtual machine (VM)
@ -159,7 +176,7 @@
</representation>
</response>
</method>
<method name="PATCH" id="updateImage">
<method name="PATCH" id="updateImage-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Update image">
<para role="shortdesc">Updates a specified image. (Since
@ -203,7 +220,7 @@
</response>
</method>
<!-- Get Image -->
<method name="GET" id="getImage">
<method name="GET" id="getImage-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get image details">
<para role="shortdesc">Gets details for a specified image.
@ -220,7 +237,7 @@
</representation>
</response>
</method>
<method name="GET" id="listImages">
<method name="GET" id="listImages-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="List images">
<para role="shortdesc">Lists public virtual machine (VM)
@ -398,7 +415,7 @@
</representation>
</response>
</method>
<method name="GET" id="listImageMembers">
<method name="GET" id="listImageMembers-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="List image members">
<para role="shortdesc">Lists the tenants with whom this
@ -423,7 +440,7 @@
</response>
<response status="404"/>
</method>
<method name="DELETE" id="deleteImage">
<method name="DELETE" id="deleteImage-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Delete image">
<para role="shortdesc">Deletes a specified image. (Since
@ -439,7 +456,7 @@
<response status="204"/>
<response status="403"/>
</method>
<method name="PUT" id="storeImageFile">
<method name="PUT" id="storeImageFile-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Upload binary image data">
<para role="shortdesc">Uploads binary image data. (Since
@ -453,7 +470,7 @@
</wadl:doc>
<response status="204"/>
</method>
<method name="GET" id="getImageFile">
<method name="GET" id="getImageFile-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Download binary image data">
<para role="shortdesc">Downloads binary image data. (Since
@ -469,7 +486,7 @@
</wadl:doc>
<response status="200 204"/>
</method>
<method name="PUT" id="addImageTag">
<method name="PUT" id="addImageTag-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Add image tag">
<para role="shortdesc">Adds a specified tag to a specified
@ -477,7 +494,7 @@
</wadl:doc>
<response status="200"/>
</method>
<method name="DELETE" id="deleteImageTag">
<method name="DELETE" id="deleteImageTag-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Delete image tag">
<para role="shortdesc">Deletes a specified tag from a
@ -485,12 +502,13 @@
</wadl:doc>
<response status="204"/>
</method>
<method name="GET" id="getImageMember">
<method name="GET" id="getImageMember-v2">
<wadl:doc xml:lang="EN" title="Get image member details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Gets details for a specified image member.</para>
<para>Response body is a single image member entity. (Since Image
API 2.2.)</para>
<para role="shortdesc">Gets details for a specified image
member.</para>
<para>Response body is a single image member entity.
(Since Image API 2.2.)</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
@ -502,7 +520,7 @@
</representation>
</response>
</method>
<method name="POST" id="createImageMember">
<method name="POST" id="createImageMember-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create image member">
<para role="shortdesc">Adds a specified tenant ID as an
@ -539,7 +557,7 @@
</representation>
</response>
</method>
<method name="PUT" id="updateImageMember">
<method name="PUT" id="updateImageMember-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Update image member">
<para role="shortdesc">Sets the specified status for the
@ -578,7 +596,7 @@
</representation>
</response>
</method>
<method name="DELETE" id="deleteImageMember">
<method name="DELETE" id="deleteImageMember-v2">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Delete image member">
<para role="shortdesc">Deletes a specified tenant ID from

54
api-ref/src/wadls/image-api/src/v2/samples/image-versions-response.json Normal file
View File

@ -0,0 +1,54 @@
{
"versions":[
{
"status":"CURRENT",
"id":"v2.2",
"links":[
{
"href":"http://23.253.228.211:9292/v2/",
"rel":"self"
}
]
},
{
"status":"SUPPORTED",
"id":"v2.1",
"links":[
{
"href":"http://23.253.228.211:9292/v2/",
"rel":"self"
}
]
},
{
"status":"SUPPORTED",
"id":"v2.0",
"links":[
{
"href":"http://23.253.228.211:9292/v2/",
"rel":"self"
}
]
},
{
"status":"CURRENT",
"id":"v1.1",
"links":[
{
"href":"http://23.253.228.211:9292/v1/",
"rel":"self"
}
]
},
{
"status":"SUPPORTED",
"id":"v1.0",
"links":[
{
"href":"http://23.253.228.211:9292/v1/",
"rel":"self"
}
]
}
]
}

34
api-ref/src/wadls/netconn-api/api_samples/version-v2-neutron-get-resp.json Normal file
View File

@ -0,0 +1,34 @@
{
"resources":[
{
"links":[
{
"href":"http://23.253.228.211:9696/v2.0/subnets",
"rel":"self"
}
],
"name":"subnet",
"collection":"subnets"
},
{
"links":[
{
"href":"http://23.253.228.211:9696/v2.0/networks",
"rel":"self"
}
],
"name":"network",
"collection":"networks"
},
{
"links":[
{
"href":"http://23.253.228.211:9696/v2.0/ports",
"rel":"self"
}
],
"name":"port",
"collection":"ports"
}
]
}

35
api-ref/src/wadls/netconn-api/api_samples/version-v2-neutron-get-resp.xml Normal file
View File

@ -0,0 +1,35 @@
<?xml version='1.0' encoding='UTF-8'?>
<resources xmlns="http://openstack.org/quantum/api/v2.0"
xmlns:quantum="http://openstack.org/quantum/api/v2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<resource>
<links>
<link>
<href>http://23.253.228.211:9696/v2.0/subnets</href>
<rel>self</rel>
</link>
</links>
<name>subnet</name>
<collection>subnets</collection>
</resource>
<resource>
<links>
<link>
<href>http://23.253.228.211:9696/v2.0/networks</href>
<rel>self</rel>
</link>
</links>
<name>network</name>
<collection>networks</collection>
</resource>
<resource>
<links>
<link>
<href>http://23.253.228.211:9696/v2.0/ports</href>
<rel>self</rel>
</link>
</links>
<name>port</name>
<collection>ports</collection>
</resource>
</resources>

69
api-ref/src/wadls/netconn-api/src/os-networks.wadl
View File

@ -21,7 +21,10 @@
<!--*******************************************************-->
<resources base="https://neutron.example.com/"
xml:id="os-networks-v2.0">
<resource id="version" path="//v2.0">
<resource id="versions" path="//">
<method href="#listVersionsv2-neutron"/>
</resource>
<resource id="version" type="#VersionDetails" path="//v2.0">
<resource id="Networks" type="#NetworkList"
path="networks">
<method href="#createNetwork"/>
@ -49,9 +52,73 @@
</wadl:doc>
<method href="#listNetworks"/>
</resource_type>
<resource_type id="VersionDetails">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Version details">
<para>Details for a version.</para>
</wadl:doc>
<method href="#showVersionDetailsv2-neutron"/>
</resource_type>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<method name="GET" id="listVersionsv2-neutron">
<wadl:doc xml:lang="EN" title="List API versions"
xmlns="http://docbook.org/ns/docbook"><para
role="shortdesc">Lists information about all
Networking API versions.</para>
</wadl:doc>
<response status="200 300">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/neutron-versions-response.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/neutron-versions-response.xml"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="showVersionDetailsv2-neutron">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show API v1 details">
<para role="shortdesc">Shows details for Networking API
v2.0.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/version-v2-neutron-get-resp.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/version-v2-neutron-get-resp.xml"
/>
</wadl:doc>
<param name="location" style="plain" type="xsd:anyURI"
required="true"
path="/common:version/atom:link[@rel='self']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Location"><para>Full URL
to a service or server.</para></wadl:doc>
<link resource_type="#VersionDetails" rel="self"/>
</param>
</representation>
</response>
</method>
<method name="GET" id="listNetworks">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List networks">

14
api-ref/src/wadls/netconn-api/src/samples/neutron-versions-response.json Normal file
View File

@ -0,0 +1,14 @@
{
"versions":[
{
"status":"CURRENT",
"id":"v2.0",
"links":[
{
"href":"http://23.253.228.211:9696/v2.0",
"rel":"self"
}
]
}
]
}

15
api-ref/src/wadls/netconn-api/src/samples/neutron-versions-response.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version='1.0' encoding='UTF-8'?>
<versions xmlns="http://openstack.org/quantum/api/v2.0"
xmlns:quantum="http://openstack.org/quantum/api/v2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<version>
<status>CURRENT</status>
<id>v2.0</id>
<links>
<link>
<href>http://23.253.228.211:9696/v2.0</href>
<rel>self</rel>
</link>
</links>
</version>
</versions>

44
api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl
View File

@ -13,6 +13,9 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<resources base="https://heat.example.com/"
xml:id="orchestration-api-v1.0">
<resource id="versions" path="//">
<method href="#getVersions-heat-v1"/>
</resource>
<resource id="version" path="//v1">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template">
@ -58,7 +61,8 @@
<method href="#stack_delete"/>
<resource path="abandon" id="abandon">
<method href="#stack_abandon"/>
<method href="#stack_abandon_preview"/>
<method href="#stack_abandon_preview"
/>
</resource>
<resource path="actions" id="actions">
<method href="#stack_action_suspend"/>
@ -189,6 +193,22 @@
</resource>
</resource>
</resources>
<method name="GET" id="getVersions-heat-v1">
<wadl:doc xml:lang="EN" title="List versions"
xmlns="http://docbook.org/ns/docbook"><para
role="shortdesc">Lists information about all
Orchestration API versions.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/heat-versions-response.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="stack_list">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List stack data">
@ -339,9 +359,9 @@
<param name="template_url" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The URL of the template to instantiate.
This value is ignored if the template is
supplied inline.</para>
<para>The URL of the template to instantiate. This
value is ignored if the template is supplied
inline.</para>
</wadl:doc>
</param>
<param name="template" style="plain" required="true">
@ -376,8 +396,8 @@
<param name="param_value-n" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>User-defined parameter values to pass to
the template.</para>
<para>User-defined parameter values to pass to the
template.</para>
</wadl:doc>
</param>
<param name="timeout_mins" style="plain" required="true">
@ -638,8 +658,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Abandon stack">
<para role="shortdesc">Deletes a specified stack but
leaves its resources intact, and returns data describing
the stack and its resources.</para>
leaves its resources intact, and returns data
describing the stack and its resources.</para>
</wadl:doc>
<response status="204">
<representation mediaType="application/json">
@ -654,8 +674,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Abandon stack preview">
<para role="shortdesc">Gets a preview of abandon data,
describing the current state of the stack and its
resources.</para>
describing the current state of the stack and its
resources.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
@ -948,7 +968,9 @@
<param name="config_id" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>The ID of the software configuration resource that runs when applying to the server.</para>
<para>The ID of the software configuration
resource that runs when applying to the
server.</para>
</wadl:doc>
</param>
<param name="server_id" style="plain" required="true">

14
api-ref/src/wadls/orchestration-api/src/v1/samples/heat-versions-response.json Normal file
View File

@ -0,0 +1,14 @@
{
"versions":[
{
"status":"CURRENT",
"id":"v1.0",
"links":[
{
"href":"http://23.253.228.211:8000/v1/",
"rel":"self"
}
]
}
]
}

33
api-ref/src/wadls/volume-api/src/api_samples/version-get-resp.json Normal file
View File

@ -0,0 +1,33 @@
{
"version":{
"status":"CURRENT",
"updated":"2012-01-04T11:33:21Z",
"media-types":[
{
"base":"application/xml",
"type":"application/vnd.openstack.volume+xml;version=1"
},
{
"base":"application/json",
"type":"application/vnd.openstack.volume+json;version=1"
}
],
"id":"v1.0",
"links":[
{
"href":"http://23.253.228.211:8776/v1/",
"rel":"self"
},
{
"href":"http://jorgew.github.com/block-storage-api/content/os-block-storage-1.0.pdf",
"type":"application/pdf",
"rel":"describedby"
},
{
"href":"http://docs.rackspacecloud.com/servers/api/v1.1/application.wadl",
"type":"application/vnd.sun.wadl+xml",
"rel":"describedby"
}
]
}
}

33
api-ref/src/wadls/volume-api/src/api_samples/versionv1-get-resp.json Normal file
View File

@ -0,0 +1,33 @@
{
"version":{
"status":"CURRENT",
"updated":"2012-01-04T11:33:21Z",
"media-types":[
{
"base":"application/xml",
"type":"application/vnd.openstack.volume+xml;version=1"
},
{
"base":"application/json",
"type":"application/vnd.openstack.volume+json;version=1"
}
],
"id":"v1.0",
"links":[
{
"href":"http://23.253.228.211:8776/v1/",
"rel":"self"
},
{
"href":"http://jorgew.github.com/block-storage-api/content/os-block-storage-1.0.pdf",
"type":"application/pdf",
"rel":"describedby"
},
{
"href":"http://docs.rackspacecloud.com/servers/api/v1.1/application.wadl",
"type":"application/vnd.sun.wadl+xml",
"rel":"describedby"
}
]
}
}

33
api-ref/src/wadls/volume-api/src/api_samples/versionv2-get-resp.json Normal file
View File

@ -0,0 +1,33 @@
{
"version":{
"status":"CURRENT",
"updated":"2012-01-04T11:33:21Z",
"media-types":[
{
"base":"application/xml",
"type":"application/vnd.openstack.volume+xml;version=1"
},
{
"base":"application/json",
"type":"application/vnd.openstack.volume+json;version=1"
}
],
"id":"v1.0",
"links":[
{
"href":"http://23.253.228.211:8776/v2/",
"rel":"self"
},
{
"href":"http://jorgew.github.com/block-storage-api/content/os-block-storage-1.0.pdf",
"type":"application/pdf",
"rel":"describedby"
},
{
"href":"http://docs.rackspacecloud.com/servers/api/v1.1/application.wadl",
"type":"application/vnd.sun.wadl+xml",
"rel":"describedby"
}
]
}
}

26
api-ref/src/wadls/volume-api/src/v1/samples/cinder-versions-response.json Normal file
View File

@ -0,0 +1,26 @@
{
"versions":[
{
"status":"CURRENT",
"updated":"2012-01-04T11:33:21Z",
"id":"v1.0",
"links":[
{
"href":"http://23.253.228.211:8776/v1/",
"rel":"self"
}
]
},
{
"status":"CURRENT",
"updated":"2012-11-21T11:33:21Z",
"id":"v2.0",
"links":[
{
"href":"http://23.253.228.211:8776/v2/",
"rel":"self"
}
]
}
]
}

73
api-ref/src/wadls/volume-api/src/v1/volume-api-v1.wadl
View File

@ -1,12 +1,15 @@
<?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/api/openstack-block-storage/1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<resources base="https://volume.example.com/"
xml:id="volume-api-v1.0">
<resource id="version" path="//v1">
<resource id="versions" path="//">
<method href="#listVersionsv1"/>
</resource>
<resource id="version" type="#VersionDetails" path="//v1">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template"
type="csapi:UUID">
@ -73,6 +76,72 @@
</resource>
</resource>
</resources>
<resource_type id="VersionDetails">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Version details">
<para>Details for a version.</para>
</wadl:doc>
<method href="#showVersionDetailsv1"/>
</resource_type>
<method name="GET" id="listVersionsv1">
<wadl:doc xml:lang="EN" title="List API versions"
xmlns="http://docbook.org/ns/docbook"><para
role="shortdesc">Lists information about all Block Storage API
versions.</para>
</wadl:doc>
<response status="200 300">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/cinder-versions-response.json"/>
</wadl:doc>
</representation>
<!-- The following call fails - opened bug #1311243 -->
<!-- <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/cinder-versions-response.xml"
/>
</wadl:doc>
</representation>-->
</response>
</method>
<method name="GET" id="showVersionDetailsv1">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show API v1 details">
<para role="shortdesc">Shows details for Block Storage API
v1.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/versionv1-get-resp.json"
/>
</wadl:doc>
</representation>
<!-- this call fails - opened bug 1311243 -->
<!--<representation mediaType="application/xml"
element="common:version">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/version-get-resp.xml"/>
</wadl:doc>
<param name="location" style="plain" type="xsd:anyURI"
required="true"
path="/common:version/atom:link[@rel='self']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Location"><para>Full URL
to a service or server.</para></wadl:doc>
<link resource_type="#VersionDetails" rel="self"/>
</param>
</representation>-->
</response>
</method>
<method name="POST" id="createVolume">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create volume">

26
api-ref/src/wadls/volume-api/src/v2/samples/cinder-versions-response.json Normal file
View File

@ -0,0 +1,26 @@
{
"versions":[
{
"status":"CURRENT",
"updated":"2012-01-04T11:33:21Z",
"id":"v1.0",
"links":[
{
"href":"http://23.253.228.211:8776/v1/",
"rel":"self"
}
]
},
{
"status":"CURRENT",
"updated":"2012-11-21T11:33:21Z",
"id":"v2.0",
"links":[
{
"href":"http://23.253.228.211:8776/v2/",
"rel":"self"
}
]
}
]
}

74
api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl
View File

@ -6,7 +6,10 @@
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<resources base="https://volume.example.com/" xml:id="volume-v2">
<resource id="version" path="//v2">
<resource id="versions" path="//">
<method href="#listVersions"/>
</resource>
<resource id="version" type="#VersionDetails" path="//v2">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template"
type="xsd:string">
@ -44,7 +47,7 @@
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The unique
identifier of an existing volume
identifier for an existing volume
type.</para></wadl:doc>
</param>
<method href="#getVolumeType"/>
@ -73,6 +76,73 @@
</resource>
</resource>
</resources>
<resource_type id="VersionDetails">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Version details">
<para>Details for a version.</para>
</wadl:doc>
<method href="#versionDetails"/>
</resource_type>
<!-- versions -->
<method name="GET" id="listVersions">
<wadl:doc xml:lang="EN" title="List API versions"
xmlns="http://docbook.org/ns/docbook"><para
role="shortdesc">Lists information about all Block Storage API
versions.</para>
</wadl:doc>
<response status="200 300">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/cinder-versions-response.json"/>
</wadl:doc>
</representation>
<!-- The following call fails - opened bug #1311243 -->
<!-- <representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="samples/cinder-versions-response.xml"
/>
</wadl:doc>
</representation>-->
</response>
</method>
<method name="GET" id="versionDetails">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show API version details">
<para role="shortdesc">Shows details for Block Storage API
v2.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/versionv2-get-resp.json"
/>
</wadl:doc>
</representation>
<!-- this call fails - opened bug 1311243 -->
<!--<representation mediaType="application/xml"
element="common:version">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/version-get-resp.xml"/>
</wadl:doc>
<param name="location" style="plain" type="xsd:anyURI"
required="true"
path="/common:version/atom:link[@rel='self']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Location"><para>Full URL
to a service or server.</para></wadl:doc>
<link resource_type="#VersionDetails" rel="self"/>
</param>
</representation>-->
</response>
</method>
<method name="POST" id="createVolume">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create volume">