openstack/api-site
Code Issues Proposed changes

Clean up WADL and XML files in prep for generating PDFs on api-site

Browse Source 
Cleaned up servers and extension WADL files to resolve some errors
Ensured all PDFs build successfully.

The api-ref-guides only publish PDF files.

Partial-Bug: #1243631

Change-Id: Iab24d2a1845475449977786b84b974c085bae6da
author: diane fleming
This commit is contained in:
Diane Fleming 2014-03-24 15:14:31 -05:00 committed by Andreas Jaeger
parent 0db0a563e3
commit e6983aa1fd
66 changed files with 1712 additions and 1208 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-guide/pom.xml
View File

@ -26,7 +26,7 @@
<artifactId>clouddocs-maven-plugin</artifactId> <artifactId>clouddocs-maven-plugin</artifactId>
<!-- version is set in ../pom.xml file --> <!-- version is set in ../pom.xml file -->
<executions> <executions>
<!-- Configuration for OpenStack End User Guide --> <!-- Configuration for OpenStack API Guide -->
<execution> <execution>
<id>os-api-guide</id> <id>os-api-guide</id>
<goals> <goals>

180
api-ref-guides/pom.xml Normal file
View File

@ -0,0 +1,180 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<parent>
<groupId>org.openstack.docs</groupId>
<artifactId>parent-pom</artifactId>
<version>1.0.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>openstack-api-ref-guides</artifactId>
<packaging>jar</packaging>
<name>OpenStack API Complete Reference Guides</name>
<properties>
<!-- This is set by Jenkins according to the branch. -->
<release.path.name>local</release.path.name>
<comments.enabled>0</comments.enabled>
</properties>
<!-- ################################################ -->
<!-- USE "mvn clean generate-sources" to run this POM -->
<!-- ################################################ -->
<build>
<plugins>
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<!-- version is set in ../pom.xml file -->
<executions>
<!-- Configuration for OpenStack API Guide -->
<execution>
<id>os-api-ref-blockstorage</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-blockstorage.xml </includes>
<pdfFilenameBase>api-ref-blockstorage</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-compute-v2</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-compute-v2.xml </includes>
<pdfFilenameBase>api-ref-compute-v2</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-compute-v2-ext</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-compute-v2-ext.xml </includes>
<pdfFilenameBase>api-ref-compute-v2-ext</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-compute-v3</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-compute-v3.xml </includes>
<pdfFilenameBase>api-ref-compute-v3</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-identity</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-identity.xml </includes>
<pdfFilenameBase>api-ref-identity</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-image</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-image.xml </includes>
<pdfFilenameBase>api-ref-image</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-networking</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-networking.xml </includes>
<pdfFilenameBase>api-ref-networking</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-objectstorage</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-objectstorage.xml </includes>
<pdfFilenameBase>api-ref-objectstorage</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-orchestration</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-orchestration.xml </includes>
<pdfFilenameBase>api-ref-orchestration</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-telemetry</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-telemetry.xml </includes>
<pdfFilenameBase>api-ref-telemetry</pdfFilenameBase>
</configuration>
</execution>
<!-- <execution>
<id>os-api-ref</id>
<goals>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref.xml </includes>
<pdfFilenameBase>api-ref</pdfFilenameBase>
<webhelpDirname>api-ref</webhelpDirname>
<pdfFilenameBase>api-ref</pdfFilenameBase>
</configuration>
</execution>-->
</executions>
<configuration>
<webhelpDirname>api-ref-guides</webhelpDirname>
<generateToc> appendix toc,title
article/appendix nop
article toc,title
book toc,title
<!--chapter toc,title
section toc,title-->
part toc,title
qandadiv toc
qandaset to
reference toc,title
set toc,title</generateToc>
<xincludeSupported>true</xincludeSupported>
<sourceDirectory>src</sourceDirectory>
<branding>openstack</branding>
<trimWadlUriCount>1</trimWadlUriCount>
<showXslMessages>true</showXslMessages>
<!-- <targetDirectory>target/docbkx/webhelp</targetDirectory> -->
<highlightSource>false</highlightSource>
<security>external</security>
<suppressFooterNavigation>0</suppressFooterNavigation>
</configuration>
</plugin>
</plugins>
</build>
</project>

6
api-ref/src/docbkx/bk-api-ref-blockstorage.xml → api-ref-guides/src/bk-api-ref-blockstorage.xml
View File

@ -33,7 +33,7 @@
</affiliation> </affiliation>
</author> </author>
<copyright> <copyright>
<year>2010-2013</year> <year>2010-2014</year>
<holder>OpenStack Foundation</holder> <holder>OpenStack Foundation</holder>
</copyright> </copyright>
<productname>OpenStack Block Storage</productname> <productname>OpenStack Block Storage</productname>
@ -45,6 +45,6 @@
</annotation> </annotation>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/> <!-- <xi:include href="preface.xml"/>-->
<xi:include href="ch_blockstorage-api.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_blockstorage-api.xml"/>
</book> </book>

4
api-ref/src/docbkx/bk-api-ref-compute-v2-ext.xml → api-ref-guides/src/bk-api-ref-compute-v2-ext.xml
View File

@ -32,7 +32,7 @@
</annotation> </annotation>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/> <!-- <xi:include href="preface.xml"/>-->
<xi:include href="ch_compute-v2-ext.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_compute-v2-ext.xml"/>
</book> </book>

4
api-ref/src/docbkx/bk-api-ref-compute-v2.xml → api-ref-guides/src/bk-api-ref-compute-v2.xml
View File

@ -45,6 +45,6 @@
</annotation> </annotation>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/> <!-- <xi:include href="preface.xml"/>-->
<xi:include href="ch_compute-v2.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_compute-v2.xml"/>
</book> </book>

8
api-ref/src/docbkx/bk-api-ref-compute-v3.xml → api-ref-guides/src/bk-api-ref-compute-v3.xml
View File

@ -8,8 +8,8 @@
version="5.0-extension RackBook-2.0" status="EXPERIMENTAL" version="5.0-extension RackBook-2.0" status="EXPERIMENTAL"
xml:id="api.openstack.org-compute-v3-pdf"> xml:id="api.openstack.org-compute-v3-pdf">
<info> <info>
<title>OpenStack Compute API v2 Reference</title> <title>OpenStack Compute API v3 Reference (EXPERIMENTAL)</title>
<titleabbrev>API Reference</titleabbrev> <titleabbrev>API Reference (EXPERIMENTAL)</titleabbrev>
<author> <author>
<personname> <personname>
<firstname/> <firstname/>
@ -32,6 +32,6 @@
</annotation> </annotation>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/> <!-- <xi:include href="preface.xml"/>-->
<xi:include href="ch_compute-v3.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_compute-v3.xml"/>
</book> </book>

14
api-ref/src/docbkx/bk-api-ref-identity.xml → api-ref-guides/src/bk-api-ref-identity.xml
View File

@ -32,7 +32,7 @@
</affiliation> </affiliation>
</author> </author>
<copyright> <copyright>
<year>2010-2013</year> <year>2010-2014</year>
<holder>OpenStack Foundation</holder> <holder>OpenStack Foundation</holder>
</copyright> </copyright>
<productname>OpenStack Identity</productname> <productname>OpenStack Identity</productname>
@ -44,10 +44,10 @@
</annotation> </annotation>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/> <!-- <xi:include href="preface.xml"/>-->
<xi:include href="ch_identity-v3.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_identity-v3.xml"/>
<xi:include href="ch_identity-v3-ext.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_identity-v3-ext.xml"/>
<xi:include href="ch_identity-v2.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_identity-v2.xml"/>
<xi:include href="ch_identity-admin-v2.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_identity-admin-v2.xml"/>
<xi:include href="ch_identity-v2-ext.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_identity-v2-ext.xml"/>
</book> </book>

8
api-ref/src/docbkx/bk-api-ref-image.xml → api-ref-guides/src/bk-api-ref-image.xml
View File

@ -20,7 +20,7 @@
</affiliation> </affiliation>
</author> </author>
<copyright> <copyright>
<year>2010-2013</year> <year>2010-2014</year>
<holder>OpenStack Foundation</holder> <holder>OpenStack Foundation</holder>
</copyright> </copyright>
<productname>OpenStack Image Service</productname> <productname>OpenStack Image Service</productname>
@ -32,7 +32,7 @@
</annotation> </annotation>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/> <!-- <xi:include href="preface.xml"/>-->
<xi:include href="ch_images-v2.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_images-v2.xml"/>
<xi:include href="ch_images-v1.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_images-v1.xml"/>
</book> </book>

8
api-ref/src/docbkx/bk-api-ref-networking.xml → api-ref-guides/src/bk-api-ref-networking.xml
View File

@ -23,7 +23,7 @@
</affiliation> </affiliation>
</author> </author>
<copyright> <copyright>
<year>2010-2013</year> <year>2010-2014</year>
<holder>OpenStack Foundation</holder> <holder>OpenStack Foundation</holder>
</copyright> </copyright>
<productname>OpenStack Networking</productname> <productname>OpenStack Networking</productname>
@ -35,7 +35,7 @@
</annotation> </annotation>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/> <!-- <xi:include href="preface.xml"/>-->
<xi:include href="ch_netconn-v2.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_netconn-v2.xml"/>
<xi:include href="ch_netconn-ext-v2.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_netconn-ext-v2.xml"/>
</book> </book>

6
api-ref/src/docbkx/bk-api-ref-objectstorage.xml → api-ref-guides/src/bk-api-ref-objectstorage.xml
View File

@ -20,7 +20,7 @@
</affiliation> </affiliation>
</author> </author>
<copyright> <copyright>
<year>2010-2013</year> <year>2010-2014</year>
<holder>OpenStack Foundation</holder> <holder>OpenStack Foundation</holder>
</copyright> </copyright>
<productname>OpenStack Object Storage</productname> <productname>OpenStack Object Storage</productname>
@ -32,6 +32,6 @@
</annotation> </annotation>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/> <!-- <xi:include href="preface.xml"/>-->
<xi:include href="ch_objectstorage-v1.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_objectstorage-v1.xml"/>
</book> </book>

6
api-ref/src/docbkx/bk-api-ref-orchestration.xml → api-ref-guides/src/bk-api-ref-orchestration.xml
View File

@ -20,7 +20,7 @@
</affiliation> </affiliation>
</author> </author>
<copyright> <copyright>
<year>2010-2013</year> <year>2010-2014</year>
<holder>OpenStack Foundation</holder> <holder>OpenStack Foundation</holder>
</copyright> </copyright>
<productname>OpenStack Orchestration</productname> <productname>OpenStack Orchestration</productname>
@ -32,6 +32,6 @@
</annotation> </annotation>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/> <!-- <xi:include href="preface.xml"/>-->
<xi:include href="ch_orchestration-v1.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_orchestration-v1.xml"/>
</book> </book>

6
api-ref/src/docbkx/bk-api-ref-telemetry.xml → api-ref-guides/src/bk-api-ref-telemetry.xml
View File

@ -20,7 +20,7 @@
</affiliation> </affiliation>
</author> </author>
<copyright> <copyright>
<year>2010-2013</year> <year>2010-2014</year>
<holder>OpenStack Foundation</holder> <holder>OpenStack Foundation</holder>
</copyright> </copyright>
<productname>OpenStack Metering</productname> <productname>OpenStack Metering</productname>
@ -32,6 +32,6 @@
</annotation> </annotation>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/> <!-- <xi:include href="preface.xml"/>-->
<xi:include href="ch_telemetry-v2.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_telemetry-v2.xml"/>
</book> </book>

52
api-ref-guides/src/bk-api-ref.xml Normal file
View File

@ -0,0 +1,52 @@
<?xml version="1.0" encoding="UTF-8"?>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-pdf">
<info>
<title>OpenStack API Complete Reference</title>
<titleabbrev>API Complete Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>OpenStack Foundation</orgname>
</affiliation>
</author>
<copyright>
<year>2010-2014</year>
<holder>OpenStack Foundation</holder>
</copyright>
<productname>OpenStack</productname>
<pubdate/>
<legalnotice role="cc-by">
<annotation>
<remark>Copyright details are filled in by the
template.</remark>
</annotation>
</legalnotice>
</info>
<!-- <xi:include href="preface.xml"/>-->
<xi:include href="../../api-ref/src/docbkx/ch_blockstorage-api.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_compute-v2.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_compute-v2-ext.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_compute-v3.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_identity-v3.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_identity-v3-ext.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_identity-v2.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_identity-admin-v2.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_identity-v2-ext.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_images-v2.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_images-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_netconn-v2.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_netconn-ext-v2.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_objectstorage-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_orchestration-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_telemetry-v2.xml"/>
</book>

29
api-ref-guides/src/preface.xml Normal file
View File

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE preface[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY nbsp "&#160;">
]>
<preface xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="Overview">
<title>Preface</title>
<para>Use the OpenStack APIs and extensions in your OpenStack
cloud.</para>
<xi:include
href="../../api-ref/src/docbkx/itemizedlist-service-list.xml"/>
<para>You must install the packages for each API separately. After
you authenticate through the <link
xlink:href="api-ref-identity.html">Identity API</link>,
you can use the other APIs and extensions to launch server
instances, create images, assign metadata to instances and
images, create containers and objects, and complete other
actions in your OpenStack cloud. To get started with the APIs,
see the <link
xlink:href="http://docs.openstack.org/api/quick-start/content/"
>OpenStack API Quick Start</link>.</para>
<para>&nbsp;</para>
</preface>

122
api-ref/pom.xml
View File

@ -46,127 +46,7 @@
</configuration> </configuration>
</execution> </execution>
<!-- Configuration for OpenStack API References (pdf) --> <!-- Configuration for OpenStack API References (pdf) -->
<!--<execution> <!-- see ../api-ref-guides/pom.xml -->
<id>os-api-ref</id>
<goals>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref.xml </includes>
<pdfFilenameBase>api-ref</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-blockstorage</id>
<goals>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-blockstorage.xml </includes>
<pdfFilenameBase>api-ref-blockstorage</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-compute-v2</id>
<goals>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-compute0v2.xml </includes>
<pdfFilenameBase>api-ref-compute-v2</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-compute-v2-ext</id>
<goals>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-compute-v2-ext.xml </includes>
<pdfFilenameBase>api-ref-compute-v2-ext</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-compute-v3</id>
<goals>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-compute-v3.xml </includes>
<pdfFilenameBase>api-ref-compute-v3</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-identity</id>
<goals>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-identity.xml </includes>
<pdfFilenameBase>api-ref-identity</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-image</id>
<goals>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-image.xml </includes>
<pdfFilenameBase>api-ref-image</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-objectstorage</id>
<goals>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-objectstorage.xml </includes>
<pdfFilenameBase>api-ref-objectstorage</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-networking</id>
<goals>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-networking.xml </includes>
<pdfFilenameBase>api-ref-networking</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-orchestration</id>
<goals>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-orchestration.xml </includes>
<pdfFilenameBase>api-ref-orchestration</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-telemetry</id>
<goals>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-telemetry.xml </includes>
<pdfFilenameBase>api-ref-telemetry</pdfFilenameBase>
</configuration>
</execution>-->
</executions> </executions>
<configuration> <configuration>
<!-- These parameters apply to pdf and webhelp --> <!-- These parameters apply to pdf and webhelp -->

2
api-ref/src/docbkx/api-ref-compute-v2-ext.xml
View File

@ -16,6 +16,6 @@
<para/> <para/>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/> <!-- <xi:include href="preface.xml"/>-->
<xi:include href="ch_compute-v2-ext.xml"/> <xi:include href="ch_compute-v2-ext.xml"/>
</book> </book>

52
api-ref/src/docbkx/bk-api-ref.xml
View File

@ -1,52 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-pdf">
<info>
<title>OpenStack API Reference</title>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>OpenStack Foundation</orgname>
</affiliation>
</author>
<copyright>
<year>2010-2013</year>
<holder>OpenStack Foundation</holder>
</copyright>
<productname>OpenStack</productname>
<pubdate/>
<legalnotice role="cc-by">
<annotation>
<remark>Copyright details are filled in by the
template.</remark>
</annotation>
</legalnotice>
</info>
<xi:include href="preface.xml"/>
<xi:include href="ch_blockstorage-api.xml"/>
<xi:include href="ch_compute-v2.xml"/>
<xi:include href="ch_compute-v2-ext.xml"/>
<xi:include href="ch_compute-v3.xml"/>
<xi:include href="ch_identity-v3.xml"/>
<xi:include href="ch_identity-v3-ext.xml"/>
<xi:include href="ch_identity-v2.xml"/>
<xi:include href="ch_identity-admin-v2.xml"/>
<xi:include href="ch_identity-v2-ext.xml"/>
<xi:include href="ch_images-v2.xml"/>
<xi:include href="ch_images-v1.xml"/>
<xi:include href="ch_netconn-v2.xml"/>
<xi:include href="ch_netconn-ext-v2.xml"/>
<xi:include href="ch_objectstorage-v1.xml"/>
<xi:include href="ch_orchestration-v1.xml"/>
<xi:include href="ch_telemetry-v2.xml"/>
</book>

18
api-ref/src/docbkx/ch_blockstorage-api.xml
View File

@ -5,7 +5,7 @@
xmlns:linkend="http://www.w3.org/1999/linkend" xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref" xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="blockstorage-v2"> version="5.0-extension RackBook-2.0" xml:id="blockstorage-v2" role="api-reference">
<title>Block Storage API v2.0</title> <title>Block Storage API v2.0</title>
<para>Manage volumes and snapshots for use with the Block Storage <para>Manage volumes and snapshots for use with the Block Storage
API, also known as cinder services.</para> API, also known as cinder services.</para>
@ -13,16 +13,16 @@
<title>Volumes</title> <title>Volumes</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v2/volume-api.wadl#volumes"> href="../wadls/volume-api/src/v2/volume-api-v2.wadl#volumes">
<wadl:method href="#createVolume"/> <wadl:method href="#createVolume"/>
<wadl:method href="#getVolumesSimple"/> <wadl:method href="#getVolumesSimple"/>
</wadl:resource> </wadl:resource>
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v2/volume-api.wadl#detail"> href="../wadls/volume-api/src/v2/volume-api-v2.wadl#detail">
<wadl:method href="#getVolumesDetail"/> <wadl:method href="#getVolumesDetail"/>
</wadl:resource> </wadl:resource>
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v2/volume-api.wadl#volume_id"> href="../wadls/volume-api/src/v2/volume-api-v2.wadl#volume_id">
<wadl:method href="#getVolume"/> <wadl:method href="#getVolume"/>
<wadl:method href="#updateVolume"/> <wadl:method href="#updateVolume"/>
<wadl:method href="#deleteVolume"/> <wadl:method href="#deleteVolume"/>
@ -33,11 +33,11 @@
<title>Volume types</title> <title>Volume types</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v2/volume-api.wadl#types"> href="../wadls/volume-api/src/v2/volume-api-v2.wadl#types">
<wadl:method href="#getVolumeTypes"/> <wadl:method href="#getVolumeTypes"/>
</wadl:resource> </wadl:resource>
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v2/volume-api.wadl#volume_type_id"> href="../wadls/volume-api/src/v2/volume-api-v2.wadl#volume_type_id">
<wadl:method href="#getVolumeType"/> <wadl:method href="#getVolumeType"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
@ -46,16 +46,16 @@
<title>Snapshots</title> <title>Snapshots</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v2/volume-api.wadl#snapshots"> href="../wadls/volume-api/src/v2/volume-api-v2.wadl#snapshots">
<wadl:method href="#createSnapshot"/> <wadl:method href="#createSnapshot"/>
<wadl:method href="#getSnapshotsSimple"/> <wadl:method href="#getSnapshotsSimple"/>
</wadl:resource> </wadl:resource>
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v2/volume-api.wadl#detail-snapshot"> href="../wadls/volume-api/src/v2/volume-api-v2.wadl#detail-snapshot">
<wadl:method href="#getSnapshotsDetail"/> <wadl:method href="#getSnapshotsDetail"/>
</wadl:resource> </wadl:resource>
<wadl:resource <wadl:resource
href="../wadls/volume-api/src/v2/volume-api.wadl#snapshot_id"> href="../wadls/volume-api/src/v2/volume-api-v2.wadl#snapshot_id">
<wadl:method href="#getSnapshot"/> <wadl:method href="#getSnapshot"/>
<wadl:method href="#updateSnapshot"/> <wadl:method href="#updateSnapshot"/>
<wadl:method href="#deleteSnapshot"/> <wadl:method href="#deleteSnapshot"/>

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

@ -8,7 +8,7 @@
xmlns:linkend="http://www.w3.org/1999/linkend" xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref" xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="compute-ext-v2"> version="5.0-extension RackBook-2.0" xml:id="compute-ext-v2" role="api-reference">
<title>Compute API v2 extensions</title> <title>Compute API v2 extensions</title>
<para>Extensions add features, MIME types, actions, states, <para>Extensions add features, MIME types, actions, states,
headers, parameters, and resources to the core Compute API. headers, parameters, and resources to the core Compute API.
@ -239,9 +239,28 @@
<para>Display extra statistical information from the machine <para>Display extra statistical information from the machine
that hosts the hypervisor through the API for the that hosts the hypervisor through the API for the
hypervisor (XenAPI or KVM/libvirt).</para> hypervisor (XenAPI or KVM/libvirt).</para>
<wadl:resources <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
href="../wadls/compute-api/src/v2/ext/os-hypervisors.wadl" <wadl:resource
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> href="../wadls/compute-api/src/v2/ext/os-hypervisors.wadl#os-hypervisors">
<wadl:method href="#listHypervisors"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/src/v2/ext/os-hypervisors.wadl#detail">
<wadl:method href="#showHypervisor"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/src/v2/ext/os-hypervisors.wadl#statistics">
<wadl:method href="#getHypervisorStats"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/src/v2/ext/os-hypervisors.wadl#hypervisor_hostname">
<wadl:method href="#getHypervisorUptime"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/src/v2/ext/os-hypervisors.wadl#servers">
<wadl:method href="#listHypervisorInstances"/>
</wadl:resource>
</wadl:resources>
</section> </section>
<section xml:id="ext-os-instance-actions"> <section xml:id="ext-os-instance-actions">
<title>Server actions (os-instance-actions)</title> <title>Server actions (os-instance-actions)</title>
@ -415,7 +434,8 @@
images)</title> images)</title>
<para>Extend servers with the diskConfig attribute.</para> <para>Extend servers with the diskConfig attribute.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02" <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/compute-api/src/v2/ext/os-disk-config.wadl"/> href="../wadls/compute-api/src/v2/ext/os-disk-config.wadl"
/>
</section> </section>
<section xml:id="ext-os-ext-ips"> <section xml:id="ext-os-ext-ips">
<title>Server IP type (servers)</title> <title>Server IP type (servers)</title>

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

@ -5,7 +5,7 @@
xmlns:linkend="http://www.w3.org/1999/linkend" xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref" xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="compute-core-v2"> version="5.0-extension RackBook-2.0" xml:id="compute-core-v2" role="api-reference">
<title>Compute API v2</title> <title>Compute API v2</title>
<para>Launch virtual machines from images or images stored on <para>Launch virtual machines from images or images stored on
persistent volumes. API v1.1 is identical to API v2.</para> persistent volumes. API v1.1 is identical to API v2.</para>
@ -65,27 +65,26 @@
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#server_id"> href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#server_id">
<wadl:method href="#getServer"/> <wadl:method href="#getServer"/>
<wadl:method href="#updateServer"/> <wadl:method href="#updateServer"/>
<wadl:method href="#deleteerver"/> <wadl:method href="#deleteServer"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="compute_server_metadata"> <section xml:id="compute_server_metadata">
<title>Server metadata</title> <title>Server metadata</title>
<para>Set, list, get details for, and delete server <para>Show details for, set, update, and delete server
metadata or metadata items.</para> metadata or metadata items.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource <wadl:resource
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#metadata"> href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#server_metadata">
<!-- Metadata --> <wadl:method href="#showServerMetadata"/>
<wadl:method href="#listMetadata"/> <wadl:method href="#createServerMetadata"/>
<wadl:method href="#updateMetadata"/> <wadl:method href="#updateServerMetadata"/>
<wadl:method href="#setMetadata"/>
</wadl:resource> </wadl:resource>
<wadl:resource <wadl:resource
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#MetadataKey"> href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#ServerMetadataKey">
<wadl:method href="#getMetadataItem"/> <wadl:method href="#getServerMetadataItem"/>
<wadl:method href="#setMetadataItem"/> <wadl:method href="#setServerMetadataItem"/>
<wadl:method href="#deleteMetadataItem"/> <wadl:method href="#deleteServerMetadataItem"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>
@ -103,9 +102,9 @@
</section> </section>
<section xml:id="compute_server-actions"> <section xml:id="compute_server-actions">
<title>Server actions</title> <title>Server actions</title>
<para>Perform actions for a specified server, including <para>Perform actions for a specified server, including change
change administrator password, reboot, rebuild, resize, administrator password, reboot, rebuild, resize, and
and create image from server.</para> create image from server.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource <wadl:resource
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#action"> href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#action">
@ -169,21 +168,20 @@
</section> </section>
<section xml:id="compute_image_metadata"> <section xml:id="compute_image_metadata">
<title>Image metadata</title> <title>Image metadata</title>
<para>Set, list, get details for, and delete image <para>Show details for, set, update, and delete image metadata
metadata or metadata items.</para> or metadata items.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource <wadl:resource
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#image_metadata"> href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#image_metadata">
<!-- Metadata --> <wadl:method href="#showImageMetadata"/>
<wadl:method href="#listMetadata"/> <wadl:method href="#createImageMetadata"/>
<wadl:method href="#updateMetadata"/> <wadl:method href="#updateImageMetadata"/>
<wadl:method href="#setMetadata"/>
</wadl:resource> </wadl:resource>
<wadl:resource <wadl:resource
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#imageMetadataKey"> href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#imageMetadataKey">
<wadl:method href="#getMetadataItem"/> <wadl:method href="#getImageMetadataItem"/>
<wadl:method href="#setMetadataItem"/> <wadl:method href="#setImageMetadataItem"/>
<wadl:method href="#deleteMetadataItem"/> <wadl:method href="#deleteImageMetadataItem"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>

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

@ -18,16 +18,37 @@
xmlns:linkend="http://www.w3.org/1999/linkend" xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref" xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="compute-ext-v3"> version="5.0-extension RackBook-2.0" xml:id="compute-ext-v3" role="api-reference">
<title>Compute API v3 (EXPERIMENTAL)</title> <title>Compute API v3 (EXPERIMENTAL)</title>
<para>Query the Compute API to list available extensions with a <para>Query the Compute API to list available extensions with a
&GET; request to <code>v3/extensions</code>.</para> &GET; request to <code>v3/extensions</code>.</para>
<section xml:id="v3server"> <section xml:id="v3server">
<title>Server admin actions</title> <title>Server admin actions (servers)</title>
<para>Permits administrators to perform actions on a server. <para>Administrators only. Perform actions on a server. Specify
Specify the action in the request body.</para> the action in the request body.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-admin-actions.wadl" href="../wadls/compute-api/src/v3/wadl/os-admin-actions-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v3agents">
<title>Guest agents (os-agents)</title>
<para>Creates, updates, and deletes guest agents. Use guest agents
to access files on the disk, configure networking, or run other
applications or scripts in the guest while it runs. This
hypervisor-specific extension is not currently enabled for KVM.
Use of guest agents is possible only if the underlying service
provider uses the Xen driver.</para>
<wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-agents-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v3aggregate">
<title>Host aggregates (os-aggregates)</title>
<para>Creates and manages host aggregates. An aggregate assigns
metadata to groups of compute nodes. Aggregates are only visible
to the cloud provider.</para>
<wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-aggregates-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3cell"> <section xml:id="v3cell">
@ -36,29 +57,36 @@
cells, listing neighbor cells, and getting the capabilities of cells, listing neighbor cells, and getting the capabilities of
the local cell.</para> the local cell.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-cell.wadl" href="../wadls/compute-api/src/v3/wadl/os-cells-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v3certificate">
<title>Root certificates (os-certificates)</title>
<para>Creates and shows details for a root certificate.</para>
<wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-certificates-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3configdrive"> <section xml:id="v3configdrive">
<title>Configuration Drive (os-config-drive)</title> <title>Configuration drive (os-config-drive)</title>
<para>Returns server details for a specific service ID or <para>Returns server details for a specific service ID or
user.</para> user.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-config-drive.wadl" href="../wadls/compute-api/src/v3/wadl/os-config-drive-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3deferredelete"> <section xml:id="v3deferredelete">
<title>Server deferred delete (os-deferred-delete)</title> <title>Server deferred delete (os-deferred-delete)</title>
<para>Force-deletes a server or restores a deleted server.</para> <para>Force-deletes a server or restores a deleted server.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-deferred-delete.wadl" href="../wadls/compute-api/src/v3/wadl/os-deferred-delete-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3evaculation"> <section xml:id="v3evaculation">
<title>Evacuate (os-evacuate)</title> <title>Evacuate (os-evacuate)</title>
<para>Enables server evacuation.</para> <para>Enables server evacuation.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-evacuate.wadl" href="../wadls/compute-api/src/v3/wadl/os-evacuate-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3availzone"> <section xml:id="v3availzone">
@ -68,7 +96,7 @@
(nova-compute). Internal services appear in their own internal (nova-compute). Internal services appear in their own internal
availability zone.</para> availability zone.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-extended-availability-zone.wadl" href="../wadls/compute-api/src/v3/wadl/os-extended-availability-zone-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3extendattributes"> <section xml:id="v3extendattributes">
@ -76,7 +104,7 @@
(os-extended-server-attributes)</title> (os-extended-server-attributes)</title>
<para>Shows metadata for servers.</para> <para>Shows metadata for servers.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-extended-server-attributes.wadl" href="../wadls/compute-api/src/v3/wadl/os-extended-server-attributes-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3extendedstatus"> <section xml:id="v3extendedstatus">
@ -84,21 +112,14 @@
<para>Shows extended status information, vm_state, task_state, and <para>Shows extended status information, vm_state, task_state, and
power_state, in detailed server responses.</para> power_state, in detailed server responses.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-extended-status.wadl" href="../wadls/compute-api/src/v3/wadl/os-extended-status-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v3multinic">
<title>Multinic (os-multinic)</title>
<para>Multiple network support.</para>
<wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-multinic.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3flavoraccess"> <section xml:id="v3flavoraccess">
<title>Flavor access (os-flavor-access)</title> <title>Flavor access (os-flavor-access)</title>
<para>Flavor access support.</para> <para>Flavor access support.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-flavor-access.wadl" href="../wadls/compute-api/src/v3/wadl/os-flavor-access-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3flavorspecs"> <section xml:id="v3flavorspecs">
@ -106,7 +127,14 @@
<para>Lists, creates, deletes, and updates the extra-specs or keys <para>Lists, creates, deletes, and updates the extra-specs or keys
for a flavor.</para> for a flavor.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/flavorspecs.wadl" href="../wadls/compute-api/src/v3/wadl/os-flavorspecs-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v3flavormanage">
<title>Flavors manage (flavor-manage)</title>
<para>Support for creating and deleting flavor.</para>
<wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-flavor-manage-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3flavortxtx"> <section xml:id="v3flavortxtx">
@ -114,63 +142,21 @@
(os-flavor-rxtx)</title> (os-flavor-rxtx)</title>
<para>Support to show the rxtx status of a flavor.</para> <para>Support to show the rxtx status of a flavor.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-flavor-rxtx.wadl" href="../wadls/compute-api/src/v3/wadl/os-flavor-rxtx-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3flavorextend"> <section xml:id="v3flavorextend">
<title>Flavors with extended attributes (flavors)</title> <title>Flavors with extended attributes (flavors)</title>
<para>Returns information about Flavors.</para> <para>Returns information about Flavors.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/flavors.wadl" href="../wadls/compute-api/src/v3/wadl/os-flavors-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v3flavormanage">
<title>Flavors manage (flavor-manage)</title>
<para>Support for creating and deleting flavor.</para>
<wadl:resources
href="../wadls/compute-api/src/v3/wadl/flavor-manage.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v3limits">
<title>Limits (limits)</title>
<para>Provide all global and rate limit information.</para>
<wadl:resources
href="../wadls/compute-api/src/v3/wadl/limits.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v3agents">
<title>Guest Agents (os-agents)</title>
<para>Creates, updates, and deletes guest agents. Use guest agents
to access files on the disk, configure networking, or run other
applications or scripts in the guest while it runs. This
hypervisor-specific extension is not currently enabled for KVM.
Use of guest agents is possible only if the underlying service
provider uses the Xen driver.</para>
<wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-agents.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v3aggregate">
<title>Host aggregates (os-aggregates)</title>
<para>Creates and manages host aggregates. An aggregate assigns
metadata to groups of compute nodes. Aggregates are only visible
to the cloud provider.</para>
<wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-aggregates.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v3certificate">
<title>Root certificates (os-certificates)</title>
<para>Creates and shows details for a root certificate.</para>
<wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-certificate.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3hosts"> <section xml:id="v3hosts">
<title>Hosts (os-hosts)</title> <title>Hosts (os-hosts)</title>
<para>Manages physical hosts.</para> <para>Manages physical hosts.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-hosts.wadl" href="../wadls/compute-api/src/v3/wadl/os-hosts-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3hypervisors"> <section xml:id="v3hypervisors">
@ -179,23 +165,52 @@
hosts the hypervisor through the API for the hypervisor (XenAPI hosts the hypervisor through the API for the hypervisor (XenAPI
or KVM/libvirt).</para> or KVM/libvirt).</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-hypervisors.wadl" href="../wadls/compute-api/src/v3/wadl/os-hypervisors-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3instance"> <section xml:id="v3instance">
<title>Server actions (os-instance-actions)</title> <title>Server actions (servers)</title>
<para>Permits all users to list available actions for a specified <para>Permits all users to list available actions for a specified
server. Permits administrators to get details for a specified server. Permits administrators to get details for a specified
action for a specified server.</para> action for a specified server.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-instance-actions.wadl" href="../wadls/compute-api/src/v3/wadl/os-instance-actions-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-instance-usage-audit-log-v3">
<title>Instance usage audit log
(os-instance-usage-audit-log)</title>
<para>Admin-only task log monitoring.</para>
<wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-instance-usage-audit-log-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v3limits">
<title>Limits (limits)</title>
<para>Provide all global and rate limit information.</para>
<wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-limits-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3migrations"> <section xml:id="v3migrations">
<title>Migrations (os-migrations)</title> <title>Migrations (os-migrations)</title>
<para>Provide data on migrations.</para> <para>Provide data on migrations.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-migrations.wadl" href="../wadls/compute-api/src/v3/wadl/os-migrations-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v3multinic">
<title>Multinic (os-multinic)</title>
<para>Multiple network support.</para>
<wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-multinic-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v3quotaclasses">
<title>Quota class (os-quota-class-sets)</title>
<para>Quota classes management support.</para>
<wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-quota-class-sets-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3quotasets"> <section xml:id="v3quotasets">
@ -204,43 +219,28 @@
view quotas for a tenant and view and update default view quotas for a tenant and view and update default
quotas.</para> quotas.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-quota-sets.wadl" href="../wadls/compute-api/src/v3/wadl/os-quota-sets-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="v3quotaclasses">
<title>Quota class (os-quota-class-sets)</title>
<para>Quota classes management support.</para>
<wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-quota-class-sets.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3remoteconsole"> <section xml:id="v3remoteconsole">
<title>Server remote console (os-remote-consoles)</title> <title>Server remote console (os-remote-consoles)</title>
<para>Interactive Console support.</para> <para>Interactive console support.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-remote-consoles.wadl" href="../wadls/compute-api/src/v3/wadl/os-remote-consoles-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="os-instance-usage-audit-log-v3"> <section xml:id="os-server-usage-v3">
<title>Instance Usage Audit Log <title>Server usage (os-server-usage)</title>
(os-instance-usage-audit-log)</title> <para>Adds launched_at and terminated_at to servers.</para>
<para>Admin-only Task Log Monitoring.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-instance-usage-audit-log.wadl" href="../wadls/compute-api/src/v3/wadl/os-server-usage-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
<section xml:id="v3simpletenant"> <section xml:id="v3simpletenant">
<title>Usage reports (os-simple-tenant-usage)</title> <title>Usage reports (os-simple-tenant-usage)</title>
<para>Provide simple tenant usage for tenant.</para> <para>Provide simple tenant usage for tenant.</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-simple-tenant-usage.wadl" href="../wadls/compute-api/src/v3/wadl/os-simple-tenant-usage-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-server-usage-v3">
<title>Server usage (os-server-usage)</title>
<para>Adds launched_at and terminated_at on Servers.</para>
<wadl:resources
href="../wadls/compute-api/src/v3/wadl/os-server-usage.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
</chapter> </chapter>

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

@ -6,7 +6,7 @@
xmlns:xref="http://www.w3.org/1999/xref" xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="identity-admin-v2" version="5.0-extension RackBook-2.0" xml:id="identity-admin-v2"
xlink:href="#identity-admin-v2"> xlink:href="#identity-admin-v2" role="api-reference">
<title>Identity admin API v2.0</title> <title>Identity admin API v2.0</title>
<para>Get an authentication token that permits access to the <para>Get an authentication token that permits access to the
Compute API.</para> Compute API.</para>

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

@ -9,7 +9,7 @@
xmlns:xref="http://www.w3.org/1999/xref" xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="identity-v2-ext" version="5.0-extension RackBook-2.0" xml:id="identity-v2-ext"
xlink:href="#identity-v2-ext"> xlink:href="#identity-v2-ext" role="api-reference">
<title>Identity API v2.0 extensions</title> <title>Identity API v2.0 extensions</title>
<para>Query the Identity API to list available extensions <para>Query the Identity API to list available extensions
with a &GET; request to <code>v2.0/extensions</code>.</para> with a &GET; request to <code>v2.0/extensions</code>.</para>

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

@ -9,7 +9,7 @@
xmlns:xref="http://www.w3.org/1999/xref" xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="identity-v3-ext" version="5.0-extension RackBook-2.0" xml:id="identity-v3-ext"
xlink:href="#identity-v3-ext"> xlink:href="#identity-v3-ext" role="api-reference">
<title>Identity API v3 extensions</title> <title>Identity API v3 extensions</title>
<para>Query the Identity API to list available extensions <para>Query the Identity API to list available extensions
with a &GET; request to <code>v3/extensions</code>.</para> with a &GET; request to <code>v3/extensions</code>.</para>
@ -62,5 +62,8 @@
Identity API token.</para> Identity API token.</para>
</listitem> </listitem>
</orderedlist> </orderedlist>
<wadl:resources
href="../wadls/identity-api/src/v3/wadl/OS-OAUTH1-v3.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section> </section>
</chapter> </chapter>

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

@ -6,7 +6,7 @@
xmlns:xref="http://www.w3.org/1999/xref" xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="identity-v3" version="5.0-extension RackBook-2.0" xml:id="identity-v3"
xlink:href="#identity-v3"> xlink:href="#identity-v3" role="api-reference">
<title>Identity API v3</title> <title>Identity API v3</title>
<para>Get an authentication token that permits access to the <para>Get an authentication token that permits access to the
Compute API.</para> Compute API.</para>
@ -15,7 +15,7 @@
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- list version --> <!-- list version -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#versions" href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#versions"
/> />
</wadl:resources> </wadl:resources>
</section> </section>
@ -26,7 +26,7 @@
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- authenticate token --> <!-- authenticate token -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#tokens" href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#tokens"
/> />
</wadl:resources> </wadl:resources>
</section> </section>
@ -38,9 +38,9 @@
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create service --> <!-- create service -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#catalog"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#catalog"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#catalogID" href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#catalogID"
/> />
</wadl:resources> </wadl:resources>
</section> </section>
@ -51,9 +51,9 @@
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create endpoint --> <!-- create endpoint -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#endpoints"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#endpoints"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#endpointsID" href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#endpointsID"
/> />
</wadl:resources> </wadl:resources>
</section> </section>
@ -96,17 +96,17 @@
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create domain --> <!-- create domain -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domains"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#domains"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domainID"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#domainID"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domainIDUserIDRoles"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#domainIDUserIDRoles"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domainIDUserIDRoleID"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#domainIDUserIDRoleID"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domainIDGroupIDRoles"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#domainIDGroupIDRoles"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#domainIDGroupIDRoleID" href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#domainIDGroupIDRoleID"
/> />
</wadl:resources> </wadl:resources>
</section> </section>
@ -117,23 +117,23 @@
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create project --> <!-- create project -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projects"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#projects"/>
<!-- get project --> <!-- get project -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectID"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#projectID"/>
<!-- list project users --> <!-- list project users -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectIDUsers"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#projectIDUsers"/>
<!-- list project user roles --> <!-- list project user roles -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectIDUserIDRoles"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#projectIDUserIDRoles"/>
<!-- check project user role --> <!-- check project user role -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectIDUserIDRoleID"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#projectIDUserIDRoleID"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectIDGroupIDRoles"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#projectIDGroupIDRoles"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#projectIDGroupIDRoleID" href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#projectIDGroupIDRoleID"
/> />
</wadl:resources> </wadl:resources>
</section> </section>
@ -144,15 +144,15 @@
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create user --> <!-- create user -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#users"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#users"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#userID"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#userID"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#userIDGroups"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#userIDGroups"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#userIDProjects"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#userIDProjects"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#userIDRoles" href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#userIDRoles"
/> />
</wadl:resources> </wadl:resources>
</section> </section>
@ -163,16 +163,16 @@
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create group --> <!-- create group -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#groups"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#groups"/>
<!-- get group --> <!-- get group -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#groupID"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#groupID"/>
<!-- list group users --> <!-- list group users -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#groupIDUsers"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#groupIDUsers"/>
<!-- add user to group --> <!-- add user to group -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#groupIDUserIDs" href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#groupIDUserIDs"
/> />
</wadl:resources> </wadl:resources>
</section> </section>
@ -183,9 +183,9 @@
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create credential --> <!-- create credential -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#credentials"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#credentials"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#credentialID" href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#credentialID"
/> />
</wadl:resources> </wadl:resources>
</section> </section>
@ -196,11 +196,11 @@
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create role --> <!-- create role -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#roles"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#roles"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#roleID"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#roleID"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#role_assignments" href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#role_assignments"
/> />
</wadl:resources> </wadl:resources>
</section> </section>
@ -211,9 +211,9 @@
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<!-- create policy --> <!-- create policy -->
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#policies"/> href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#policies"/>
<wadl:resource <wadl:resource
href="../wadls/identity-api/src/v3/wadl/identity-admin.wadl#policyID" href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#policyID"
/> />
</wadl:resources> </wadl:resources>
</section> </section>

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

@ -5,7 +5,7 @@
xmlns:linkend="http://www.w3.org/1999/linkend" xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref" xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="image-v1"> version="5.0-extension RackBook-2.0" xml:id="image-v1" role="api-reference">
<title>Image Service API v1</title> <title>Image Service API v1</title>
<para>Load images for use at launch time by the Compute API. Also, <para>Load images for use at launch time by the Compute API. Also,
assign metadata to images.</para> assign metadata to images.</para>

15
api-ref/src/docbkx/preface.xml
View File

@ -13,15 +13,16 @@
<title>OpenStack API Complete Reference</title> <title>OpenStack API Complete Reference</title>
<para>Use the OpenStack APIs and extensions in your OpenStack <para>Use the OpenStack APIs and extensions in your OpenStack
cloud.</para> cloud.</para>
<xi:include href="itemizedlist-service-list.xml"/> <xi:include
href="itemizedlist-service-list.xml"/>
<para>You must install the packages for each API separately. After <para>You must install the packages for each API separately. After
you authenticate through the <link you authenticate through the <link
xlink:href="api-ref-identity.html">Identity xlink:href="api-ref-identity.html">Identity API</link>,
API</link>, you can use the other APIs and extensions to you can use the other APIs and extensions to launch server
launch server instances, create images, assign metadata to instances, create images, assign metadata to instances and
instances and images, create containers and objects, and images, create containers and objects, and complete other
complete other actions in your OpenStack cloud. To get started actions in your OpenStack cloud. To get started with the APIs,
with the APIs, see the <link see the <link
xlink:href="http://docs.openstack.org/api/quick-start/content/" xlink:href="http://docs.openstack.org/api/quick-start/content/"
>OpenStack API Quick Start</link>.</para> >OpenStack API Quick Start</link>.</para>
<para>&nbsp;</para> <para>&nbsp;</para>

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

@ -83,55 +83,73 @@
<!-- Image List Parameters --> <!-- Image List Parameters -->
<!ENTITY imageListParameters <!ENTITY imageListParameters '<param xmlns="http://wadl.dev.java.net/2009/02"
' name="changes-since" style="query" required="false"
<param xmlns="http://wadl.dev.java.net/2009/02" type="xsd:dateTime">
name="changes-since" style="query" required="false" type="xsd:dateTime">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>A time/date stamp for when the image last changed status.</para></wadl:doc></param> <para>A time/date stamp for when the image last
changed status.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="server" style="query" required="false" type="xsd:anyURI"> name="server" style="query" required="false"
type="xsd:anyURI">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Name of the server in URL format.</para></wadl:doc></param> <para>Name of the server in URL
format.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="query" required="false" type="xsd:string"> name="name" style="query" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Name of the image as a string.</para></wadl:doc></param> <para>Name of the image as a
string.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="status" style="query" required="false" type="csapi:ImageStatus"> name="status" style="query" required="false"
type="csapi:ImageStatus">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Value of the status of the image so that you can filter on "ACTIVE" for example.</para></wadl:doc></param> <para>Value of the status of the image so that you
can filter on "ACTIVE" for
example.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="marker" style="query" required="false" type="csapi:UUID"> name="marker" style="query" required="false"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>UUID of the image at which you want to set a marker.</para></wadl:doc></param> <para>UUID of the image at which you want to set a
marker.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="limit" style="query" required="false" type="xsd:int"> name="limit" style="query" required="false"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Integer value for the limit of values to return.</para></wadl:doc></param> <para>Integer value for the limit of values to
return.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="type" style="query" required="false" type="xsd:string" default="ALL"> name="type" style="query" required="false"
type="xsd:string" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Value of the type of image, such as BASE, SERVER, or ALL.</para></wadl:doc> <para>Value of the type of image, such as BASE,
SERVER, or ALL.</para></wadl:doc>
<option value="BASE"/> <option value="BASE"/>
<option value="SERVER"/> <option value="SERVER"/>
<option value="ALL"/> <option value="ALL"/>
</param> </param>'>
'>
<!-- Server Create Parameters --> <!-- Server Create Parameters -->
<!ENTITY serverCreateParameters '<param xmlns="http://wadl.dev.java.net/2009/02" <!ENTITY serverCreateParameters '<param xmlns="http://wadl.dev.java.net/2009/02"
@ -139,9 +157,9 @@
type="xsd:string"> type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>The name xml:lang="EN"><para>The name of the security
of the security group. If blank, the server is group. If blank, the server is created in the
created in the "default" security <code>default</code> security
group.</para></wadl:doc> group.</para></wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
@ -149,17 +167,17 @@
type="xsd:string"> type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Configuration information or scripts to use xml:lang="EN"><para>Configuration information or
upon launch. Must be Base64 encoded.</para></wadl:doc> scripts to use upon launch. Must be Base64
encoded.</para></wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="availability_zone" style="query" name="availability_zone" style="query"
required="false" type="xsd:string"> required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>The xml:lang="EN"><para>The availability zone in which
availability zone in which to launch the to launch the server.</para></wadl:doc>
server.</para></wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="server" style="plain" required="true" name="server" style="plain" required="true"
@ -170,9 +188,8 @@
<para>server.</para> <para>server.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param name="imageRef" style="plain" required="true" <param xmlns="http://wadl.dev.java.net/2009/02"
xmlns:csapi="http://docs.openstack.org/compute/api/v2" name="imageRef" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="csapi:string"> type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -182,9 +199,8 @@
<para>Specify as an ID or full <para>Specify as an ID or full
URL.</para></wadl:doc> URL.</para></wadl:doc>
</param> </param>
<param name="flavorRef" style="plain" required="true" <param xmlns="http://wadl.dev.java.net/2009/02"
xmlns:csapi="http://docs.openstack.org/compute/api/v2" name="flavorRef" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="csapi:string"> type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -194,63 +210,79 @@
<para>Specify as an ID or full <para>Specify as an ID or full
URL.</para></wadl:doc> URL.</para></wadl:doc>
</param> </param>
<param name="networks" style="plain" type="xsd:string" <param xmlns="http://wadl.dev.java.net/2009/02"
name="networks" style="plain" type="xsd:string"
required="false"> required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
<para>A <code>networks</code> object. By default, the server xmlns:wadl="http://wadl.dev.java.net/2009/02"
instance is provisioned with all isolated networks for the xml:lang="EN">
tenant.</para> <para>A <code>networks</code> object. By default,
<para>Optionally, you can create one or more NICs on the the server instance is provisioned with all
isolated networks for the tenant.</para>
<para>Optionally, you can create one or more NICs
on the server.</para>
<para>To provision the server instance with a NIC
for a <code>nova-network</code> network,
specify the UUID in the <code>uuid</code>
attribute in a <code>networks</code>
object.</para>
<para>To provision the server instance with a NIC
for a <code>neutron</code> network, specify
the UUID in the <code>port</code> attribute in
a <code>networks</code> object.</para>
<para>You can specify multiple NICs on the
server.</para> server.</para>
<para>To provision the server instance with a NIC for a
<code>nova-network</code> network, specify the UUID in
the <code>uuid</code> attribute in a <code>networks</code>
object.</para>
<para>To provision the server instance with a NIC for a
<code>neutron</code> network, specify the UUID in the
<code>port</code> attribute in a <code>networks</code>
object.</para>
<para>You can specify multiple NICs on the server.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param name="uuid" style="plain" type="xsd:string" required="false"> <param xmlns="http://wadl.dev.java.net/2009/02"
<wadl:doc xmlns="http://docbook.org/ns/docbook"> name="uuid" style="plain" type="xsd:string"
<para>To provision the server instance with a NIC for a
<code>nova-network</code> network, specify the UUID in
the <code>uuid</code> attribute in a <code>networks</code>
object. Required if you omit the <code>port</code>
attribute.</para>
</wadl:doc>
</param>
<param name="port" style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook">
<para>To provision the server instance with a NIC for a
<code>neutron</code> network, specify the UUID in the
<code>port</code> attribute in a <code>networks</code>
object. Required if you omit the <code>uuid</code>
attribute.</para>
</wadl:doc>
</param>
<param name="fixed_ip" style="plain" type="xsd:string"
required="false"> required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
<para>A fixed IPv4 address for the NIC. Valid with a xmlns:wadl="http://wadl.dev.java.net/2009/02"
<code>neutron</code> or <code>nova-networks</code> xml:lang="EN">
network.</para> <para>To provision the server instance with a NIC
for a <code>nova-network</code> network,
specify the UUID in the <code>uuid</code>
attribute in a <code>networks</code> object.
Required if you omit the <code>port</code>
attribute.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param name="name" style="plain" required="true" <param xmlns="http://wadl.dev.java.net/2009/02"
xmlns:csapi="http://docs.openstack.org/compute/api/v2" name="port" style="plain" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>To provision the server instance with a NIC
for a <code>neutron</code> network, specify
the UUID in the <code>port</code> attribute in
a <code>networks</code> object. Required if
you omit the <code>uuid</code>
attribute.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="fixed_ip" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A fixed IPv4 address for the NIC. Valid with
a <code>neutron</code> or
<code>nova-networks</code> network.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" required="true"
type="csapi:string"> type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="name"> xml:lang="EN" title="name">
<para>The server name.</para></wadl:doc> <para>The server name.</para></wadl:doc>
</param> </param>
<param name="metadata" style="plain" required="false" <param xmlns="http://wadl.dev.java.net/2009/02"
xmlns:csapi="http://docs.openstack.org/compute/api/v2" name="metadata" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="csapi:string"> type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -259,8 +291,7 @@
size of the metadata key and value is 255 size of the metadata key and value is 255
bytes each.</para></wadl:doc> bytes each.</para></wadl:doc>
</param> </param>
<param name="personality" style="plain" required="false" <param xmlns="http://wadl.dev.java.net/2009/02" name="personality" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="csapi:string"> type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -271,21 +302,17 @@
limit refers to the number of bytes in the limit refers to the number of bytes in the
decoded data and not the number of characters decoded data and not the number of characters
in the encoded data.</para></wadl:doc> in the encoded data.</para></wadl:doc>
</param> </param>'>
'>
<!-- Server List Parameters --> <!-- Server List Parameters -->
<!ENTITY serverListParameters <!ENTITY serverListParameters '<param xmlns="http://wadl.dev.java.net/2009/02"
'
<param xmlns="http://wadl.dev.java.net/2009/02"
name="changes-since" style="query" required="false" name="changes-since" style="query" required="false"
type="xsd:dateTime"> type="xsd:dateTime">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>A time/date stamp for when the server <para>A time/date stamp for when the server last
last changed status.</para></wadl:doc> changed status.</para></wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="image" style="query" required="false" name="image" style="query" required="false"
@ -293,168 +320,209 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Name of the image in URL format.</para></wadl:doc> <para>Name of the image in URL
format.</para></wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="flavor" style="query" required="false" type="xsd:anyURI"> name="flavor" style="query" required="false"
type="xsd:anyURI">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Name of the flavor in URL format.</para></wadl:doc> <para>Name of the flavor in URL
format.</para></wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="query" required="false" type="xsd:string"> name="name" style="query" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"><para>Name of the server as a string.</para></wadl:doc> xml:lang="EN"><para>Name of the server as a
string.</para></wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="marker" style="query" required="false" type="csapi:UUID"> name="marker" style="query" required="false"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>UUID of the server at which you want to set a marker.</para></wadl:doc> <para>UUID of the server at which you want to set
a marker.</para></wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="limit" style="query" required="false" type="xsd:int"> name="limit" style="query" required="false"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Integer value for the limit of values to return.</para></wadl:doc> <para>Integer value for the limit of values to
return.</para></wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="status" style="query" required="false" type="csapi:ServerStatus"> name="status" style="query" required="false"
type="csapi:ServerStatus">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Value of the status of the server so that you can filter on <para>Value of the status of the server so that
"ACTIVE" for example.</para></wadl:doc> you can filter on "ACTIVE" for
example.</para></wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="host" style="query" required="false" type="xsd:string"> name="host" style="query" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Name of the host as a string.</para></wadl:doc> <para>Name of the host as a
</param> string.</para></wadl:doc>
'> </param>'>
<!-- Flavor List Parameters --> <!-- Flavor List Parameters -->
<!ENTITY flavorListParameters <!ENTITY flavorListParameters '<param xmlns="http://wadl.dev.java.net/2009/02"
' name="changes-since" style="query" required="false"
<param xmlns="http://wadl.dev.java.net/2009/02" type="xsd:dateTime">
name="changes-since" style="query" required="false" type="xsd:dateTime">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>A time/date stamp for when the flavor last changed.</para></wadl:doc></param> <para>A time/date stamp for when the flavor last
<param xmlns="http://wadl.dev.java.net/2009/02" changed.</para></wadl:doc>
name="minDisk" style="query" required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Integer value for the minimum disk space in GB so you can filter results.</para></wadl:doc></param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minRam" style="query" required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Integer value for the minimum RAM so you can filter results.</para></wadl:doc></param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="marker" style="query" required="false" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>UUID of the flavor at which you want to set a marker.</para></wadl:doc></param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="limit" style="query" required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Integer value for the limit of values to return.</para></wadl:doc></param>
'>
<!ENTITY flavorReqParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02"
name="disk" style="plain" required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Integer value for the minimum disk space in GB.</para></wadl:doc></param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The flavor ID.</para></wadl:doc></param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The flavor name.</para></wadl:doc></param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ram" style="plain" required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Amount of RAM.</para></wadl:doc></param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="vcpus" style="plain" required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Number of VCPUs.</para></wadl:doc></param>
'>
<!ENTITY flavorRespParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02"
name="disk" style="plain" required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Integer value for the minimum disk space in GB.</para></wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" required="true" type="xsd:int"> name="minDisk" style="query" required="false"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The flavor ID.</para></wadl:doc></param> <para>Integer value for the minimum disk space in
GB so you can filter
results.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="links" style="plain" required="true" type="xsd:string"> name="minRam" style="query" required="false"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Flavor links.</para></wadl:doc></param> <para>Integer value for the minimum RAM so you can
filter results.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" required="true" type="xsd:string"> name="marker" style="query" required="false"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The flavor name.</para></wadl:doc></param> <para>UUID of the flavor at which you want to set
a marker.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="ram" style="plain" required="true" type="xsd:int"> name="limit" style="query" required="false"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Amount of RAM.</para></wadl:doc></param> <para>Integer value for the limit of values to
return.</para></wadl:doc>
</param>'>
<!ENTITY flavorReqParameters '<param xmlns="http://wadl.dev.java.net/2009/02"
name="disk" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Integer value for the minimum disk space
in GB.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="vcpus" style="plain" required="true" type="xsd:int"> name="id" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Number of VCPUs.</para></wadl:doc></param> <para>The flavor ID.</para></wadl:doc>
'> </param>
<!ENTITY quotaSetsReqParameters <param xmlns="http://wadl.dev.java.net/2009/02"
' <param name="quota_set" style="plain" required="true" name="name" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The flavor name.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ram" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Amount of RAM.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="vcpus" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Number of VCPUs.</para></wadl:doc>
</param>'>
<!ENTITY flavorRespParameters '<param xmlns="http://wadl.dev.java.net/2009/02"
name="disk" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Integer value for the minimum disk space
in GB.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The flavor ID.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="links" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Flavor links.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The flavor name.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ram" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Amount of RAM.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="vcpus" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Number of VCPUs.</para></wadl:doc>
</param>'>
<!ENTITY quotaSetsReqParameters '
<param name="quota_set" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:string"> type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>A <para>A quota_set object.</para></wadl:doc>
quota_set object.</para></wadl:doc>
</param> </param>
<param name="cores" style="plain" required="false" <param name="cores" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -462,49 +530,49 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of instance cores allowed for
number of instance cores allowed for each
tenant.</para></wadl:doc>
</param>
<param name="fixed_ips " style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of fixed IP addresses allowed for each
tenant. Must be equal to or greater than the
number of allowed instances.</para></wadl:doc>
</param>
<param name="floating_ips" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of floating IP addresses allowed for
each tenant.</para></wadl:doc> each tenant.</para></wadl:doc>
</param> </param>
<param name="fixed_ips " style="plain"
required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of fixed IP addresses allowed
for each tenant. Must be equal to or
greater than the number of allowed
instances.</para></wadl:doc>
</param>
<param name="floating_ips" style="plain"
required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of floating IP addresses
allowed for each tenant.</para></wadl:doc>
</param>
<param name="id" style="plain" required="false" <param name="id" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int"> type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The ID for the quota
ID for the quota set.</para></wadl:doc> set.</para></wadl:doc>
</param> </param>
<param name="injected_file_content_bytes" style="plain" <param name="injected_file_content_bytes"
style="plain"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int"> required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of bytes of content allowed
number of bytes of content allowed for each for each injected file.</para></wadl:doc>
injected file.</para></wadl:doc>
</param> </param>
<param name="injected_file_path_bytes " style="plain" <param name="injected_file_path_bytes " style="plain"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -512,9 +580,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of bytes allowed for each
number of bytes allowed for each injected file injected file path.</para></wadl:doc>
path.</para></wadl:doc>
</param> </param>
<param name="injected_files" style="plain" <param name="injected_files" style="plain"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -522,9 +589,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of injected files allowed for
number of injected files allowed for each each tenant.</para></wadl:doc>
tenant.</para></wadl:doc>
</param> </param>
<param name="instances" style="plain" required="false" <param name="instances" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -532,8 +598,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of instances allowed for each
number of instances allowed for each
tenant.</para></wadl:doc> tenant.</para></wadl:doc>
</param> </param>
<param name="key_pairs" style="plain" required="false" <param name="key_pairs" style="plain" required="false"
@ -542,8 +607,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of key pairs allowed for each
number of key pairs allowed for each
user.</para></wadl:doc> user.</para></wadl:doc>
</param> </param>
<param name="metadata_items" style="plain" <param name="metadata_items" style="plain"
@ -552,9 +616,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of metadata items allowed for
number of metadata items allowed for each each instance.</para></wadl:doc>
instance.</para></wadl:doc>
</param> </param>
<param name="ram" style="plain" required="false" <param name="ram" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -562,9 +625,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The amount of instance RAM in megabytes
amount of instance RAM in megabytes allowed allowed for each tenant.</para></wadl:doc>
for each tenant.</para></wadl:doc>
</param> </param>
<param name="security_group_rules" style="plain" <param name="security_group_rules" style="plain"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -572,9 +634,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of rules allowed for each
number of rules allowed for each security security group.</para></wadl:doc>
group.</para></wadl:doc>
</param> </param>
<param name="security_groups" style="plain" <param name="security_groups" style="plain"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -582,20 +643,16 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of security groups allowed
number of security groups allowed for each for each tenant.</para></wadl:doc>
tenant.</para></wadl:doc> </param>'>
</param> <!ENTITY quotaSetsRespParameters '<param name="quota_set" style="plain" required="true"
'>
<!ENTITY quotaSetsRespParameters
' <param name="quota_set" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:string"> type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>A <para>A quota_set object.</para></wadl:doc>
quota_set object.</para></wadl:doc>
</param> </param>
<param name="cores" style="plain" required="true" <param name="cores" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -603,9 +660,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of instance cores allowed for
number of instance cores allowed for each each tenant.</para></wadl:doc>
tenant.</para></wadl:doc>
</param> </param>
<param name="fixed_ips " style="plain" required="true" <param name="fixed_ips " style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -613,20 +669,20 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of fixed IP addresses allowed
number of fixed IP addresses allowed for each for each tenant. Must be equal to or
tenant. Must be equal to or greater than the greater than the number of allowed
number of allowed instances.</para></wadl:doc> instances.</para></wadl:doc>
</param> </param>
<param name="floating_ips" style="plain" required="true" <param name="floating_ips" style="plain"
required="true"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int"> type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of floating IP addresses
number of floating IP addresses allowed for allowed for each tenant.</para></wadl:doc>
each tenant.</para></wadl:doc>
</param> </param>
<param name="id" style="plain" required="true" <param name="id" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -634,18 +690,18 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The ID for the quota
ID for the quota set.</para></wadl:doc> set.</para></wadl:doc>
</param> </param>
<param name="injected_file_content_bytes" style="plain" <param name="injected_file_content_bytes"
style="plain"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int"> required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of bytes of content allowed
number of bytes of content allowed for each for each injected file.</para></wadl:doc>
injected file.</para></wadl:doc>
</param> </param>
<param name="injected_file_path_bytes " style="plain" <param name="injected_file_path_bytes " style="plain"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -653,9 +709,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of bytes allowed for each
number of bytes allowed for each injected file injected file path.</para></wadl:doc>
path.</para></wadl:doc>
</param> </param>
<param name="injected_files" style="plain" <param name="injected_files" style="plain"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -663,9 +718,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of injected files allowed for
number of injected files allowed for each each tenant.</para></wadl:doc>
tenant.</para></wadl:doc>
</param> </param>
<param name="instances" style="plain" required="true" <param name="instances" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -673,8 +727,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of instances allowed for each
number of instances allowed for each
tenant.</para></wadl:doc> tenant.</para></wadl:doc>
</param> </param>
<param name="key_pairs" style="plain" required="true" <param name="key_pairs" style="plain" required="true"
@ -683,8 +736,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of key pairs allowed for each
number of key pairs allowed for each
user.</para></wadl:doc> user.</para></wadl:doc>
</param> </param>
<param name="metadata_items" style="plain" <param name="metadata_items" style="plain"
@ -693,9 +745,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of metadata items allowed for
number of metadata items allowed for each each instance.</para></wadl:doc>
instance.</para></wadl:doc>
</param> </param>
<param name="ram" style="plain" required="true" <param name="ram" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -703,9 +754,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The amount of instance RAM in megabytes
amount of instance RAM in megabytes allowed allowed for each tenant.</para></wadl:doc>
for each tenant.</para></wadl:doc>
</param> </param>
<param name="security_group_rules" style="plain" <param name="security_group_rules" style="plain"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -713,9 +763,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of rules allowed for each
number of rules allowed for each security security group.</para></wadl:doc>
group.</para></wadl:doc>
</param> </param>
<param name="security_groups" style="plain" <param name="security_groups" style="plain"
xmlns="http://wadl.dev.java.net/2009/02" xmlns="http://wadl.dev.java.net/2009/02"
@ -723,11 +772,9 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The <para>The number of security groups allowed
number of security groups allowed for each for each tenant.</para></wadl:doc>
tenant.</para></wadl:doc> </param>'>
</param>
'>
<!-- Useful for describing APIs --> <!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'> <!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'> <!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>

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

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved --> <!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02" <application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0" xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -7,7 +7,7 @@
xmlns:csapi="http://docs.openstack.org/compute/api/v2"> xmlns:csapi="http://docs.openstack.org/compute/api/v2">
<resources base="https://servers.api.openstack.com" <resources base="https://servers.api.openstack.com"
xml:id="os-hypervisors-v2"> xml:id="os-hypervisors-v2">
<resource id="version" path="v2/"> <resource id="version" path="v2">
<resource id="tenant_id" path="{tenant_id}"> <resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template" <param name="tenant_id" style="template"
type="xsd:string"> type="xsd:string">

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

@ -25,7 +25,7 @@
<!--*******************************************************--> <!--*******************************************************-->
<resources base="https://servers.api.openstack.com" <resources base="https://servers.api.openstack.com"
xml:id="os-compute-v2"> xml:id="os-compute-v2">
<resource id="version" type="#VersionDetails" path="v2/"> <resource id="version" type="#VersionDetails" path="v2">
<resource id="tenant_id" path="{tenant_id}"> <resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template" <param name="tenant_id" style="template"
type="csapi:UUID"> type="csapi:UUID">
@ -37,7 +37,9 @@
<resource id="extensions" type="#ExtensionList" <resource id="extensions" type="#ExtensionList"
path="extensions"> path="extensions">
<resource id="extension" path="{alias}"> <resource id="extension" path="{alias}">
<param name="alias" style="template" <param
xmlns="http://wadl.dev.java.net/2009/02"
name="alias" style="template"
type="xsd:string"> type="xsd:string">
<wadl:doc <wadl:doc
xmlns="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
@ -59,24 +61,50 @@
<resource id="server_detail" path="detail" <resource id="server_detail" path="detail"
type="#DetailServerList"/> type="#DetailServerList"/>
<resource id="server_id" path="{server_id}"> <resource id="server_id" path="{server_id}">
<param name="server_id" style="template" <param
xmlns="http://wadl.dev.java.net/2009/02"
name="server_id" style="template"
type="csapi:UUID"> type="csapi:UUID">
<wadl:doc <wadl:doc
xmlns="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The server xml:lang="EN"><para>The UUID for the
ID.</para> server.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<method href="#getServer"/> <method href="#getServer"/>
<method href="#updateServer"/> <method href="#updateServer"/>
<method href="#deleteServer"/> <method href="#deleteServer"/>
<resource id="server_metadata" path="metadata"
type="#ServerMetadataDetails">
<resource id="ServerMetadataKey"
path="{key}">
<param
xmlns="http://wadl.dev.java.net/2009/02"
name="key" style="template"
type="csapi:MetadataKey">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Server metadata item key">
<para>A string. Maximum length is
255 characters.</para>
</wadl:doc>
</param>
<method href="#getServerMetadataItem"/>
<method href="#setServerMetadataItem"/>
<method
href="#deleteServerMetadataItem"/>
</resource>
</resource>
<resource id="ips" path="ips" <resource id="ips" path="ips"
type="#Addresses"> type="#Addresses">
<!-- <method href="#getServerAddresses"/> --> <!-- <method href="#getServerAddresses"/> -->
<resource id="network_label" <resource id="network_label"
path="{network_label}" path="{network_label}"
type="#NetworkAddressList"> type="#NetworkAddressList">
<param name="network_label" <param
xmlns="http://wadl.dev.java.net/2009/02"
name="network_label"
style="template" type="xsd:string"> style="template" type="xsd:string">
<wadl:doc xml:lang="EN" <wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
@ -89,35 +117,6 @@
<!--<method href="#getNetworkAddresses"/>--> <!--<method href="#getNetworkAddresses"/>-->
</resource> </resource>
</resource> </resource>
<resource id="metadata" path="metadata"
type="#Metadata #MetadataList">
<resource id="MetadataKey" path="{key}">
<param name="key" style="template"
type="csapi:MetadataKey">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Metadata item key">
<para>A string. Maximum length is
255 characters.</para>
</wadl:doc>
</param>
<method href="#getMetadataItem"/>
<method href="#setMetadataItem"/>
<method href="#deleteMetadataItem"/>
</resource>
</resource>
</resource>
<resource path="{server_id}">
<param name="server_id" style="template"
type="csapi:UUID">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Server UUID"
><para>The UUID for the server of
interest to you.</para>
</wadl:doc>
</param>
<resource id="action" path="action"> <resource id="action" path="action">
<method href="#changePassword"/> <method href="#changePassword"/>
<method href="#rebootServer"/> <method href="#rebootServer"/>
@ -145,10 +144,12 @@
<method href="#getImage"/> <method href="#getImage"/>
<method href="#deleteImage"/> <method href="#deleteImage"/>
<resource id="image_metadata" path="metadata" <resource id="image_metadata" path="metadata"
type="#Metadata #MetadataList"> type="#ImageMetadataDetails">
<resource id="imageMetadataKey" path="{key}"> <resource id="imageMetadataKey" path="{key}">
<param name="key" style="template" <param
type="csapi:MetadataKey"> xmlns="http://wadl.dev.java.net/2009/02"
name="key" style="template"
type="csapi:imageMetadataKey">
<wadl:doc <wadl:doc
xmlns="http://docbook.org/ns/docbook" xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" xml:lang="EN"
@ -157,9 +158,9 @@
255 characters.</para> 255 characters.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<method href="#getMetadataItem"/> <method href="#getImageMetadataItem"/>
<method href="#setMetadataItem"/> <method href="#setImageMetadataItem"/>
<method href="#deleteMetadataItem"/> <method href="#deleteImageMetadataItem"/>
</resource> </resource>
</resource> </resource>
</resource> </resource>
@ -258,25 +259,27 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Flavor list"> title="Flavor list">
<para>A list of flavors. Each flavor contains IDs, names, <para>A list of flavors. Each flavor contains IDs, names,
and links -- other attributes are omitted.</para> and links; other attributes are omitted.</para>
</wadl:doc> </wadl:doc>
<method href="#listFlavors"/> <method href="#listFlavors"/>
</resource_type> </resource_type>
<resource_type id="Metadata"> <resource_type id="ServerMetadataDetails">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Metadata"> title="Server metadata list">
<para>Metadata resource type, this is used for images and <para>Metadata details for a server.</para>
servers.</para>
</wadl:doc> </wadl:doc>
<method href="#setMetadata"/> <method href="#showServerMetadata"/>
<method href="#updateMetadata"/> <method href="#createServerMetadata"/>
<method href="#updateServerMetadata"/>
</resource_type> </resource_type>
<resource_type id="MetadataList"> <resource_type id="ImageMetadataDetails">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Metadata list"> title="Image metadata list">
<para>A list of metadata.</para> <para>Metadata details for an image.</para>
</wadl:doc> </wadl:doc>
<method href="#listMetadata"/> <method href="#showImageMetadata"/>
<method href="#createImageMetadata"/>
<method href="#updateImageMetadata"/>
</resource_type> </resource_type>
<!--*******************************************************--> <!--*******************************************************-->
@ -351,15 +354,15 @@
<param name="next" style="plain" type="xsd:anyURI" <param name="next" style="plain" type="xsd:anyURI"
path="/common:extensions/atom:link[@rel='next']/@href"> path="/common:extensions/atom:link[@rel='next']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the next item in the xml:lang="EN"><para>Moves to the next metadata
list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#ExtensionList" rel="next"/> <link resource_type="#ExtensionList" rel="next"/>
</param> </param>
<param name="previous" style="plain" type="xsd:anyURI" <param name="previous" style="plain" type="xsd:anyURI"
path="/common:extensions/atom:link[@rel='previous']/@href"> path="/common:extensions/atom:link[@rel='previous']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the previous item in xml:lang="EN"><para>Moves to the previous metadata
the list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#ExtensionList" rel="previous"/> <link resource_type="#ExtensionList" rel="previous"/>
</param> </param>
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -473,15 +476,15 @@
<param name="next" style="plain" type="xsd:anyURI" <param name="next" style="plain" type="xsd:anyURI"
path="/csapi:servers/atom:link[@rel='next']/@href"> path="/csapi:servers/atom:link[@rel='next']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the next item in the xml:lang="EN"><para>Moves to the next metadata
list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#ServerList" rel="next"/> <link resource_type="#ServerList" rel="next"/>
</param> </param>
<param name="previous" style="plain" type="xsd:anyURI" <param name="previous" style="plain" type="xsd:anyURI"
path="/csapi:servers/atom:link[@rel='previous']/@href"> path="/csapi:servers/atom:link[@rel='previous']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the previous item in xml:lang="EN"><para>Moves to the previous metadata
the list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#ServerList" rel="previous"/> <link resource_type="#ServerList" rel="previous"/>
</param> </param>
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -518,15 +521,15 @@
<param name="next" style="plain" type="xsd:anyURI" <param name="next" style="plain" type="xsd:anyURI"
path="/csapi:servers/atom:link[@rel='next']/@href"> path="/csapi:servers/atom:link[@rel='next']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the next item in the xml:lang="EN"><para>Moves to the next metadata
list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#DetailServerList" rel="next"/> <link resource_type="#DetailServerList" rel="next"/>
</param> </param>
<param name="previous" style="plain" type="xsd:anyURI" <param name="previous" style="plain" type="xsd:anyURI"
path="/csapi:servers/atom:link[@rel='previous']/@href"> path="/csapi:servers/atom:link[@rel='previous']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the previous item in xml:lang="EN"><para>Moves to the previous metadata
the list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#DetailServerList" rel="previous" <link resource_type="#DetailServerList" rel="previous"
/> />
</param> </param>
@ -1024,15 +1027,15 @@
<param name="next" style="plain" type="xsd:anyURI" <param name="next" style="plain" type="xsd:anyURI"
path="/csapi:flavors/atom:link[@rel='next']/@href"> path="/csapi:flavors/atom:link[@rel='next']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the next item in the xml:lang="EN"><para>Moves to the next metadata
list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#FlavorList" rel="next"/> <link resource_type="#FlavorList" rel="next"/>
</param> </param>
<param name="previous" style="plain" type="xsd:anyURI" <param name="previous" style="plain" type="xsd:anyURI"
path="/csapi:flavors/atom:link[@rel='previous']/@href"> path="/csapi:flavors/atom:link[@rel='previous']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the previous item in xml:lang="EN"><para>Moves to the previous metadata
the list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#FlavorList" rel="previous"/> <link resource_type="#FlavorList" rel="previous"/>
</param> </param>
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -1063,15 +1066,15 @@
<param name="next" style="plain" type="xsd:anyURI" <param name="next" style="plain" type="xsd:anyURI"
path="/csapi:flavors/atom:link[@rel='next']/@href"> path="/csapi:flavors/atom:link[@rel='next']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the next item in the xml:lang="EN"><para>Moves to the next metadata
list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#DetailFlavorList" rel="next"/> <link resource_type="#DetailFlavorList" rel="next"/>
</param> </param>
<param name="previous" style="plain" type="xsd:anyURI" <param name="previous" style="plain" type="xsd:anyURI"
path="/csapi:flavors/atom:link[@rel='previous']/@href"> path="/csapi:flavors/atom:link[@rel='previous']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the previous item in xml:lang="EN"><para>Moves to the previous metadata
the list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#DetailFlavorList" rel="previous" <link resource_type="#DetailFlavorList" rel="previous"
/> />
</param> </param>
@ -1124,21 +1127,20 @@
<para role="shortdesc">Lists all details for available <para role="shortdesc">Lists all details for available
images.</para> images.</para>
</wadl:doc> </wadl:doc>
<request/> <request> &imageListParameters; </request>
<!--&imageListParameters; </request> -->
<response status="200 203"> <response status="200 203">
<param name="next" style="plain" type="xsd:anyURI" <param name="next" style="plain" type="xsd:anyURI"
path="/csapi:images/atom:link[@rel='next']/@href"> path="/csapi:images/atom:link[@rel='next']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the next item in the xml:lang="EN"><para>Moves to the next metadata
list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#DetailImageList" rel="next"/> <link resource_type="#DetailImageList" rel="next"/>
</param> </param>
<param name="previous" style="plain" type="xsd:anyURI" <param name="previous" style="plain" type="xsd:anyURI"
path="/csapi:images/atom:link[@rel='previous']/@href"> path="/csapi:images/atom:link[@rel='previous']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the previous item in xml:lang="EN"><para>Moves to the previous metadata
the list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#DetailImageList" rel="previous" <link resource_type="#DetailImageList" rel="previous"
/> />
</param> </param>
@ -1167,8 +1169,7 @@
<para role="shortdesc">Lists IDs, names, and links for <para role="shortdesc">Lists IDs, names, and links for
available images.</para> available images.</para>
</wadl:doc> </wadl:doc>
<request/> <request> &imageListParameters; </request>
<!--&imageListParameters; </request> -->
<response status="200 203"> <response status="200 203">
<param name="images" style="plain" required="true" <param name="images" style="plain" required="true"
type="csapi:ImagesWithOnlyIDsNamesLinks" type="csapi:ImagesWithOnlyIDsNamesLinks"
@ -1180,15 +1181,15 @@
<param name="next" style="plain" type="xsd:anyURI" <param name="next" style="plain" type="xsd:anyURI"
path="/csapi:images/atom:link[@rel='next']/@href"> path="/csapi:images/atom:link[@rel='next']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the next item in the xml:lang="EN"><para>Moves to the next metadata
list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#ImageList" rel="next"/> <link resource_type="#ImageList" rel="next"/>
</param> </param>
<param name="previous" style="plain" type="xsd:anyURI" <param name="previous" style="plain" type="xsd:anyURI"
path="/csapi:images/atom:link[@rel='previous']/@href"> path="/csapi:images/atom:link[@rel='previous']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the previous item in xml:lang="EN"><para>Moves to the previous metadata
the list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#ImageList" rel="previous"/> <link resource_type="#ImageList" rel="previous"/>
</param> </param>
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -1242,26 +1243,72 @@
<response status="204"/> <response status="204"/>
<!-- Common and GET Faults --> &commonFaults; &getFaults; </method> <!-- Common and GET Faults --> &commonFaults; &getFaults; </method>
<!-- Metadata --> <!-- Metadata -->
<method name="GET" id="listMetadata"> <method name="GET" id="showServerMetadata">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="List metadata"> title="Show server metadata">
<para role="shortdesc">Lists metadata for the specified <para role="shortdesc">Shows metadata for a specified
resource.</para> server.</para>
</wadl:doc> </wadl:doc>
<response status="200 203"> <response status="200 203">
<param name="next" style="plain" type="xsd:anyURI" <param name="next" style="plain" type="xsd:anyURI"
path="/csapi:metadata/atom:link[@rel='next']/@href"> path="/csapi:metadata/atom:link[@rel='next']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the next item in the xml:lang="EN"><para>Moves to the next metadata
list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#MetadataList" rel="next"/> <link resource_type="#ServerMetadataDetails"
rel="next"/>
</param> </param>
<param name="previous" style="plain" type="xsd:anyURI" <param name="previous" style="plain" type="xsd:anyURI"
path="/csapi:metadata/atom:link[@rel='previous']/@href"> path="/csapi:metadata/atom:link[@rel='previous']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the previous item in xml:lang="EN"><para>Moves to the previous metadata
the list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#MetadataList" rel="previous"/> <link resource_type="#ServerMetadataDetails"
rel="previous"/>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/server-metadata-all-resp.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="csapi:metadata">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/server-metadata-all-resp.xml"
/>
</wadl:doc>
</representation>
</response>
<!-- Common Faults and GET Faults--> &commonFaults;
&getFaults; </method>
<method name="GET" id="showImageMetadata">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show image metadata">
<para role="shortdesc">Shows metadata for a specified
image.</para>
</wadl:doc>
<response status="200 203">
<param name="next" style="plain" type="xsd:anyURI"
path="/csapi:metadata/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="#ServerMetadataDetails"
rel="next"/>
</param>
<param name="previous" style="plain" type="xsd:anyURI"
path="/csapi:metadata/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="#ServerMetadataDetails"
rel="previous"/>
</param> </param>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1283,11 +1330,80 @@
</response> </response>
<!-- Common Faults and GET Faults--> &commonFaults; <!-- Common Faults and GET Faults--> &commonFaults;
&getFaults; </method> &getFaults; </method>
<method name="POST" id="updateMetadata"> <method name="POST" id="updateServerMetadata">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Update metadata items"> title="Update server metadata items">
<para role="shortdesc">Updates metadata items by key for <para role="shortdesc">Updates metadata items by key for a
the specified resource.</para> specified server.</para>
<para>Replaces items that match the specified keys and
does not modify items not specified in the
request.</para>
<para>An overLimit (<errorcode>413</errorcode>) fault
might be thrown if the operation causes the quota for
metadata items to be exceeded.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/server-metadata-req.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="csapi:metadata">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/server-metadata-req.xml"
/>
</wadl:doc>
</representation>
</request>
<response status="200">
<param name="next" style="plain" type="xsd:anyURI"
path="/csapi:metadata/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="#ServerMetadataDetails"
rel="next"/>
</param>
<param name="previous" style="plain" type="xsd:anyURI"
path="/csapi:metadata/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="#ServerMetadataDetails"
rel="previous"/>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/server-metadata-resp.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="csapi:metadata">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/server-metadata-resp.xml"
/>
</wadl:doc>
</representation>
</response>
<!-- Common, GET, POST/PUT, inProgress Faults-->
&commonFaults; &getFaults; &postPutFaults; &inProgressFault; </method>
<method name="POST" id="updateImageMetadata">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Update image metadata items">
<para role="shortdesc">Updates metadata items by key for a
specified image.</para>
<para>Replaces items that match the specified keys and <para>Replaces items that match the specified keys and
does not modify items not specified in the does not modify items not specified in the
request.</para> request.</para>
@ -1318,16 +1434,18 @@
<param name="next" style="plain" type="xsd:anyURI" <param name="next" style="plain" type="xsd:anyURI"
path="/csapi:metadata/atom:link[@rel='next']/@href"> path="/csapi:metadata/atom:link[@rel='next']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the next item in the xml:lang="EN"><para>Moves to the next metadata
list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#MetadataList" rel="next"/> <link resource_type="#ImageMetadataDetails" rel="next"
/>
</param> </param>
<param name="previous" style="plain" type="xsd:anyURI" <param name="previous" style="plain" type="xsd:anyURI"
path="/csapi:metadata/atom:link[@rel='previous']/@href"> path="/csapi:metadata/atom:link[@rel='previous']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the previous item in xml:lang="EN"><para>Moves to the previous metadata
the list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#MetadataList" rel="previous"/> <link resource_type="#ImageMetadataDetails"
rel="previous"/>
</param> </param>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1349,17 +1467,18 @@
</response> </response>
<!-- Common, GET, POST/PUT, inProgress Faults--> <!-- Common, GET, POST/PUT, inProgress Faults-->
&commonFaults; &getFaults; &postPutFaults; &inProgressFault; </method> &commonFaults; &getFaults; &postPutFaults; &inProgressFault; </method>
<method name="PUT" id="setMetadata"> <method name="PUT" id="createServerMetadata">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create or replace metadata"> title="Create or replace server metadata">
<para role="shortdesc">Sets metadata for the specified <para role="shortdesc">Creates or replaces metadata for a
resource.</para> specified server.</para>
<para>Replaces items that match the specified keys. If you <para>Replaces items that match the specified keys. If you
omit a key that already exists, this key retains its omit a key that already exists, the key retains its
value.</para> value.</para>
<para>If the number of metadata items exceeds the quota for metadata <para>If the number of metadata items exceeds the quota
items, an overLimit (<errorcode>413</errorcode>) fault for metadata items, an overLimit
might be thrown.</para> (<errorcode>413</errorcode>) fault might be
thrown.</para>
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -1384,16 +1503,18 @@
<param name="next" style="plain" type="xsd:anyURI" <param name="next" style="plain" type="xsd:anyURI"
path="/csapi:metadata/atom:link[@rel='next']/@href"> path="/csapi:metadata/atom:link[@rel='next']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the next item in the xml:lang="EN"><para>Moves to the next metadata
list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#MetadataList" rel="next"/> <link resource_type="#ServerMetadataDetails"
rel="next"/>
</param> </param>
<param name="previous" style="plain" type="xsd:anyURI" <param name="previous" style="plain" type="xsd:anyURI"
path="/csapi:metadata/atom:link[@rel='previous']/@href"> path="/csapi:metadata/atom:link[@rel='previous']/@href">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Moves to the previous item in xml:lang="EN"><para>Moves to the previous metadata
the list.</para></wadl:doc> item.</para></wadl:doc>
<link resource_type="#MetadataList" rel="previous"/> <link resource_type="#ServerMetadataDetails"
rel="previous"/>
</param> </param>
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1415,11 +1536,108 @@
</response> </response>
<!-- Common, GET, POST/PUT, inProgress Faults--> <!-- Common, GET, POST/PUT, inProgress Faults-->
&commonFaults; &getFaults; &postPutFaults; &inProgressFault; </method> &commonFaults; &getFaults; &postPutFaults; &inProgressFault; </method>
<method name="GET" id="getMetadataItem"> <method name="PUT" id="createImageMetadata">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Get metadata item"> title="Create or replace image metadata">
<para role="shortdesc">Gets a metadata item by key for the <para role="shortdesc">Creates or replaces metadata for a
specified resource.</para> specified image.</para>
<para>Replaces items that match the specified keys. If you
omit a key that already exists, this key retains its
value.</para>
<para>If the number of metadata items exceeds the quota
for metadata items, an overLimit
(<errorcode>413</errorcode>) fault might be
thrown.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/image-metadata-put-req.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="csapi:metadata">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/image-metadata-put-req.xml"
/>
</wadl:doc>
</representation>
</request>
<response status="200">
<param name="next" style="plain" type="xsd:anyURI"
path="/csapi:metadata/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="#ImageMetadataDetails" rel="next"
/>
</param>
<param name="previous" style="plain" type="xsd:anyURI"
path="/csapi:metadata/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="#ImageMetadataDetails"
rel="previous"/>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/image-metadata-put-resp.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="csapi:metadata">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/image-metadata-put-resp.xml"
/>
</wadl:doc>
</representation>
</response>
<!-- Common, GET, POST/PUT, inProgress Faults-->
&commonFaults; &getFaults; &postPutFaults; &inProgressFault; </method>
<method name="GET" id="getServerMetadataItem">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show server metadata item details">
<para role="shortdesc">Shows details for a metadata item
by key for a specified server.</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/server-metadata-resp.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="csapi:meta">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/server-metadata-resp.xml"
/>
</wadl:doc>
</representation>
</response>
<!-- Common Faults and GET Faults--> &commonFaults;
&getFaults; </method>
<method name="GET" id="getImageMetadataItem">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Show image metadata item details">
<para role="shortdesc">Shows details for a metadata item
by key for a specified image.</para>
</wadl:doc> </wadl:doc>
<response status="200 203"> <response status="200 203">
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -1442,11 +1660,61 @@
</response> </response>
<!-- Common Faults and GET Faults--> &commonFaults; <!-- Common Faults and GET Faults--> &commonFaults;
&getFaults; </method> &getFaults; </method>
<method name="PUT" id="setMetadataItem"> <method name="PUT" id="setServerMetadataItem">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create or update metadata item"> title="Create or update server metadata item">
<para role="shortdesc">Sets a metadata item by key for the <para role="shortdesc">Sets a metadata item by key for a
specified resource.</para> specified server.</para>
<para>An overLimit (<errorcode>413</errorcode>) fault
might be thrown if the operation causes the quota for
metadata items to be exceeded.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/server-metadata-req.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="csapi:meta">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/server-metadata-req.xml"
/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/server-metadata-resp.json"
/>
</wadl:doc>
</representation>
<representation mediaType="application/xml"
element="csapi:meta">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../api_samples/server-metadata-resp.xml"
/>
</wadl:doc>
</representation>
</response>
<!-- Common, GET, POST/PUT, inProgress Faults-->
&commonFaults; &getFaults; &postPutFaults; &inProgressFault; </method>
<method name="PUT" id="setImageMetadataItem">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create or update image metadata item">
<para role="shortdesc">Creates or updates a metadata item
by key for a specified image.</para>
<para>An overLimit (<errorcode>413</errorcode>) fault <para>An overLimit (<errorcode>413</errorcode>) fault
might be thrown if the operation causes the quota for might be thrown if the operation causes the quota for
metadata items to be exceeded.</para> metadata items to be exceeded.</para>
@ -1491,11 +1759,20 @@
</response> </response>
<!-- Common, GET, POST/PUT, inProgress Faults--> <!-- Common, GET, POST/PUT, inProgress Faults-->
&commonFaults; &getFaults; &postPutFaults; &inProgressFault; </method> &commonFaults; &getFaults; &postPutFaults; &inProgressFault; </method>
<method name="DELETE" id="deleteMetadataItem"> <method name="DELETE" id="deleteServerMetadataItem">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete metadata item"> title="Delete server metadata item">
<para role="shortdesc">Deletes a metadata item by key for <para role="shortdesc">Deletes a metadata item by key for
the specified resource.</para> a specified server.</para>
</wadl:doc>
<response status="204"/>
<!-- Common, GET, inProgress Faults--> &commonFaults;
&getFaults; &inProgressFault; </method>
<method name="DELETE" id="deleteImageMetadataItem">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete image metadata item">
<para role="shortdesc">Deletes a metadata item by key for
a specified image.</para>
</wadl:doc> </wadl:doc>
<response status="204"/> <response status="204"/>
<!-- Common, GET, inProgress Faults--> &commonFaults; <!-- Common, GET, inProgress Faults--> &commonFaults;

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

@ -81,7 +81,6 @@
<response status="202"/> <response status="202"/>
</method> </method>
<method name="POST" id="livemigrate"> <method name="POST" id="livemigrate">
<wadl:doc xml:lang="EN" title="Live migrate to new host" <wadl:doc xml:lang="EN" title="Live migrate to new host"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
@ -107,7 +106,6 @@
<response status="202"/> <response status="202"/>
</method> </method>
<method name="POST" id="lockserver"> <method name="POST" id="lockserver">
<wadl:doc xml:lang="EN" title="Lock server" <wadl:doc xml:lang="EN" title="Lock server"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
@ -207,7 +205,6 @@
<response status="202"/> <response status="202"/>
</method> </method>
<method name="POST" id="resetserver"> <method name="POST" id="resetserver">
<wadl:doc xml:lang="EN" title="Reset server state" <wadl:doc xml:lang="EN" title="Reset server state"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
@ -233,7 +230,6 @@
<response status="202"/> <response status="202"/>
</method> </method>
<method name="POST" id="resumeserver"> <method name="POST" id="resumeserver">
<wadl:doc xml:lang="EN" title="Resume server" <wadl:doc xml:lang="EN" title="Resume server"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
@ -259,7 +255,6 @@
<response status="202"/> <response status="202"/>
</method> </method>
<method name="POST" id="suspendserver"> <method name="POST" id="suspendserver">
<wadl:doc xml:lang="EN" title="Suspend server" <wadl:doc xml:lang="EN" title="Suspend server"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">

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

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

0
api-ref/src/wadls/compute-api/src/v3/wadl/os-cell.wadl → api-ref/src/wadls/compute-api/src/v3/wadl/os-cells-v3.wadl
View File

0
api-ref/src/wadls/compute-api/src/v3/wadl/os-certificate.wadl → api-ref/src/wadls/compute-api/src/v3/wadl/os-certificates-v3.wadl
View File

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

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

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

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

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

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

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

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

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

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

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

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

82
api-ref/src/wadls/compute-api/src/v3/wadl/os-hypervisors.wadl → api-ref/src/wadls/compute-api/src/v3/wadl/os-hypervisors-v3.wadl
View File

@ -14,7 +14,17 @@
<resource id="statistics" path="statistics"> <resource id="statistics" path="statistics">
<method href="#showhypervisorstatistics"/> <method href="#showhypervisorstatistics"/>
</resource> </resource>
<resource id="filter" path="search?query={filter}"> <resource id="search" path="search">
<param name="query" style="query"
type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Filters the search
results by the specified
<code>?query={filter}</code> query
parameter.</para>
</wadl:doc>
</param>
<method href="#searchhypervisors"/> <method href="#searchhypervisors"/>
</resource> </resource>
<resource id="hypervisor_id" path="{hypervisor_id}"> <resource id="hypervisor_id" path="{hypervisor_id}">
@ -40,18 +50,20 @@
<request> </request> <request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-hypervisors/hypervisors-list-resp.json" href="../api_samples/os-hypervisors/hypervisors-list-resp.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-hypervisors/hypervisors-list-resp.xml" href="../api_samples/os-hypervisors/hypervisors-list-resp.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>
@ -64,18 +76,20 @@
<request> </request> <request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-hypervisors/hypervisors-search-resp.json" href="../api_samples/os-hypervisors/hypervisors-search-resp.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-hypervisors/hypervisors-search-resp.xml" href="../api_samples/os-hypervisors/hypervisors-search-resp.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>
@ -87,34 +101,38 @@
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-hypervisors/hypervisors-servers-resp.json" href="../api_samples/os-hypervisors/hypervisors-servers-resp.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-hypervisors/hypervisors-servers-resp.xml" href="../api_samples/os-hypervisors/hypervisors-servers-resp.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-hypervisors/hypervisors-list-resp.json" href="../api_samples/os-hypervisors/hypervisors-list-resp.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-hypervisors/hypervisors-list-resp.xml" href="../api_samples/os-hypervisors/hypervisors-list-resp.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>
@ -127,18 +145,20 @@
<request> </request> <request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-hypervisors/hypervisors-show-resp.json" href="../api_samples/os-hypervisors/hypervisors-show-resp.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-hypervisors/hypervisors-show-resp.xml" href="../api_samples/os-hypervisors/hypervisors-show-resp.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>
@ -151,18 +171,20 @@
<request> </request> <request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-hypervisors/hypervisors-statistics-resp.json" href="../api_samples/os-hypervisors/hypervisors-statistics-resp.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-hypervisors/hypervisors-statistics-resp.xml" href="../api_samples/os-hypervisors/hypervisors-statistics-resp.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>
@ -175,18 +197,20 @@
<request> </request> <request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-hypervisors/hypervisors-uptime-resp.json" href="../api_samples/os-hypervisors/hypervisors-uptime-resp.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-hypervisors/hypervisors-uptime-resp.xml" href="../api_samples/os-hypervisors/hypervisors-uptime-resp.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>

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

31
api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-usage-audit-log.wadl → api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-usage-audit-log-v3.wadl
View File

@ -12,7 +12,14 @@
<resource id="os-instance-usage-audit-log" <resource id="os-instance-usage-audit-log"
path="os-instance-usage-audit-log"> path="os-instance-usage-audit-log">
<method href="#listusageaudits"/> <method href="#listusageaudits"/>
<resource id="datetime" path="​{datetime}​"> <resource id="datetime" path="{datetime}">
<param name="datetime" style="template"
type="xsd:string">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para>The date and time stamp.</para>
</wadl:doc>
</param>
<method href="#listinstanceusage"/> <method href="#listinstanceusage"/>
</resource> </resource>
</resource> </resource>
@ -27,21 +34,22 @@
<para role="shortdesc">Lists usage audits for a specified <para role="shortdesc">Lists usage audits for a specified
instance.</para> instance.</para>
</wadl:doc> </wadl:doc>
<request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code <xsdxt:code
href="../api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-get-resp.json" href="../api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-get-resp.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code <xsdxt:code
href="../api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-get-resp.xml" href="../api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-get-resp.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>
@ -51,21 +59,22 @@
<para role="shortdesc">Lists instance usage audits that <para role="shortdesc">Lists instance usage audits that
occurred before a specified time.</para> occurred before a specified time.</para>
</wadl:doc> </wadl:doc>
<request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code <xsdxt:code
href="../api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-with-before-get-resp.json" href="../api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-with-before-get-resp.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code <xsdxt:code
href="../api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-with-before-get-resp.xml" href="../api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-with-before-get-resp.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>

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

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

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

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

118
api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-sets.wadl → api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-sets-v3.wadl
View File

@ -18,8 +18,19 @@
<resource id="defaults" path="defaults"> <resource id="defaults" path="defaults">
<method href="#showdefaultquotas"/> <method href="#showdefaultquotas"/>
</resource> </resource>
<resource id="user_id" <resource id="user_id">
path="{tenant_id}?user_id={user_id}"> <param
xmlns="http://wadl.dev.java.net/2009/02"
name="user_id" style="query"
required="false" type="xsd:string">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Specify the user
in the
<code>?user_id={user_id}</code>
query parameter.</para>
</wadl:doc>
</param>
<method href="#updatesquotauser"/> <method href="#updatesquotauser"/>
<method href="#deletequotauser"/> <method href="#deletequotauser"/>
</resource> </resource>
@ -35,29 +46,30 @@
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Deletes a quota for tenant.</para> <para role="shortdesc">Deletes a quota for tenant.</para>
</wadl:doc> </wadl:doc>
<request> </request>
<response status="204"/> <response status="204"/>
</method> </method>
<method name="GET" id="showdefaultquotas"> <method name="GET" id="showdefaultquotas">
<wadl:doc xml:lang="EN" title="Show default quotas" <wadl:doc xml:lang="EN" title="Show default quotas"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows default quotas for tenant.</para> <para role="shortdesc">Shows default quotas for
tenant.</para>
</wadl:doc> </wadl:doc>
<request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-show-defaults-get-resp.json" href="../api_samples/os-quota-sets/quotas-show-defaults-get-resp.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-show-defaults-get-resp.xml" href="../api_samples/os-quota-sets/quotas-show-defaults-get-resp.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>
@ -66,59 +78,65 @@
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows quotas for tenant.</para> <para role="shortdesc">Shows quotas for tenant.</para>
</wadl:doc> </wadl:doc>
<request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-show-get-resp.json" href="../api_samples/os-quota-sets/quotas-show-get-resp.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-show-get-resp.xml" href="../api_samples/os-quota-sets/quotas-show-get-resp.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>
<method name="PUT" id="forceupdatequota"> <method name="PUT" id="forceupdatequota">
<wadl:doc xml:lang="EN" title="Force-update quota" <wadl:doc xml:lang="EN" title="Force-update quota"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Force-updates quota for tenant.</para> <para role="shortdesc">Force-updates quota for
tenant.</para>
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-update-force-post-req.json" href="../api_samples/os-quota-sets/quotas-update-force-post-req.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-update-force-post-req.xml" href="../api_samples/os-quota-sets/quotas-update-force-post-req.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-update-force-post-resp.json" href="../api_samples/os-quota-sets/quotas-update-force-post-resp.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-update-force-post-resp.xml" href="../api_samples/os-quota-sets/quotas-update-force-post-resp.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>
@ -129,41 +147,46 @@
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-update-post-req.json" href="../api_samples/os-quota-sets/quotas-update-post-req.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-update-post-req.xml" href="../api_samples/os-quota-sets/quotas-update-post-req.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-update-post-resp.json" href="../api_samples/os-quota-sets/quotas-update-post-resp.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/quotas-update-post-req.xml" href="../api_samples/os-quota-sets/quotas-update-post-req.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>
<method name="DELETE" id="deletequotauser"> <method name="DELETE" id="deletequotauser">
<wadl:doc xml:lang="EN" title="Delete quota for user" <wadl:doc xml:lang="EN" title="Delete quota for user"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Deletes quota for user.</para> <para role="shortdesc">Deletes quota for a specified
user.</para>
</wadl:doc> </wadl:doc>
<response status="204"/> <response status="204"/>
</method> </method>
@ -172,21 +195,22 @@
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Shows quota for user.</para> <para role="shortdesc">Shows quota for user.</para>
</wadl:doc> </wadl:doc>
<request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/user-quotas-show-get-resp.json" href="../api_samples/os-quota-sets/user-quotas-show-get-resp.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/user-quotas-show-get-resp.xml" href="../api_samples/os-quota-sets/user-quotas-show-get-resp.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>
@ -197,34 +221,38 @@
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/user-quotas-update-post-req.json" href="../api_samples/os-quota-sets/user-quotas-update-post-req.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/user-quotas-update-post-req.xml" href="../api_samples/os-quota-sets/user-quotas-update-post-req.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</request> </request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/user-quotas-update-post-resp.json" href="../api_samples/os-quota-sets/user-quotas-update-post-resp.json"
/> />
</doc> </wadl:doc>
</representation> </representation>
<representation mediaType="application/xml"> <representation mediaType="application/xml">
<doc xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code <xsdxt:code
href="../api_samples/os-quota-sets/user-quotas-update-post-resp.xml" href="../api_samples/os-quota-sets/user-quotas-update-post-resp.xml"
/> />
</doc> </wadl:doc>
</representation> </representation>
</response> </response>
</method> </method>

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

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

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

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

@ -711,8 +711,7 @@
<xsdxt:sample xmlns="http://docs.rackspace.com/api" <xsdxt:sample xmlns="http://docs.rackspace.com/api"
title="Tenants Request with Auth Token"> title="Tenants Request with Auth Token">
<xsdxt:code <xsdxt:code
href="../samples/tenants-request-JSON.txt" href="../samples/tenants-request-JSON.txt"/>
language="text"/>
</xsdxt:sample> </xsdxt:sample>
</xsdxt:samples> </xsdxt:samples>
</wadl:doc> </wadl:doc>

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

@ -38,7 +38,6 @@
<resource id="v3" path="v3"> <resource id="v3" path="v3">
<resource id="oauth1" path="OS-OAUTH1"> <resource id="oauth1" path="OS-OAUTH1">
<resource id="consumers" path="consumers"> <resource id="consumers" path="consumers">
<param name="description" style="plain" <param name="description" style="plain"
type="xsd:string" required="false"> type="xsd:string" required="false">
<wadl:doc xml:lang="EN" <wadl:doc xml:lang="EN"
@ -150,12 +149,12 @@
</param> </param>
<method href="#getUnauthorizeRequestToken"/> <method href="#getUnauthorizeRequestToken"/>
</resource> </resource>
<resource id="authorize" path="authorize"> <!--<resource id="authorize" path="authorize">
<resource id="request_token_key" <resource id="request_token_key"
path="{request_token_key)"> path="{request_token_key)">
<method href="#authorizeRequestToken"/> <method href="#authorizeRequestToken"/>
</resource> </resource>
</resource> </resource>-->
<resource id="access_token" path="access_token"> <resource id="access_token" path="access_token">
<param name="oauth_consumer_key" style="plain" <param name="oauth_consumer_key" style="plain"
type="xsd:string" required="true"> type="xsd:string" required="true">
@ -280,7 +279,6 @@
</resource> </resource>
</resource> </resource>
</resource> </resource>
<resource id="auth" path="auth"> <resource id="auth" path="auth">
<resource id="tokens" path="tokens"> <resource id="tokens" path="tokens">
<param name="oauth_consumer_key" style="plain" <param name="oauth_consumer_key" style="plain"
@ -626,7 +624,7 @@
</representation> </representation>
</response> </response>
<response status="400"/> &commonFaults; </method> <response status="400"/> &commonFaults; </method>
<method name="PUT" id="authorizeRequestToken"> <!--<method name="PUT" id="authorizeRequestToken">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Authorize request token"> title="Authorize request token">
<para role="shortdesc">Enables a user to authorize a <para role="shortdesc">Enables a user to authorize a
@ -668,7 +666,7 @@
</wadl:doc> </wadl:doc>
</representation> </representation>
</response> </response>
<response status="400"/> &commonFaults; </method> <response status="400"/> &commonFaults; </method>-->
<method name="POST" id="createAccessToken"> <method name="POST" id="createAccessToken">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create access token"> title="Create access token">

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

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

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

9
doc-test.conf
View File

@ -18,3 +18,12 @@ target_dir = target/docbkx/html
# Published at api.openstack.org/ but Jenkins will # Published at api.openstack.org/ but Jenkins will
# copy directory api-ref. # copy directory api-ref.
publish_dir = api-ref publish_dir = api-ref
## API-Ref-Guides
book = api-ref-guides
target_dir = target/docbkx/pdf/
# Published at api.openstack.org/ but Jenkins will
# copy directory api-ref.
# Note: The tox.ini file needs to move this to the proper places since
# the publish_dirs have to be different!
publish_dir = api-ref-guides

1
pom.xml
View File

@ -12,6 +12,7 @@
<module>api-quick-start</module> <module>api-quick-start</module>
<module>api-guide</module> <module>api-guide</module>
<module>api-ref</module> <module>api-ref</module>
<module>api-ref-guides</module>
<!-- <module>api-ref-books</module>--> <!-- <module>api-ref-books</module>-->
</modules> </modules>
<profiles> <profiles>

8
tox.ini
View File

@ -31,4 +31,10 @@ commands = openstack-doc-test --check-build --nocreate-index --only-book api-qui
[testenv:publishdocs-api] [testenv:publishdocs-api]
# Prepare documents (without www) so that they can get published on # Prepare documents (without www) so that they can get published on
# api.openstack.org with just copying publish-docs/* over. # api.openstack.org with just copying publish-docs/* over.
commands = openstack-doc-test --check-build --nocreate-index --only-book api-ref commands =
openstack-doc-test --check-build --nocreate-index --only-book api-ref
# TODO(jaegerandi,dfleming): Add "--only-book api-ref-guides"
# We need to move api-ref-guides to the proper place
# TODO(jaegerandi,dfleming): Uncomment once we're sure this is the proper
# place:
# mv publish-docs/api-ref-guides publish-docs/api-ref/