Merge "Clean up WADL and XML files in prep for generating PDFs on api-site"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
4d991d5e75
@ -26,7 +26,7 @@
|
||||
<artifactId>clouddocs-maven-plugin</artifactId>
|
||||
<!-- version is set in ../pom.xml file -->
|
||||
<executions>
|
||||
<!-- Configuration for OpenStack End User Guide -->
|
||||
<!-- Configuration for OpenStack API Guide -->
|
||||
<execution>
|
||||
<id>os-api-guide</id>
|
||||
<goals>
|
||||
|
||||
180
api-ref-guides/pom.xml
Normal file
180
api-ref-guides/pom.xml
Normal 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>
|
||||
@ -33,7 +33,7 @@
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<year>2010-2014</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Block Storage</productname>
|
||||
@ -45,6 +45,6 @@
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_blockstorage-api.xml"/>
|
||||
<!-- <xi:include href="preface.xml"/>-->
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_blockstorage-api.xml"/>
|
||||
</book>
|
||||
@ -32,7 +32,7 @@
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_compute-v2-ext.xml"/>
|
||||
<!-- <xi:include href="preface.xml"/>-->
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_compute-v2-ext.xml"/>
|
||||
</book>
|
||||
|
||||
@ -45,6 +45,6 @@
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_compute-v2.xml"/>
|
||||
<!-- <xi:include href="preface.xml"/>-->
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_compute-v2.xml"/>
|
||||
</book>
|
||||
@ -8,8 +8,8 @@
|
||||
version="5.0-extension RackBook-2.0" status="EXPERIMENTAL"
|
||||
xml:id="api.openstack.org-compute-v3-pdf">
|
||||
<info>
|
||||
<title>OpenStack Compute API v2 Reference</title>
|
||||
<titleabbrev>API Reference</titleabbrev>
|
||||
<title>OpenStack Compute API v3 Reference (EXPERIMENTAL)</title>
|
||||
<titleabbrev>API Reference (EXPERIMENTAL)</titleabbrev>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname/>
|
||||
@ -32,6 +32,6 @@
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_compute-v3.xml"/>
|
||||
<!-- <xi:include href="preface.xml"/>-->
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_compute-v3.xml"/>
|
||||
</book>
|
||||
@ -32,7 +32,7 @@
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<year>2010-2014</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Identity</productname>
|
||||
@ -44,10 +44,10 @@
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.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="preface.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"/>
|
||||
</book>
|
||||
@ -20,7 +20,7 @@
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<year>2010-2014</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Image Service</productname>
|
||||
@ -32,7 +32,7 @@
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_images-v2.xml"/>
|
||||
<xi:include href="ch_images-v1.xml"/>
|
||||
<!-- <xi:include href="preface.xml"/>-->
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_images-v2.xml"/>
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_images-v1.xml"/>
|
||||
</book>
|
||||
@ -23,7 +23,7 @@
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<year>2010-2014</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Networking</productname>
|
||||
@ -35,7 +35,7 @@
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_netconn-v2.xml"/>
|
||||
<xi:include href="ch_netconn-ext-v2.xml"/>
|
||||
<!-- <xi:include href="preface.xml"/>-->
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_netconn-v2.xml"/>
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_netconn-ext-v2.xml"/>
|
||||
</book>
|
||||
@ -20,7 +20,7 @@
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<year>2010-2014</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Object Storage</productname>
|
||||
@ -32,6 +32,6 @@
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_objectstorage-v1.xml"/>
|
||||
<!-- <xi:include href="preface.xml"/>-->
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_objectstorage-v1.xml"/>
|
||||
</book>
|
||||
@ -20,7 +20,7 @@
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<year>2010-2014</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Orchestration</productname>
|
||||
@ -32,6 +32,6 @@
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_orchestration-v1.xml"/>
|
||||
<!-- <xi:include href="preface.xml"/>-->
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_orchestration-v1.xml"/>
|
||||
</book>
|
||||
@ -20,7 +20,7 @@
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2010-2013</year>
|
||||
<year>2010-2014</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<productname>OpenStack Metering</productname>
|
||||
@ -32,6 +32,6 @@
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<xi:include href="ch_telemetry-v2.xml"/>
|
||||
<!-- <xi:include href="preface.xml"/>-->
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_telemetry-v2.xml"/>
|
||||
</book>
|
||||
52
api-ref-guides/src/bk-api-ref.xml
Normal file
52
api-ref-guides/src/bk-api-ref.xml
Normal 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
29
api-ref-guides/src/preface.xml
Normal file
@ -0,0 +1,29 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE preface[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY nbsp " ">
|
||||
]>
|
||||
<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> </para>
|
||||
</preface>
|
||||
122
api-ref/pom.xml
122
api-ref/pom.xml
@ -46,127 +46,7 @@
|
||||
</configuration>
|
||||
</execution>
|
||||
<!-- Configuration for OpenStack API References (pdf) -->
|
||||
<!--<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>
|
||||
</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>-->
|
||||
<!-- see ../api-ref-guides/pom.xml -->
|
||||
</executions>
|
||||
<configuration>
|
||||
<!-- These parameters apply to pdf and webhelp -->
|
||||
|
||||
@ -16,6 +16,6 @@
|
||||
<para/>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
<!-- <xi:include href="preface.xml"/>-->
|
||||
<xi:include href="ch_compute-v2-ext.xml"/>
|
||||
</book>
|
||||
|
||||
@ -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>
|
||||
@ -5,7 +5,7 @@
|
||||
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="blockstorage-v2">
|
||||
version="5.0-extension RackBook-2.0" xml:id="blockstorage-v2" role="api-reference">
|
||||
<title>Block Storage API v2.0</title>
|
||||
<para>Manage volumes and snapshots for use with the Block Storage
|
||||
API, also known as cinder services.</para>
|
||||
@ -13,16 +13,16 @@
|
||||
<title>Volumes</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<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="#getVolumesSimple"/>
|
||||
</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: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="#updateVolume"/>
|
||||
<wadl:method href="#deleteVolume"/>
|
||||
@ -33,11 +33,11 @@
|
||||
<title>Volume types</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<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: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:resource>
|
||||
</wadl:resources>
|
||||
@ -46,16 +46,16 @@
|
||||
<title>Snapshots</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<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="#getSnapshotsSimple"/>
|
||||
</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: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="#updateSnapshot"/>
|
||||
<wadl:method href="#deleteSnapshot"/>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
xmlns:linkend="http://www.w3.org/1999/linkend"
|
||||
xmlns:xref="http://www.w3.org/1999/xref"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
version="5.0-extension RackBook-2.0" xml:id="compute-ext-v2">
|
||||
version="5.0-extension RackBook-2.0" xml:id="compute-ext-v2" role="api-reference">
|
||||
<title>Compute API v2 extensions</title>
|
||||
<para>Extensions add features, MIME types, actions, states,
|
||||
headers, parameters, and resources to the core Compute API.
|
||||
@ -239,9 +239,28 @@
|
||||
<para>Display extra statistical information from the machine
|
||||
that hosts the hypervisor through the API for the
|
||||
hypervisor (XenAPI or KVM/libvirt).</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/v2/ext/os-hypervisors.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/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 xml:id="ext-os-instance-actions">
|
||||
<title>Server actions (os-instance-actions)</title>
|
||||
@ -415,7 +434,8 @@
|
||||
images)</title>
|
||||
<para>Extend servers with the diskConfig attribute.</para>
|
||||
<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 xml:id="ext-os-ext-ips">
|
||||
<title>Server IP type (servers)</title>
|
||||
|
||||
@ -5,8 +5,8 @@
|
||||
xmlns:linkend="http://www.w3.org/1999/linkend"
|
||||
xmlns:xref="http://www.w3.org/1999/xref"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
version="5.0-extension RackBook-2.0" xml:id="compute-core-v2">
|
||||
<title>Compute API v2</title>
|
||||
version="5.0-extension RackBook-2.0" xml:id="compute-core-v2" role="api-reference">
|
||||
<title>Compute API v2</title>
|
||||
<para>Launch virtual machines from images or images stored on
|
||||
persistent volumes. API v1.1 is identical to API v2.</para>
|
||||
<section xml:id="compute_versions">
|
||||
@ -65,27 +65,26 @@
|
||||
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#server_id">
|
||||
<wadl:method href="#getServer"/>
|
||||
<wadl:method href="#updateServer"/>
|
||||
<wadl:method href="#deleteerver"/>
|
||||
<wadl:method href="#deleteServer"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="compute_server_metadata">
|
||||
<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>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#metadata">
|
||||
<!-- Metadata -->
|
||||
<wadl:method href="#listMetadata"/>
|
||||
<wadl:method href="#updateMetadata"/>
|
||||
<wadl:method href="#setMetadata"/>
|
||||
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#server_metadata">
|
||||
<wadl:method href="#showServerMetadata"/>
|
||||
<wadl:method href="#createServerMetadata"/>
|
||||
<wadl:method href="#updateServerMetadata"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#MetadataKey">
|
||||
<wadl:method href="#getMetadataItem"/>
|
||||
<wadl:method href="#setMetadataItem"/>
|
||||
<wadl:method href="#deleteMetadataItem"/>
|
||||
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#ServerMetadataKey">
|
||||
<wadl:method href="#getServerMetadataItem"/>
|
||||
<wadl:method href="#setServerMetadataItem"/>
|
||||
<wadl:method href="#deleteServerMetadataItem"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
@ -103,9 +102,9 @@
|
||||
</section>
|
||||
<section xml:id="compute_server-actions">
|
||||
<title>Server actions</title>
|
||||
<para>Perform actions for a specified server, including
|
||||
change administrator password, reboot, rebuild, resize,
|
||||
and create image from server.</para>
|
||||
<para>Perform actions for a specified server, including change
|
||||
administrator password, reboot, rebuild, resize, and
|
||||
create image from server.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#action">
|
||||
@ -169,21 +168,20 @@
|
||||
</section>
|
||||
<section xml:id="compute_image_metadata">
|
||||
<title>Image metadata</title>
|
||||
<para>Set, list, get details for, and delete image
|
||||
metadata or metadata items.</para>
|
||||
<para>Show details for, set, update, and delete image metadata
|
||||
or metadata items.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#image_metadata">
|
||||
<!-- Metadata -->
|
||||
<wadl:method href="#listMetadata"/>
|
||||
<wadl:method href="#updateMetadata"/>
|
||||
<wadl:method href="#setMetadata"/>
|
||||
<wadl:method href="#showImageMetadata"/>
|
||||
<wadl:method href="#createImageMetadata"/>
|
||||
<wadl:method href="#updateImageMetadata"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#imageMetadataKey">
|
||||
<wadl:method href="#getMetadataItem"/>
|
||||
<wadl:method href="#setMetadataItem"/>
|
||||
<wadl:method href="#deleteMetadataItem"/>
|
||||
<wadl:method href="#getImageMetadataItem"/>
|
||||
<wadl:method href="#setImageMetadataItem"/>
|
||||
<wadl:method href="#deleteImageMetadataItem"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
|
||||
@ -18,16 +18,37 @@
|
||||
xmlns:linkend="http://www.w3.org/1999/linkend"
|
||||
xmlns:xref="http://www.w3.org/1999/xref"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
version="5.0-extension RackBook-2.0" xml:id="compute-ext-v3">
|
||||
version="5.0-extension RackBook-2.0" xml:id="compute-ext-v3" role="api-reference">
|
||||
<title>Compute API v3 (EXPERIMENTAL)</title>
|
||||
<para>Query the Compute API to list available extensions with a
|
||||
&GET; request to <code>v3/extensions</code>.</para>
|
||||
<section xml:id="v3server">
|
||||
<title>Server admin actions</title>
|
||||
<para>Permits administrators to perform actions on a server.
|
||||
Specify the action in the request body.</para>
|
||||
<title>Server admin actions (servers)</title>
|
||||
<para>Administrators only. Perform actions on a server. Specify
|
||||
the action in the request body.</para>
|
||||
<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"/>
|
||||
</section>
|
||||
<section xml:id="v3cell">
|
||||
@ -36,29 +57,36 @@
|
||||
cells, listing neighbor cells, and getting the capabilities of
|
||||
the local cell.</para>
|
||||
<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"/>
|
||||
</section>
|
||||
<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
|
||||
user.</para>
|
||||
<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"/>
|
||||
</section>
|
||||
<section xml:id="v3deferredelete">
|
||||
<title>Server deferred delete (os-deferred-delete)</title>
|
||||
<para>Force-deletes a server or restores a deleted server.</para>
|
||||
<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"/>
|
||||
</section>
|
||||
<section xml:id="v3evaculation">
|
||||
<title>Evacuate (os-evacuate)</title>
|
||||
<para>Enables server evacuation.</para>
|
||||
<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"/>
|
||||
</section>
|
||||
<section xml:id="v3availzone">
|
||||
@ -68,7 +96,7 @@
|
||||
(nova-compute). Internal services appear in their own internal
|
||||
availability zone.</para>
|
||||
<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"/>
|
||||
</section>
|
||||
<section xml:id="v3extendattributes">
|
||||
@ -76,7 +104,7 @@
|
||||
(os-extended-server-attributes)</title>
|
||||
<para>Shows metadata for servers.</para>
|
||||
<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"/>
|
||||
</section>
|
||||
<section xml:id="v3extendedstatus">
|
||||
@ -84,21 +112,14 @@
|
||||
<para>Shows extended status information, vm_state, task_state, and
|
||||
power_state, in detailed server responses.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/v3/wadl/os-extended-status.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"
|
||||
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="v3flavoraccess">
|
||||
<title>Flavor access (os-flavor-access)</title>
|
||||
<para>Flavor access support.</para>
|
||||
<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"/>
|
||||
</section>
|
||||
<section xml:id="v3flavorspecs">
|
||||
@ -106,7 +127,14 @@
|
||||
<para>Lists, creates, deletes, and updates the extra-specs or keys
|
||||
for a flavor.</para>
|
||||
<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"/>
|
||||
</section>
|
||||
<section xml:id="v3flavortxtx">
|
||||
@ -114,63 +142,21 @@
|
||||
(os-flavor-rxtx)</title>
|
||||
<para>Support to show the rxtx status of a flavor.</para>
|
||||
<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"/>
|
||||
</section>
|
||||
<section xml:id="v3flavorextend">
|
||||
<title>Flavors with extended attributes (flavors)</title>
|
||||
<para>Returns information about Flavors.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/v3/wadl/flavors.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"
|
||||
href="../wadls/compute-api/src/v3/wadl/os-flavors-v3.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="v3hosts">
|
||||
<title>Hosts (os-hosts)</title>
|
||||
<para>Manages physical hosts.</para>
|
||||
<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"/>
|
||||
</section>
|
||||
<section xml:id="v3hypervisors">
|
||||
@ -179,23 +165,52 @@
|
||||
hosts the hypervisor through the API for the hypervisor (XenAPI
|
||||
or KVM/libvirt).</para>
|
||||
<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"/>
|
||||
</section>
|
||||
<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
|
||||
server. Permits administrators to get details for a specified
|
||||
action for a specified server.</para>
|
||||
<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"/>
|
||||
</section>
|
||||
<section xml:id="v3migrations">
|
||||
<title>Migrations (os-migrations)</title>
|
||||
<para>Provide data on migrations.</para>
|
||||
<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"/>
|
||||
</section>
|
||||
<section xml:id="v3quotasets">
|
||||
@ -204,43 +219,28 @@
|
||||
view quotas for a tenant and view and update default
|
||||
quotas.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/v3/wadl/os-quota-sets.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"
|
||||
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="v3remoteconsole">
|
||||
<title>Server remote console (os-remote-consoles)</title>
|
||||
<para>Interactive Console support.</para>
|
||||
<para>Interactive console support.</para>
|
||||
<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"/>
|
||||
</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>
|
||||
<section xml:id="os-server-usage-v3">
|
||||
<title>Server usage (os-server-usage)</title>
|
||||
<para>Adds launched_at and terminated_at to servers.</para>
|
||||
<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"/>
|
||||
</section>
|
||||
<section xml:id="v3simpletenant">
|
||||
<title>Usage reports (os-simple-tenant-usage)</title>
|
||||
<para>Provide simple tenant usage for tenant.</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/v3/wadl/os-simple-tenant-usage.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"
|
||||
href="../wadls/compute-api/src/v3/wadl/os-simple-tenant-usage-v3.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
</chapter>
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
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="identity-admin-v2"
|
||||
xlink:href="#identity-admin-v2">
|
||||
xlink:href="#identity-admin-v2" role="api-reference">
|
||||
<title>Identity admin API v2.0</title>
|
||||
<para>Get an authentication token that permits access to the
|
||||
Compute API.</para>
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
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="identity-v2-ext"
|
||||
xlink:href="#identity-v2-ext">
|
||||
xlink:href="#identity-v2-ext" role="api-reference">
|
||||
<title>Identity API v2.0 extensions</title>
|
||||
<para>Query the Identity API to list available extensions
|
||||
with a &GET; request to <code>v2.0/extensions</code>.</para>
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
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="identity-v3-ext"
|
||||
xlink:href="#identity-v3-ext">
|
||||
xlink:href="#identity-v3-ext" role="api-reference">
|
||||
<title>Identity API v3 extensions</title>
|
||||
<para>Query the Identity API to list available extensions
|
||||
with a &GET; request to <code>v3/extensions</code>.</para>
|
||||
@ -62,5 +62,8 @@
|
||||
Identity API token.</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
<wadl:resources
|
||||
href="../wadls/identity-api/src/v3/wadl/OS-OAUTH1-v3.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
</chapter>
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
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="identity-v3"
|
||||
xlink:href="#identity-v3">
|
||||
xlink:href="#identity-v3" role="api-reference">
|
||||
<title>Identity API v3</title>
|
||||
<para>Get an authentication token that permits access to the
|
||||
Compute API.</para>
|
||||
@ -15,7 +15,7 @@
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- list version -->
|
||||
<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>
|
||||
</section>
|
||||
@ -26,7 +26,7 @@
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- authenticate token -->
|
||||
<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>
|
||||
</section>
|
||||
@ -38,9 +38,9 @@
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create service -->
|
||||
<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
|
||||
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>
|
||||
</section>
|
||||
@ -51,9 +51,9 @@
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create endpoint -->
|
||||
<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
|
||||
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>
|
||||
</section>
|
||||
@ -96,17 +96,17 @@
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create domain -->
|
||||
<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
|
||||
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
|
||||
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
|
||||
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
|
||||
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
|
||||
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>
|
||||
</section>
|
||||
@ -117,23 +117,23 @@
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create project -->
|
||||
<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 -->
|
||||
<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 -->
|
||||
<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 -->
|
||||
<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 -->
|
||||
<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
|
||||
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
|
||||
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>
|
||||
</section>
|
||||
@ -144,15 +144,15 @@
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create user -->
|
||||
<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
|
||||
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
|
||||
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
|
||||
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
|
||||
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>
|
||||
</section>
|
||||
@ -163,16 +163,16 @@
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create group -->
|
||||
<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 -->
|
||||
<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 -->
|
||||
<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 -->
|
||||
<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>
|
||||
</section>
|
||||
@ -183,9 +183,9 @@
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create credential -->
|
||||
<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
|
||||
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>
|
||||
</section>
|
||||
@ -196,11 +196,11 @@
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create role -->
|
||||
<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
|
||||
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
|
||||
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>
|
||||
</section>
|
||||
@ -211,9 +211,9 @@
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<!-- create policy -->
|
||||
<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
|
||||
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>
|
||||
</section>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
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="image-v1">
|
||||
version="5.0-extension RackBook-2.0" xml:id="image-v1" role="api-reference">
|
||||
<title>Image Service API v1</title>
|
||||
<para>Load images for use at launch time by the Compute API. Also,
|
||||
assign metadata to images.</para>
|
||||
|
||||
@ -13,15 +13,16 @@
|
||||
<title>OpenStack API Complete Reference</title>
|
||||
<para>Use the OpenStack APIs and extensions in your OpenStack
|
||||
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
|
||||
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="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> </para>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
|
||||
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
@ -7,7 +7,7 @@
|
||||
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
xml:id="os-hypervisors-v2">
|
||||
<resource id="version" path="v2/">
|
||||
<resource id="version" path="v2">
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="xsd:string">
|
||||
|
||||
@ -25,7 +25,7 @@
|
||||
<!--*******************************************************-->
|
||||
<resources base="https://servers.api.openstack.com"
|
||||
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}">
|
||||
<param name="tenant_id" style="template"
|
||||
type="csapi:UUID">
|
||||
@ -37,7 +37,9 @@
|
||||
<resource id="extensions" type="#ExtensionList"
|
||||
path="extensions">
|
||||
<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">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
@ -59,24 +61,50 @@
|
||||
<resource id="server_detail" path="detail"
|
||||
type="#DetailServerList"/>
|
||||
<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">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The server
|
||||
ID.</para>
|
||||
xml:lang="EN"><para>The UUID for the
|
||||
server.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getServer"/>
|
||||
<method href="#updateServer"/>
|
||||
<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"
|
||||
type="#Addresses">
|
||||
<!-- <method href="#getServerAddresses"/> -->
|
||||
<resource id="network_label"
|
||||
path="{network_label}"
|
||||
type="#NetworkAddressList">
|
||||
<param name="network_label"
|
||||
<param
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="network_label"
|
||||
style="template" type="xsd:string">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
@ -89,35 +117,6 @@
|
||||
<!--<method href="#getNetworkAddresses"/>-->
|
||||
</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">
|
||||
<method href="#changePassword"/>
|
||||
<method href="#rebootServer"/>
|
||||
@ -145,10 +144,12 @@
|
||||
<method href="#getImage"/>
|
||||
<method href="#deleteImage"/>
|
||||
<resource id="image_metadata" path="metadata"
|
||||
type="#Metadata #MetadataList">
|
||||
type="#ImageMetadataDetails">
|
||||
<resource id="imageMetadataKey" path="{key}">
|
||||
<param name="key" style="template"
|
||||
type="csapi:MetadataKey">
|
||||
<param
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="key" style="template"
|
||||
type="csapi:imageMetadataKey">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"
|
||||
@ -157,9 +158,9 @@
|
||||
255 characters.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getMetadataItem"/>
|
||||
<method href="#setMetadataItem"/>
|
||||
<method href="#deleteMetadataItem"/>
|
||||
<method href="#getImageMetadataItem"/>
|
||||
<method href="#setImageMetadataItem"/>
|
||||
<method href="#deleteImageMetadataItem"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -258,25 +259,27 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Flavor list">
|
||||
<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>
|
||||
<method href="#listFlavors"/>
|
||||
</resource_type>
|
||||
<resource_type id="Metadata">
|
||||
<resource_type id="ServerMetadataDetails">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Metadata">
|
||||
<para>Metadata resource type, this is used for images and
|
||||
servers.</para>
|
||||
title="Server metadata list">
|
||||
<para>Metadata details for a server.</para>
|
||||
</wadl:doc>
|
||||
<method href="#setMetadata"/>
|
||||
<method href="#updateMetadata"/>
|
||||
<method href="#showServerMetadata"/>
|
||||
<method href="#createServerMetadata"/>
|
||||
<method href="#updateServerMetadata"/>
|
||||
</resource_type>
|
||||
<resource_type id="MetadataList">
|
||||
<resource_type id="ImageMetadataDetails">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Metadata list">
|
||||
<para>A list of metadata.</para>
|
||||
title="Image metadata list">
|
||||
<para>Metadata details for an image.</para>
|
||||
</wadl:doc>
|
||||
<method href="#listMetadata"/>
|
||||
<method href="#showImageMetadata"/>
|
||||
<method href="#createImageMetadata"/>
|
||||
<method href="#updateImageMetadata"/>
|
||||
</resource_type>
|
||||
|
||||
<!--*******************************************************-->
|
||||
@ -351,15 +354,15 @@
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/common:extensions/atom:link[@rel='next']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Moves to the next item in the
|
||||
list.</para></wadl:doc>
|
||||
xml:lang="EN"><para>Moves to the next metadata
|
||||
item.</para></wadl:doc>
|
||||
<link resource_type="#ExtensionList" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/common:extensions/atom:link[@rel='previous']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Moves to the previous item in
|
||||
the list.</para></wadl:doc>
|
||||
xml:lang="EN"><para>Moves to the previous metadata
|
||||
item.</para></wadl:doc>
|
||||
<link resource_type="#ExtensionList" rel="previous"/>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
@ -473,15 +476,15 @@
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:servers/atom:link[@rel='next']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Moves to the next item in the
|
||||
list.</para></wadl:doc>
|
||||
xml:lang="EN"><para>Moves to the next metadata
|
||||
item.</para></wadl:doc>
|
||||
<link resource_type="#ServerList" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:servers/atom:link[@rel='previous']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Moves to the previous item in
|
||||
the list.</para></wadl:doc>
|
||||
xml:lang="EN"><para>Moves to the previous metadata
|
||||
item.</para></wadl:doc>
|
||||
<link resource_type="#ServerList" rel="previous"/>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
@ -518,15 +521,15 @@
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:servers/atom:link[@rel='next']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Moves to the next item in the
|
||||
list.</para></wadl:doc>
|
||||
xml:lang="EN"><para>Moves to the next metadata
|
||||
item.</para></wadl:doc>
|
||||
<link resource_type="#DetailServerList" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:servers/atom:link[@rel='previous']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Moves to the previous item in
|
||||
the list.</para></wadl:doc>
|
||||
xml:lang="EN"><para>Moves to the previous metadata
|
||||
item.</para></wadl:doc>
|
||||
<link resource_type="#DetailServerList" rel="previous"
|
||||
/>
|
||||
</param>
|
||||
@ -1024,15 +1027,15 @@
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:flavors/atom:link[@rel='next']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Moves to the next item in the
|
||||
list.</para></wadl:doc>
|
||||
xml:lang="EN"><para>Moves to the next metadata
|
||||
item.</para></wadl:doc>
|
||||
<link resource_type="#FlavorList" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:flavors/atom:link[@rel='previous']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Moves to the previous item in
|
||||
the list.</para></wadl:doc>
|
||||
xml:lang="EN"><para>Moves to the previous metadata
|
||||
item.</para></wadl:doc>
|
||||
<link resource_type="#FlavorList" rel="previous"/>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
@ -1063,15 +1066,15 @@
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:flavors/atom:link[@rel='next']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Moves to the next item in the
|
||||
list.</para></wadl:doc>
|
||||
xml:lang="EN"><para>Moves to the next metadata
|
||||
item.</para></wadl:doc>
|
||||
<link resource_type="#DetailFlavorList" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:flavors/atom:link[@rel='previous']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Moves to the previous item in
|
||||
the list.</para></wadl:doc>
|
||||
xml:lang="EN"><para>Moves to the previous metadata
|
||||
item.</para></wadl:doc>
|
||||
<link resource_type="#DetailFlavorList" rel="previous"
|
||||
/>
|
||||
</param>
|
||||
@ -1124,21 +1127,20 @@
|
||||
<para role="shortdesc">Lists all details for available
|
||||
images.</para>
|
||||
</wadl:doc>
|
||||
<request/>
|
||||
<!--&imageListParameters; </request> -->
|
||||
<request> &imageListParameters; </request>
|
||||
<response status="200 203">
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:images/atom:link[@rel='next']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Moves to the next item in the
|
||||
list.</para></wadl:doc>
|
||||
xml:lang="EN"><para>Moves to the next metadata
|
||||
item.</para></wadl:doc>
|
||||
<link resource_type="#DetailImageList" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:images/atom:link[@rel='previous']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Moves to the previous item in
|
||||
the list.</para></wadl:doc>
|
||||
xml:lang="EN"><para>Moves to the previous metadata
|
||||
item.</para></wadl:doc>
|
||||
<link resource_type="#DetailImageList" rel="previous"
|
||||
/>
|
||||
</param>
|
||||
@ -1167,8 +1169,7 @@
|
||||
<para role="shortdesc">Lists IDs, names, and links for
|
||||
available images.</para>
|
||||
</wadl:doc>
|
||||
<request/>
|
||||
<!--&imageListParameters; </request> -->
|
||||
<request> &imageListParameters; </request>
|
||||
<response status="200 203">
|
||||
<param name="images" style="plain" required="true"
|
||||
type="csapi:ImagesWithOnlyIDsNamesLinks"
|
||||
@ -1180,15 +1181,15 @@
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:images/atom:link[@rel='next']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Moves to the next item in the
|
||||
list.</para></wadl:doc>
|
||||
xml:lang="EN"><para>Moves to the next metadata
|
||||
item.</para></wadl:doc>
|
||||
<link resource_type="#ImageList" rel="next"/>
|
||||
</param>
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:images/atom:link[@rel='previous']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Moves to the previous item in
|
||||
the list.</para></wadl:doc>
|
||||
xml:lang="EN"><para>Moves to the previous metadata
|
||||
item.</para></wadl:doc>
|
||||
<link resource_type="#ImageList" rel="previous"/>
|
||||
</param>
|
||||
<representation mediaType="application/json">
|
||||
@ -1242,26 +1243,72 @@
|
||||
<response status="204"/>
|
||||
<!-- Common and GET Faults --> &commonFaults; &getFaults; </method>
|
||||
<!-- Metadata -->
|
||||
<method name="GET" id="listMetadata">
|
||||
<method name="GET" id="showServerMetadata">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List metadata">
|
||||
<para role="shortdesc">Lists metadata for the specified
|
||||
resource.</para>
|
||||
title="Show server metadata">
|
||||
<para role="shortdesc">Shows metadata for a specified
|
||||
server.</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 item in the
|
||||
list.</para></wadl:doc>
|
||||
<link resource_type="#MetadataList" rel="next"/>
|
||||
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 item in
|
||||
the list.</para></wadl:doc>
|
||||
<link resource_type="#MetadataList" rel="previous"/>
|
||||
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-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>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
@ -1283,11 +1330,80 @@
|
||||
</response>
|
||||
<!-- Common Faults and GET Faults--> &commonFaults;
|
||||
&getFaults; </method>
|
||||
<method name="POST" id="updateMetadata">
|
||||
<method name="POST" id="updateServerMetadata">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Update metadata items">
|
||||
<para role="shortdesc">Updates metadata items by key for
|
||||
the specified resource.</para>
|
||||
title="Update server metadata items">
|
||||
<para role="shortdesc">Updates metadata items by key for a
|
||||
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
|
||||
does not modify items not specified in the
|
||||
request.</para>
|
||||
@ -1318,16 +1434,18 @@
|
||||
<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 item in the
|
||||
list.</para></wadl:doc>
|
||||
<link resource_type="#MetadataList" rel="next"/>
|
||||
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 item in
|
||||
the list.</para></wadl:doc>
|
||||
<link resource_type="#MetadataList" rel="previous"/>
|
||||
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"
|
||||
@ -1349,17 +1467,18 @@
|
||||
</response>
|
||||
<!-- Common, GET, POST/PUT, inProgress Faults-->
|
||||
&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"
|
||||
title="Create or replace metadata">
|
||||
<para role="shortdesc">Sets metadata for the specified
|
||||
resource.</para>
|
||||
title="Create or replace server metadata">
|
||||
<para role="shortdesc">Creates or replaces metadata for a
|
||||
specified server.</para>
|
||||
<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>
|
||||
<para>If the number of metadata items exceeds the quota for metadata
|
||||
items, an overLimit (<errorcode>413</errorcode>) fault
|
||||
might be thrown.</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">
|
||||
@ -1384,16 +1503,18 @@
|
||||
<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 item in the
|
||||
list.</para></wadl:doc>
|
||||
<link resource_type="#MetadataList" rel="next"/>
|
||||
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 item in
|
||||
the list.</para></wadl:doc>
|
||||
<link resource_type="#MetadataList" rel="previous"/>
|
||||
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"
|
||||
@ -1415,11 +1536,108 @@
|
||||
</response>
|
||||
<!-- Common, GET, POST/PUT, inProgress Faults-->
|
||||
&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"
|
||||
title="Get metadata item">
|
||||
<para role="shortdesc">Gets a metadata item by key for the
|
||||
specified resource.</para>
|
||||
title="Create or replace image metadata">
|
||||
<para role="shortdesc">Creates or replaces metadata for a
|
||||
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>
|
||||
<response status="200 203">
|
||||
<representation mediaType="application/json">
|
||||
@ -1442,11 +1660,61 @@
|
||||
</response>
|
||||
<!-- Common Faults and GET Faults--> &commonFaults;
|
||||
&getFaults; </method>
|
||||
<method name="PUT" id="setMetadataItem">
|
||||
<method name="PUT" id="setServerMetadataItem">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create or update metadata item">
|
||||
<para role="shortdesc">Sets a metadata item by key for the
|
||||
specified resource.</para>
|
||||
title="Create or update server metadata item">
|
||||
<para role="shortdesc">Sets a metadata item by key for a
|
||||
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
|
||||
might be thrown if the operation causes the quota for
|
||||
metadata items to be exceeded.</para>
|
||||
@ -1491,11 +1759,20 @@
|
||||
</response>
|
||||
<!-- Common, GET, POST/PUT, inProgress Faults-->
|
||||
&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"
|
||||
title="Delete metadata item">
|
||||
title="Delete server metadata item">
|
||||
<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>
|
||||
<response status="204"/>
|
||||
<!-- Common, GET, inProgress Faults--> &commonFaults;
|
||||
|
||||
@ -81,7 +81,6 @@
|
||||
<response status="202"/>
|
||||
</method>
|
||||
|
||||
|
||||
<method name="POST" id="livemigrate">
|
||||
<wadl:doc xml:lang="EN" title="Live migrate to new host"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
@ -107,7 +106,6 @@
|
||||
<response status="202"/>
|
||||
</method>
|
||||
|
||||
|
||||
<method name="POST" id="lockserver">
|
||||
<wadl:doc xml:lang="EN" title="Lock server"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
@ -207,7 +205,6 @@
|
||||
<response status="202"/>
|
||||
</method>
|
||||
|
||||
|
||||
<method name="POST" id="resetserver">
|
||||
<wadl:doc xml:lang="EN" title="Reset server state"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
@ -233,7 +230,6 @@
|
||||
<response status="202"/>
|
||||
</method>
|
||||
|
||||
|
||||
<method name="POST" id="resumeserver">
|
||||
<wadl:doc xml:lang="EN" title="Resume server"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
@ -259,7 +255,6 @@
|
||||
<response status="202"/>
|
||||
</method>
|
||||
|
||||
|
||||
<method name="POST" id="suspendserver">
|
||||
<wadl:doc xml:lang="EN" title="Suspend server"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
@ -14,7 +14,17 @@
|
||||
<resource id="statistics" path="statistics">
|
||||
<method href="#showhypervisorstatistics"/>
|
||||
</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"/>
|
||||
</resource>
|
||||
<resource id="hypervisor_id" path="{hypervisor_id}">
|
||||
@ -40,18 +50,20 @@
|
||||
<request> </request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-list-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-list-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -64,18 +76,20 @@
|
||||
<request> </request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-search-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-search-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -87,34 +101,38 @@
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-servers-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-servers-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-list-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-list-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -127,18 +145,20 @@
|
||||
<request> </request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-show-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-show-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -151,18 +171,20 @@
|
||||
<request> </request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-statistics-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-statistics-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -175,18 +197,20 @@
|
||||
<request> </request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-uptime-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-hypervisors/hypervisors-uptime-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -12,7 +12,14 @@
|
||||
<resource id="os-instance-usage-audit-log"
|
||||
path="os-instance-usage-audit-log">
|
||||
<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"/>
|
||||
</resource>
|
||||
</resource>
|
||||
@ -27,21 +34,22 @@
|
||||
<para role="shortdesc">Lists usage audits for a specified
|
||||
instance.</para>
|
||||
</wadl:doc>
|
||||
<request> </request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-get-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -51,21 +59,22 @@
|
||||
<para role="shortdesc">Lists instance usage audits that
|
||||
occurred before a specified time.</para>
|
||||
</wadl:doc>
|
||||
<request> </request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-with-before-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-instance-usage-audit-log/inst-usage-audit-log-index-with-before-get-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -18,8 +18,19 @@
|
||||
<resource id="defaults" path="defaults">
|
||||
<method href="#showdefaultquotas"/>
|
||||
</resource>
|
||||
<resource id="user_id"
|
||||
path="{tenant_id}?user_id={user_id}">
|
||||
<resource 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="#deletequotauser"/>
|
||||
</resource>
|
||||
@ -35,29 +46,30 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Deletes a quota for tenant.</para>
|
||||
</wadl:doc>
|
||||
<request> </request>
|
||||
<response status="204"/>
|
||||
</method>
|
||||
<method name="GET" id="showdefaultquotas">
|
||||
<wadl:doc xml:lang="EN" title="Show default quotas"
|
||||
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>
|
||||
<request> </request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/quotas-show-defaults-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/quotas-show-defaults-get-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -66,59 +78,65 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows quotas for tenant.</para>
|
||||
</wadl:doc>
|
||||
<request> </request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/quotas-show-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/quotas-show-get-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="PUT" id="forceupdatequota">
|
||||
<wadl:doc xml:lang="EN" title="Force-update quota"
|
||||
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>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/quotas-update-force-post-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/quotas-update-force-post-req.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/quotas-update-force-post-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/quotas-update-force-post-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -129,41 +147,46 @@
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/quotas-update-post-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/quotas-update-post-req.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/quotas-update-post-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/quotas-update-post-req.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="DELETE" id="deletequotauser">
|
||||
<wadl:doc xml:lang="EN" title="Delete quota for user"
|
||||
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>
|
||||
<response status="204"/>
|
||||
</method>
|
||||
@ -172,21 +195,22 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows quota for user.</para>
|
||||
</wadl:doc>
|
||||
<request> </request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/user-quotas-show-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/user-quotas-show-get-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -197,34 +221,38 @@
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/user-quotas-update-post-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/user-quotas-update-post-req.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/user-quotas-update-post-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
<representation mediaType="application/xml">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../api_samples/os-quota-sets/user-quotas-update-post-resp.xml"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
@ -711,8 +711,7 @@
|
||||
<xsdxt:sample xmlns="http://docs.rackspace.com/api"
|
||||
title="Tenants Request with Auth Token">
|
||||
<xsdxt:code
|
||||
href="../samples/tenants-request-JSON.txt"
|
||||
language="text"/>
|
||||
href="../samples/tenants-request-JSON.txt"/>
|
||||
</xsdxt:sample>
|
||||
</xsdxt:samples>
|
||||
</wadl:doc>
|
||||
|
||||
@ -38,7 +38,6 @@
|
||||
<resource id="v3" path="v3">
|
||||
<resource id="oauth1" path="OS-OAUTH1">
|
||||
<resource id="consumers" path="consumers">
|
||||
|
||||
<param name="description" style="plain"
|
||||
type="xsd:string" required="false">
|
||||
<wadl:doc xml:lang="EN"
|
||||
@ -150,12 +149,12 @@
|
||||
</param>
|
||||
<method href="#getUnauthorizeRequestToken"/>
|
||||
</resource>
|
||||
<resource id="authorize" path="authorize">
|
||||
<!--<resource id="authorize" path="authorize">
|
||||
<resource id="request_token_key"
|
||||
path="{request_token_key)">
|
||||
<method href="#authorizeRequestToken"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>-->
|
||||
<resource id="access_token" path="access_token">
|
||||
<param name="oauth_consumer_key" style="plain"
|
||||
type="xsd:string" required="true">
|
||||
@ -280,7 +279,6 @@
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
|
||||
<resource id="auth" path="auth">
|
||||
<resource id="tokens" path="tokens">
|
||||
<param name="oauth_consumer_key" style="plain"
|
||||
@ -626,7 +624,7 @@
|
||||
</representation>
|
||||
</response>
|
||||
<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"
|
||||
title="Authorize request token">
|
||||
<para role="shortdesc">Enables a user to authorize a
|
||||
@ -668,7 +666,7 @@
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
<response status="400"/> &commonFaults; </method>
|
||||
<response status="400"/> &commonFaults; </method>-->
|
||||
<method name="POST" id="createAccessToken">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create access token">
|
||||
@ -18,3 +18,12 @@ target_dir = target/docbkx/html
|
||||
# Published at api.openstack.org/ but Jenkins will
|
||||
# copy directory 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
1
pom.xml
@ -12,6 +12,7 @@
|
||||
<module>api-quick-start</module>
|
||||
<module>api-guide</module>
|
||||
<module>api-ref</module>
|
||||
<module>api-ref-guides</module>
|
||||
<!-- <module>api-ref-books</module>-->
|
||||
</modules>
|
||||
<profiles>
|
||||
|
||||
8
tox.ini
8
tox.ini
@ -31,4 +31,10 @@ commands = openstack-doc-test --check-build --nocreate-index --only-book api-qui
|
||||
[testenv:publishdocs-api]
|
||||
# Prepare documents (without www) so that they can get published on
|
||||
# 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/
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user