openstack/api-site
Code Issues Proposed changes

Separate extensions into separate files and fix nav bar.

Browse Source 
Other minor edits.

Change-Id: Ie38953752a4f175b4a8692e77ae2bf80461467cd
This commit is contained in:
Diane Fleming 2015-03-22 18:25:34 -05:00
parent cac586b5f9
commit 88724b0f5b
43 changed files with 385 additions and 207 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
api-ref-guides/pom.xml
View File

@ -60,7 +60,7 @@
<pdfFilenameBase>api-ref-blockstorage-v2</pdfFilenameBase>
</configuration>
</execution>
<execution>
<execution>
<id>os-api-ref-blockstorage-v1</id>
<goals>
<goal>generate-pdf</goal>
@ -115,17 +115,6 @@
<pdfFilenameBase>api-ref-databases-v1</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-identity-v2</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-identity-v2.xml </includes>
<pdfFilenameBase>api-ref-identity-v2</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-identity-v3</id>
<goals>
@ -137,6 +126,17 @@
<pdfFilenameBase>api-ref-identity-v3</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-identity-v2</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-identity-v2.xml </includes>
<pdfFilenameBase>api-ref-identity-v2</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-image-v2</id>
<goals>

2
api-ref-guides/src/bk-api-ref-databases-v1.xml
View File

@ -19,5 +19,5 @@
</annotation>
</legalnotice>
</info>
<xi:include href="../../api-ref/src/docbkx/ch_databases-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_database-v1.xml"/>
</book>

2
api-ref-guides/src/bk-api-ref-networking-v2.xml
View File

@ -36,5 +36,5 @@
</legalnotice>
</info>
<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_netconn-v2-ext.xml"/>
</book>

21
api-ref-guides/src/bk-api-ref.xml
View File

@ -33,27 +33,22 @@
</legalnotice>
</info>
<!-- <xi:include href="preface.xml"/>-->
<xi:include
href="../../api-ref/src/docbkx/ch_blockstorage-api-v2.xml"/>
<xi:include
href="../../api-ref/src/docbkx/ch_blockstorage-api-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_blockstorage-api-v2.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_blockstorage-api-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_compute-v2.1.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-v2.1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_databases-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_database-v1.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-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_netconn-v2-ext.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>

110
api-ref/pom.xml
View File

@ -49,25 +49,36 @@
</configuration>
</execution>
<execution>
<id>os-api-ref-identity-v3</id>
<id>os-api-ref-blockstorage-v2</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-identity-v3.xml</includes>
<pdfFilename>bk-api-ref-identity-v3</pdfFilename>
<includes> api-ref-blockstorage-v2.xml</includes>
<pdfFilename>bk-api-ref-blockstorage-v2</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-identity-v2</id>
<id>os-api-ref-blockstorage-v1</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-identity-v2.xml</includes>
<pdfFilename>bk-api-ref-identity-v2</pdfFilename>
<includes> api-ref-blockstorage-v1.xml</includes>
<pdfFilename>bk-api-ref-blockstorage-v1</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-compute-v2.1</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> api-ref-compute-v2.1.xml</includes>
<pdfFilename>bk-api-ref-compute-v2.1</pdfFilename>
</configuration>
</execution>
<execution>
@ -93,14 +104,58 @@
</configuration>
</execution>
<execution>
<id>os-api-ref-compute-v2.1</id>
<id>os-api-ref-database-v1</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> api-ref-compute-v2.1.xml</includes>
<pdfFilename>bk-api-ref-compute-v2.1</pdfFilename>
<includes> api-ref-database-v1.xml </includes>
<pdfFilename>bk-api-ref-database-v1</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-identity-v3</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-identity-v3.xml</includes>
<pdfFilename>bk-api-ref-identity-v3</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-identity-v3-ext</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-identity-v3-ext.xml</includes>
<pdfFilename>bk-api-ref-identity-v3-ext</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-identity-v2</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-identity-v2.xml</includes>
<pdfFilename>bk-api-ref-identity-v2</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-identity-admin-v2</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-identity-admin-v2.xml</includes>
<pdfFilename>bk-api-ref-identity-admin-v2</pdfFilename>
</configuration>
</execution>
<execution>
@ -121,8 +176,8 @@
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> api-ref-databases-v1.xml </includes>
<pdfFilename>bk-api-ref-databases-v1</pdfFilename>
<includes>api-ref-identity-v2-ext.xml</includes>
<pdfFilename>bk-api-ref-identity-v2-ext</pdfFilename>
</configuration>
</execution>
<execution>
@ -158,6 +213,17 @@
<pdfFilename>bk-api-ref-networking-v2</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-networking-v2-ext</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> api-ref-networking-v2-ext.xml </includes>
<pdfFilename>bk-api-ref-networking-v2-ext</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-objectstorage-v1</id>
<goals>
@ -169,28 +235,6 @@
<pdfFilename>bk-api-ref-objectstorage-v1</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-blockstorage-v2</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> api-ref-blockstorage-v2.xml</includes>
<pdfFilename>bk-api-ref-blockstorage-v2</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-blockstorage-v1</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> api-ref-blockstorage-v1.xml</includes>
<pdfFilename>bk-api-ref-blockstorage-v1</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-orchestration-v1</id>
<goals>

4
api-ref/src/docbkx/api-ref-blockstorage-v1.xml
View File

@ -7,10 +7,10 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-blockstorage" status="CURRENT">
<info xreflabel="api-ref-blockstorage.html">
<info xreflabel="api-ref-blockstorage-v1.html">
<title>OpenStack Block Storage API v1</title>
<copyright>
<year>2010-2014</year>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>

4
api-ref/src/docbkx/api-ref-blockstorage-v2.xml
View File

@ -7,10 +7,10 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-blockstorage" status="CURRENT">
<info xreflabel="api-ref-blockstorage.html">
<info xreflabel="api-ref-blockstorage-v2.html">
<title>OpenStack Block Storage API v2</title>
<copyright>
<year>2010-2014</year>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>

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

@ -10,7 +10,7 @@
<info>
<title>OpenStack Compute API v2.1 (CURRENT)</title>
<copyright>
<year>2010-2014</year>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>

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

@ -10,7 +10,7 @@
<info>
<title>OpenStack Compute API v2 (SUPPORTED)</title>
<copyright>
<year>2010-2014</year>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>

8
api-ref/src/docbkx/api-ref-databases-v1.xml → api-ref/src/docbkx/api-ref-database-v1.xml
View File

@ -6,11 +6,11 @@
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-databases" status="CURRENT">
<info xreflabel="api-ref-databases.html">
xml:id="api.openstack.org-database-v1" status="CURRENT">
<info xreflabel="api-ref-database-v1.html">
<title>OpenStack Database Service API v1.0</title>
<copyright>
<year>2010-2014</year>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>
@ -19,5 +19,5 @@
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_databases-v1.xml"/>
<xi:include href="ch_database-v1.xml"/>
</book>

23
api-ref/src/docbkx/api-ref-identity-admin-v2.xml Normal file
View File

@ -0,0 +1,23 @@
<?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-identity-admin-v2" status="STABLE">
<info xreflabel="api-ref-identity-admin-v2.html">
<title>OpenStack Identity Admin API v2</title>
<copyright>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_identity-admin-v2.xml"/>
</book>

23
api-ref/src/docbkx/api-ref-identity-v2-ext.xml Normal file
View File

@ -0,0 +1,23 @@
<?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-identity-v2-ext" status="STABLE">
<info xreflabel="api-ref-identity-v2-ext.html">
<title>OpenStack Identity API v2 extensions</title>
<copyright>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_identity-v2-ext.xml"/>
</book>

6
api-ref/src/docbkx/api-ref-identity-v2.xml
View File

@ -8,9 +8,9 @@
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-identity-v2" status="STABLE">
<info xreflabel="api-ref-identity-v2.html">
<title>OpenStack Identity API v2 and extensions</title>
<title>OpenStack Identity API v2</title>
<copyright>
<year>2010-2014</year>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>
@ -20,6 +20,4 @@
</annotation>
</info>
<xi:include href="ch_identity-v2.xml"/>
<xi:include href="ch_identity-admin-v2.xml"/>
<xi:include href="ch_identity-v2-ext.xml"/>
</book>

23
api-ref/src/docbkx/api-ref-identity-v3-ext.xml Normal file
View File

@ -0,0 +1,23 @@
<?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-identity-v3-ext" status="STABLE">
<info xreflabel="api-ref-identity-v3-ext.html">
<title>OpenStack Identity API v3 extensions</title>
<copyright>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_identity-v3-ext.xml"/>
</book>

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

@ -10,7 +10,7 @@
<info xreflabel="api-ref-identity-v3.html">
<title>OpenStack Identity API v3 and extensions</title>
<copyright>
<year>2010-2014</year>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>
@ -20,7 +20,4 @@
</annotation>
</info>
<xi:include href="ch_identity-v3.xml"/>
<xi:include href="ch_identity-v3-ext.xml"/>
</book>

6
api-ref/src/docbkx/api-ref-image-v1.xml
View File

@ -6,11 +6,11 @@
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-image" status="SUPPORTED">
<info xreflabel="api-ref-image.html">
xml:id="api.openstack.org-image-v1" status="SUPPORTED">
<info xreflabel="api-ref-image-v1.html">
<title>OpenStack Image Service API v1</title>
<copyright>
<year>2010-2014</year>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>

6
api-ref/src/docbkx/api-ref-image-v2.xml
View File

@ -6,11 +6,11 @@
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-image" status="SUPPORTED">
<info xreflabel="api-ref-image.html">
xml:id="api.openstack.org-image-v2" status="SUPPORTED">
<info xreflabel="api-ref-image-v2.html">
<title>OpenStack Image Service API v2</title>
<copyright>
<year>2010-2014</year>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>

23
api-ref/src/docbkx/api-ref-networking-v2-ext.xml Normal file
View File

@ -0,0 +1,23 @@
<?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-networking-v2-ext" status="CURRENT">
<info xreflabel="api-ref-networking-v2-ext.html">
<title>OpenStack Networking API v2.0 extensions</title>
<copyright>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_netconn-v2-ext.xml"/>
</book>

9
api-ref/src/docbkx/api-ref-networking-v2.xml
View File

@ -6,11 +6,11 @@
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-networking" status="CURRENT">
<info xreflabel="api-ref-networking.html">
<title>OpenStack Networking API v2.0</title>
xml:id="api.openstack.org-networking-v2" status="CURRENT">
<info xreflabel="api-ref-networking-v2.html">
<title>OpenStack Networking API v2.0 and extensions</title>
<copyright>
<year>2010-2014</year>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>
@ -20,5 +20,4 @@
</annotation>
</info>
<xi:include href="ch_netconn-v2.xml"/>
<xi:include href="ch_netconn-ext-v2.xml"/>
</book>

6
api-ref/src/docbkx/api-ref-objectstorage-v1.xml
View File

@ -6,11 +6,11 @@
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-objectstorage" status="SUPPORTED">
<info xreflabel="api-ref-objectstorage.html">
xml:id="api.openstack.org-objectstorage-v1" status="SUPPORTED">
<info xreflabel="api-ref-objectstorage-v1.html">
<title>OpenStack Object Storage API v1</title>
<copyright>
<year>2010-2014</year>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>

6
api-ref/src/docbkx/api-ref-orchestration-v1.xml
View File

@ -6,11 +6,11 @@
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-orchestration" status="CURRENT">
<info xreflabel="api-ref-orchestration.html">
xml:id="api.openstack.org-orchestration-v1" status="CURRENT">
<info xreflabel="api-ref-orchestration-v1.html">
<title>OpenStack Orchestration API v1</title>
<copyright>
<year>2010-2014</year>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>

6
api-ref/src/docbkx/api-ref-telemetry-v2.xml
View File

@ -6,11 +6,11 @@
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-telemetry" status="CURRENT">
<info xreflabel="api-ref-telemetry">
xml:id="api.openstack.org-telemetry-v2" status="CURRENT">
<info xreflabel="api-ref-telemetry-v2.html">
<title>OpenStack Telemetry API v2</title>
<copyright>
<year>2010-2014</year>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>

4
api-ref/src/docbkx/api-ref.xml
View File

@ -5,9 +5,9 @@
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"
xml:id="api.openstack.org">
xml:id="api.openstack.org">
<!-- version="5.0-extension RackBook-2.0" -->
<info xreflabel="api-ref-identity-v2.html">
<info xreflabel="api-ref.html">
<title>OpenStack API Reference</title>
<copyright>
<year>2010-2015</year>

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

@ -10,36 +10,22 @@
<title>Block Storage API v1 (CURRENT)</title>
<para>Manage volumes and snapshots for use with the Block Storage
API, also known as cinder services.</para>
<para>When making an API call to
create, list, or delete volume(s), the following status values
<para>When you
create, list, or delete volumes, the following status values
are possible:</para>
<itemizedlist spacing="compact">
<listitem>
<para>CREATING: The volume is being created.</para>
</listitem>
<listitem>
<para>AVAILABLE: The volume is read to be attached to
an instance.</para>
</listitem>
<listitem>
<para>ATTACHING: The volume is attaching to an
instance.</para>
</listitem>
<listitem>
<para>IN-USE: The volume is attached to an
instance.</para>
</listitem>
<listitem>
<para>DELETING: The volume is being deleted.</para>
</listitem>
<listitem>
<para>ERROR: An error has occurred with the
volume.</para>
</listitem>
<listitem>
<para>ERROR_DELETING: There was an error deleting the
volume.</para>
</listitem>
<listitem><para>CREATING. The volume is being created.</para></listitem>
<listitem><para>AVAILABLE. The volume is read to be attached to
an instance.</para></listitem>
<listitem><para>ATTACHING. The volume is attaching to an
instance.</para></listitem>
<listitem><para>IN-USE. The volume is attached to an
instance.</para></listitem>
<listitem><para>DELETING. The volume is being deleted.</para></listitem>
<listitem><para>ERROR. An error has occurred with the
volume.</para></listitem>
<listitem><para>ERROR_DELETING. There was an error deleting the
volume.</para></listitem>
</itemizedlist>
<section xml:id="versions-cinder-v1">
<title>API versions</title>

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

@ -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="blockstorage-v2" role="api-reference">
version="5.0-extension RackBook-2.0" xml:id="blockstorage-v2"
role="api-reference">
<title>Block Storage API v2 (CURRENT)</title>
<para>Manage volumes and snapshots for use with the Block Storage API, also known as cinder
services.</para>

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

@ -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-v2-ext"
role="api-reference">
<title>Compute API v2 extensions (SUPPORTED)</title>
<para>Extensions add features, MIME types, actions, states,

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

@ -4,16 +4,16 @@
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
]>
<chapter 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="compute-ext-v2.1"
role="api-reference">
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="compute-v2.1"
role="api-reference">
<title>Compute API v2.1 (EXPERIMENTAL)</title>
<note><para>XML support in requests and responses has been deprecated for the Compute
API v2.1 API (originally referred to as v3).</para></note>
API v2.1 (originally referred to as API v3).</para></note>
<!-- GET v2.1/extensions does not work -->
<!-- <para>Query the Compute API to list available extensions with a
&GET; request to <code>v2.1/extensions</code>.</para>-->

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

@ -2,10 +2,14 @@
<!DOCTYPE chapter [
<!ENTITY % common SYSTEM "../wadls/compute-api/src/v2/common.ent">
%common;]>
<chapter 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="compute-core-v2" role="api-reference">
<chapter 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="compute-v2"
role="api-reference">
<title>Compute API v2 (CURRENT)</title>
<para>Launch virtual machines from images or images stored on persistent volumes. API v1.1 is
identical to API v2.</para>

5
api-ref/src/docbkx/ch_databases-v1.xml → api-ref/src/docbkx/ch_database-v1.xml
View File

@ -5,8 +5,9 @@
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="databases-v1.0">
<title>Databases Service API v1.0 (CURRENT)</title>
version="5.0-extension RackBook-2.0" xml:id="database-v1"
role="api-reference">
<title>Database Service API v1.0 (CURRENT)</title>
<section xml:id="API_Versions">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">

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

@ -1,10 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter 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="admin-identity-admin-v2" xlink:href="#identity-admin-v2"
<chapter 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="identity-admin-v2"
role="api-reference">
<title>Identity admin API v2.0 (STABLE)</title>
<title>Identity Admin API v2.0 (STABLE)</title>
<para>Get an authentication token that permits access to the Compute API.</para>
<section xml:id="admin-versions">
<title>Versions</title>

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

@ -9,7 +9,7 @@
xmlns:xref="http://www.w3.org/1999/xref"
xmlns: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" role="api-reference">
role="api-reference">
<title>Identity API v2.0 extensions (STABLE)</title>
<para>Query the Identity API to list available extensions with a
&GET; request to <code>v2.0/extensions</code>.</para>

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

@ -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-v2"
xlink:href="#identity-v2">
role="api-reference">
<title>Identity API v2.0 (STABLE)</title>
<para>Get an authentication token that permits access to the
OpenStack services REST API.</para>

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

@ -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" role="api-reference">
role="api-reference">
<title>Identity API v3 extensions (STABLE)</title>
<section xml:id="identity_v3_OS-OAUTH1-ext">
<title>OS-OAUTH1 extension</title>

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

@ -1,8 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter 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="identity-v3" xlink:href="#identity-v3"
<chapter 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="identity-v3"
role="api-reference">
<title>Identity API v3 (STABLE)</title>
<para>Get an authentication token that permits access to the

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

@ -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="images-api-v1"
role="api-reference">
<title>Image Service API v1 (SUPPORTED)</title>
<para>Load images for use at launch time by the Compute API. Also,

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

@ -5,7 +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="image-v2">
version="5.0-extension RackBook-2.0" xml:id="images-api-v2"
role="api-reference">
<title>Image Service API v2 (SUPPORTED)</title>
<para>Image Service API v2.0, API v2.1, and API v2.2.</para>
<para>Cloud providers can configure property protections that

12
api-ref/src/docbkx/ch_netconn-ext-v2.xml → api-ref/src/docbkx/ch_netconn-v2-ext.xml
View File

@ -1,8 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter 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="netconn-v2-ext">
<chapter 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="netconn-v2-ext"
role="api-reference">
<title>Networking API v2.0 extensions</title>
<section xml:id="neutron_extensions">
<title>Extensions</title>

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

@ -5,17 +5,19 @@
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="netconn-v2">
version="5.0-extension RackBook-2.0" xml:id="netconn-v2"
role="api-reference">
<title>Networking API v2.0 (CURRENT)</title>
<para>Use virtual networking services among devices that are
managed by the OpenStack Compute service. The Networking
(neutron) API v2.0 combines the API v1.1 functionality with
some essential Internet Protocol Address Management (IPAM)
functionality. Enables users to associate IP address blocks
and other network configuration settings with an OpenStack
Networking network. You can choose a specific IP address from
the block or let OpenStack Networking choose the first
available IP address.</para>
<para>
Use virtual networking services among devices that are managed by the
OpenStack Compute service. The Networking (neutron) API v2.0 combines
the API v1.1 functionality with some essential Internet Protocol
Address Management (IPAM) functionality. Enables users to associate IP
address blocks and other network configuration settings with an
OpenStack Networking network. You can choose a specific IP address
from the block or let OpenStack Networking choose the first available
IP address.
</para>
<section xml:id="neutron-versions-v2">
<title>API versions</title>
<para>List information for all Networking API versions and show details about API v2.</para>

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

@ -5,7 +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="objectstorage-v1">
version="5.0-extension RackBook-2.0" xml:id="objectstorage-v1"
role="api-reference">
<title>Object Storage API v1 (SUPPORTED)</title>
<para>Manage the accounts, containers, and objects in the Object
Storage system.</para>

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

@ -5,7 +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="orchestration-v1">
version="5.0-extension RackBook-2.0" xml:id="orchestration-v1"
role="api-reference">
<title>Orchestration API v1 (CURRENT)</title>
<para>Use a template language to orchestrate OpenStack
services.</para>

3
api-ref/src/docbkx/ch_telemetry-v2.xml
View File

@ -5,7 +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="telemetry-v2">
version="5.0-extension RackBook-2.0" xml:id="telemetry-v2"
role="api-reference">
<title>Telemetry API v2 (CURRENT)</title>
<para>Manage Telemetry operations.</para>
<section xml:id="alarms">

54
api-ref/src/docbkx/itemizedlist-service-list.xml
View File

@ -2,12 +2,54 @@
<!DOCTYPE itemizedlist [
]>
<itemizedlist 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="service-list">
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="service-list">
<listitem>
<para>
<link xlink:href="api-ref-blockstorage-v2.html">
Block
Storage API v2 (CURRENT)</link>
</para>
</listitem>
<listitem>
<para>
<link xlink:href="api-ref-blockstorage-v1.html">
Block
Storage API v1 (CURRENT)</link>
</para>
</listitem>
<listitem>
<para>
<link xlink:href="api-ref-compute-v2.1.html">
Compute API
v2.1 (EXPERIMENTAL)</link>
</para>
</listitem>
<listitem>
<para>
<link xlink:href="api-ref-compute-v2.html">
Compute API
v2 (CURRENT)</link>
</para>
</listitem>
<listitem>
<para>
<link xlink:href="api-ref-compute-v2-ext.html">
Compute
API v2 extensions (CURRENT)</link>
</para>
</listitem>
<listitem>
<para>
<link xlink:href="api-ref-database-v1.html">
Database
Service API v1.0 (CURRENT)</link>
</para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-blockstorage-v2.html">Block
Storage API v2 (CURRENT)</link></para>

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

@ -7,32 +7,36 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="Overview">
<title>OpenStack API Complete Reference</title>
<para>Use the OpenStack 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.</para>
<para>The API <emphasis role="bold">status</emphasis> reflects the
state of the endpoint on the service. <emphasis role="bold"
>CURRENT</emphasis> is a stable version that is
up-to-date, recent, and might receive future versions. This
endpoint should be prioritized over all others. <emphasis
role="bold">SUPPORTED</emphasis> is a stable version that
is available on the server. However, it is not likely the most
recent available and might not be updated or might be
<para>
Use the OpenStack 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.
</para>
<para>
The API <emphasis role="bold">status</emphasis> reflects the state of
the endpoint on the service. <emphasis role="bold"
>CURRENT</emphasis> is a stable version that is up-to-date, recent,
and might receive future versions. This endpoint should be prioritized
over all others. <emphasis role="bold">SUPPORTED</emphasis> is a
stable version that is available on the server. However, it is not
likely the most recent available and might not be updated or might be
deprecated at some time in the future. <emphasis role="bold"
>DEPRECATED</emphasis> is a stable version that is still
available but is being deprecated and might be removed in the
future. <emphasis role="bold">EXPERIMENTAL</emphasis> is not a
stable version. This version is under development or contains
features that are otherwise subject to change. For more
information about API <emphasis role="bold">status</emphasis>
values and version information, see <link
xlink:href="https://wiki.openstack.org/wiki/VersionDiscovery"
>Version Discovery</link>.</para>
<para>You must install the packages for each API separately. You
can use the APIs and extensions after you authenticate through
the <link xlink:href="api-ref-identity.html">Identity
API</link>:</para>
>DEPRECATED</emphasis> is a stable version that is still available but
is being deprecated and might be removed in the future. <emphasis
role="bold">EXPERIMENTAL</emphasis> is not a stable version. This
version is under development or contains features that are otherwise
subject to change. For more information about API <emphasis
role="bold">status</emphasis> values and version information, see
<link
xlink:href="https://wiki.openstack.org/wiki/VersionDiscovery"
>Version Discovery</link>.
</para>
<para>
You must install the packages for each API separately. You can use the
APIs and extensions after you authenticate through the <link
xlink:href="api-ref-identity.html">Identity API</link>:
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/identity-api/src/v2.0/wadl/identity.wadl#tokens"