Update API site to show status of each API
Add statuses, such as EXPERIMENTAL, STABLE, and CURRENT Closes-Bug: #1283620 Change-Id: I117146b16fc9ba456827255e33d0915f6c0d17bd author: diane fleming
This commit is contained in:
Diane Fleming
parent
513aa1dc0c
commit
35dcf50e0e
@ -39,14 +39,25 @@
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-blockstorage</id>
|
||||
<id>os-api-ref-blockstorage-v2</id>
|
||||
<goals>
|
||||
<goal>generate-pdf</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-blockstorage.xml </includes>
|
||||
<pdfFilenameBase>api-ref-blockstorage</pdfFilenameBase>
|
||||
<includes> bk-api-ref-blockstorage-v2.xml </includes>
|
||||
<pdfFilenameBase>api-ref-blockstorage-v2</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-blockstorage-v1</id>
|
||||
<goals>
|
||||
<goal>generate-pdf</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-blockstorage-v1.xml </includes>
|
||||
<pdfFilenameBase>api-ref-blockstorage-v1</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
@ -83,14 +94,14 @@
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-databases</id>
|
||||
<id>os-api-ref-databases-v1</id>
|
||||
<goals>
|
||||
<goal>generate-pdf</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-databases.xml </includes>
|
||||
<pdfFilenameBase>api-ref-databases</pdfFilenameBase>
|
||||
<includes> bk-api-ref-databases-v1.xml </includes>
|
||||
<pdfFilenameBase>api-ref-databases-v1</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
@ -116,58 +127,69 @@
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-image</id>
|
||||
<id>os-api-ref-image-v2</id>
|
||||
<goals>
|
||||
<goal>generate-pdf</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-image.xml </includes>
|
||||
<pdfFilenameBase>api-ref-image</pdfFilenameBase>
|
||||
<includes> bk-api-ref-image-v2.xml </includes>
|
||||
<pdfFilenameBase>api-ref-image-v2</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-networking</id>
|
||||
<id>os-api-ref-image-v1</id>
|
||||
<goals>
|
||||
<goal>generate-pdf</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-networking.xml </includes>
|
||||
<pdfFilenameBase>api-ref-networking</pdfFilenameBase>
|
||||
<includes> bk-api-ref-image-v1.xml </includes>
|
||||
<pdfFilenameBase>api-ref-image-v1</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-objectstorage</id>
|
||||
<id>os-api-ref-networking-v2</id>
|
||||
<goals>
|
||||
<goal>generate-pdf</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-objectstorage.xml </includes>
|
||||
<pdfFilenameBase>api-ref-objectstorage</pdfFilenameBase>
|
||||
<includes> bk-api-ref-networking-v2.xml </includes>
|
||||
<pdfFilenameBase>api-ref-networking-v2</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-orchestration</id>
|
||||
<id>os-api-ref-objectstorage-v1</id>
|
||||
<goals>
|
||||
<goal>generate-pdf</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-orchestration.xml </includes>
|
||||
<pdfFilenameBase>api-ref-orchestration</pdfFilenameBase>
|
||||
<includes> bk-api-ref-objectstorage-v1.xml </includes>
|
||||
<pdfFilenameBase>api-ref-objectstorage-v1</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-telemetry</id>
|
||||
<id>os-api-ref-orchestration-v1</id>
|
||||
<goals>
|
||||
<goal>generate-pdf</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-telemetry.xml </includes>
|
||||
<pdfFilenameBase>api-ref-telemetry</pdfFilenameBase>
|
||||
<includes> bk-api-ref-orchestration-v1.xml </includes>
|
||||
<pdfFilenameBase>api-ref-orchestration-v1</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-telemetry-v2</id>
|
||||
<goals>
|
||||
<goal>generate-pdf</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes> bk-api-ref-telemetry-v2.xml </includes>
|
||||
<pdfFilenameBase>api-ref-telemetry-v2</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
|
||||
@ -21,7 +21,7 @@
|
||||
version="5.0-extension RackBook-2.0"
|
||||
xml:id="api.openstack.org-blockstorage-pdf">
|
||||
<info>
|
||||
<title>OpenStack Block Storage API v2 and v1 Reference</title>
|
||||
<title>OpenStack Block Storage API v1 Reference</title>
|
||||
<titleabbrev>API Reference</titleabbrev>
|
||||
<author>
|
||||
<personname>
|
||||
@ -45,8 +45,7 @@
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include
|
||||
href="../../api-ref/src/docbkx/ch_blockstorage-api-v2.xml"/>
|
||||
<!-- <xi:include href="preface.xml"/>-->
|
||||
<xi:include
|
||||
href="../../api-ref/src/docbkx/ch_blockstorage-api-v1.xml"/>
|
||||
</book>
|
||||
51
api-ref-guides/src/bk-api-ref-blockstorage-v2.xml
Normal file
51
api-ref-guides/src/bk-api-ref-blockstorage-v2.xml
Normal file
@ -0,0 +1,51 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE book[
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
<!ENTITY nbsp " ">
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
]>
|
||||
<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-blockstorage-pdf">
|
||||
<info>
|
||||
<title>OpenStack Block Storage API v2 Reference</title>
|
||||
<titleabbrev>API 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 Block Storage</productname>
|
||||
<pubdate/>
|
||||
<legalnotice role="apache2">
|
||||
<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-v2.xml"/>
|
||||
</book>
|
||||
@ -8,7 +8,7 @@
|
||||
version="5.0-extension RackBook-2.0"
|
||||
xml:id="api.openstack.org-image-pdf">
|
||||
<info>
|
||||
<title>OpenStack Image Service API v2 and v1 Reference</title>
|
||||
<title>OpenStack Image Service API v1 Reference</title>
|
||||
<titleabbrev>API Reference</titleabbrev>
|
||||
<author>
|
||||
<personname>
|
||||
@ -32,6 +32,5 @@
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_images-v2.xml"/>
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_images-v1.xml"/>
|
||||
</book>
|
||||
36
api-ref-guides/src/bk-api-ref-image-v2.xml
Normal file
36
api-ref-guides/src/bk-api-ref-image-v2.xml
Normal file
@ -0,0 +1,36 @@
|
||||
<?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-image-pdf">
|
||||
<info>
|
||||
<title>OpenStack Image Service API v2 Reference</title>
|
||||
<titleabbrev>API 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 Image Service</productname>
|
||||
<pubdate/>
|
||||
<legalnotice role="apache2">
|
||||
<annotation>
|
||||
<remark>Copyright details are filled in by the
|
||||
template.</remark>
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_images-v2.xml"/>
|
||||
</book>
|
||||
@ -65,8 +65,7 @@
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes>
|
||||
api-ref-compute-v2.xml</includes>
|
||||
<includes> api-ref-compute-v2.xml</includes>
|
||||
<pdfFilename>bk-api-ref-compute-v2</pdfFilename>
|
||||
</configuration>
|
||||
</execution>
|
||||
@ -88,89 +87,107 @@
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes>
|
||||
api-ref-compute-v3.xml</includes>
|
||||
<includes> api-ref-compute-v3.xml</includes>
|
||||
<pdfFilename>bk-api-ref-compute-v3</pdfFilename>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-databases</id>
|
||||
<id>os-api-ref-databases-v1</id>
|
||||
<goals>
|
||||
<goal>generate-html</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes>
|
||||
api-ref-databases.xml </includes>
|
||||
<pdfFilename>bk-api-ref-databases</pdfFilename>
|
||||
<includes> api-ref-databases-v1.xml </includes>
|
||||
<pdfFilename>bk-api-ref-databases-v1</pdfFilename>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-image</id>
|
||||
<id>os-api-ref-image-v2</id>
|
||||
<goals>
|
||||
<goal>generate-html</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes>api-ref-image.xml </includes>
|
||||
<pdfFilename>bk-api-ref-image</pdfFilename>
|
||||
<includes>api-ref-image-v2.xml </includes>
|
||||
<pdfFilename>bk-api-ref-image-v2</pdfFilename>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-networking</id>
|
||||
<id>os-api-ref-image-v1</id>
|
||||
<goals>
|
||||
<goal>generate-html</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes>
|
||||
api-ref-networking.xml </includes>
|
||||
<pdfFilename>bk-api-ref-networking</pdfFilename>
|
||||
<includes>api-ref-image-v1.xml </includes>
|
||||
<pdfFilename>bk-api-ref-image-v1</pdfFilename>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-objectstorage</id>
|
||||
<id>os-api-ref-networking-v2</id>
|
||||
<goals>
|
||||
<goal>generate-html</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes>api-ref-objectstorage.xml </includes>
|
||||
<pdfFilename>bk-api-ref-objectstorage</pdfFilename>
|
||||
<includes> api-ref-networking-v2.xml </includes>
|
||||
<pdfFilename>bk-api-ref-networking-v2</pdfFilename>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-blockstorage</id>
|
||||
<id>os-api-ref-objectstorage-v1</id>
|
||||
<goals>
|
||||
<goal>generate-html</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes>
|
||||
api-ref-blockstorage.xml</includes>
|
||||
<pdfFilename>bk-api-ref-blockstorage</pdfFilename>
|
||||
<includes>api-ref-objectstorage-v1.xml </includes>
|
||||
<pdfFilename>bk-api-ref-objectstorage-v1</pdfFilename>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-orchestration</id>
|
||||
<id>os-api-ref-blockstorage-v2</id>
|
||||
<goals>
|
||||
<goal>generate-html</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes>api-ref-orchestration.xml</includes>
|
||||
<pdfFilename>bk-api-ref-orchestration</pdfFilename>
|
||||
<includes> api-ref-blockstorage-v2.xml</includes>
|
||||
<pdfFilename>bk-api-ref-blockstorage-v2</pdfFilename>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-telemetry</id>
|
||||
<id>os-api-ref-blockstorage-v1</id>
|
||||
<goals>
|
||||
<goal>generate-html</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes>api-ref-telemetry.xml</includes>
|
||||
<pdfFilename>bk-api-ref-telemetry</pdfFilename>
|
||||
<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>
|
||||
<goal>generate-html</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes>api-ref-orchestration-v1.xml</includes>
|
||||
<pdfFilename>bk-api-ref-orchestration-v1</pdfFilename>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>os-api-ref-telemetry-v2</id>
|
||||
<goals>
|
||||
<goal>generate-html</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<includes>api-ref-telemetry-v2.xml</includes>
|
||||
<pdfFilename>bk-api-ref-telemetry-v2</pdfFilename>
|
||||
</configuration>
|
||||
</execution>
|
||||
<!-- Configuration for OpenStack API References (pdf) -->
|
||||
@ -186,7 +203,7 @@
|
||||
section toc,title
|
||||
part toc,title
|
||||
qandadiv toc
|
||||
qandaset to
|
||||
qandaset toc
|
||||
reference toc,title
|
||||
set toc,title</generateToc>
|
||||
<xincludeSupported>true</xincludeSupported>
|
||||
|
||||
@ -6,9 +6,9 @@
|
||||
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-blockstorage">
|
||||
xml:id="api.openstack.org-blockstorage" status="CURRENT">
|
||||
<info xreflabel="api-ref-blockstorage.html">
|
||||
<title>OpenStack Block Storage API</title>
|
||||
<title>OpenStack Block Storage API v1</title>
|
||||
<copyright>
|
||||
<year>2010-2014</year>
|
||||
</copyright>
|
||||
@ -19,6 +19,5 @@
|
||||
<xi:include href="itemizedlist-service-list.xml"/>
|
||||
</annotation>
|
||||
</info>
|
||||
<xi:include href="ch_blockstorage-api-v2.xml"/>
|
||||
<xi:include href="ch_blockstorage-api-v1.xml"/>
|
||||
</book>
|
||||
23
api-ref/src/docbkx/api-ref-blockstorage-v2.xml
Normal file
23
api-ref/src/docbkx/api-ref-blockstorage-v2.xml
Normal 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-blockstorage" status="CURRENT">
|
||||
<info xreflabel="api-ref-blockstorage.html">
|
||||
<title>OpenStack Block Storage API v2</title>
|
||||
<copyright>
|
||||
<year>2010-2014</year>
|
||||
</copyright>
|
||||
<legalnotice role="apache2">
|
||||
<para/>
|
||||
</legalnotice>
|
||||
<annotation>
|
||||
<xi:include href="itemizedlist-service-list.xml"/>
|
||||
</annotation>
|
||||
</info>
|
||||
<xi:include href="ch_blockstorage-api-v2.xml"/>
|
||||
</book>
|
||||
@ -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="api.openstack.org-compute-v2-ext">
|
||||
xml:id="api.openstack.org-compute-v2-ext" status="CURRENT">
|
||||
<info>
|
||||
<title>OpenStack Compute API v2 extensions</title>
|
||||
<copyright>
|
||||
|
||||
@ -6,9 +6,9 @@
|
||||
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-compute-v2">
|
||||
xml:id="api.openstack.org-compute-v2" status="CURRENT">
|
||||
<info>
|
||||
<title>OpenStack Compute API v2</title>
|
||||
<title>OpenStack Compute API v2 (CURRENT)</title>
|
||||
<copyright>
|
||||
<year>2010-2014</year>
|
||||
</copyright>
|
||||
|
||||
@ -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="api.openstack.org-databases">
|
||||
xml:id="api.openstack.org-databases" status="CURRENT">
|
||||
<info xreflabel="api-ref-databases.html">
|
||||
<title>OpenStack Database Service API v1.0</title>
|
||||
<copyright>
|
||||
@ -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="api.openstack.org-identity-v2">
|
||||
xml:id="api.openstack.org-identity-v2" status="STABLE">
|
||||
<info xreflabel="api-ref-identity-v2.html">
|
||||
<title>OpenStack Identity API v2 and extensions</title>
|
||||
<copyright>
|
||||
|
||||
@ -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="api.openstack.org-identity-v3">
|
||||
xml:id="api.openstack.org-identity-v3" status="STABLE">
|
||||
<info xreflabel="api-ref-identity-v3.html">
|
||||
<title>OpenStack Identity API v3 and extensions</title>
|
||||
<copyright>
|
||||
|
||||
@ -6,9 +6,9 @@
|
||||
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">
|
||||
xml:id="api.openstack.org-image" status="SUPPORTED">
|
||||
<info xreflabel="api-ref-image.html">
|
||||
<title>OpenStack Image Service API v2 and v1</title>
|
||||
<title>OpenStack Image Service API v1</title>
|
||||
<copyright>
|
||||
<year>2010-2014</year>
|
||||
</copyright>
|
||||
@ -19,6 +19,5 @@
|
||||
<xi:include href="itemizedlist-service-list.xml"/>
|
||||
</annotation>
|
||||
</info>
|
||||
<xi:include href="ch_images-v2.xml"/>
|
||||
<xi:include href="ch_images-v1.xml"/>
|
||||
</book>
|
||||
23
api-ref/src/docbkx/api-ref-image-v2.xml
Normal file
23
api-ref/src/docbkx/api-ref-image-v2.xml
Normal 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-image" status="SUPPORTED">
|
||||
<info xreflabel="api-ref-image.html">
|
||||
<title>OpenStack Image Service API v2</title>
|
||||
<copyright>
|
||||
<year>2010-2014</year>
|
||||
</copyright>
|
||||
<legalnotice role="apache2">
|
||||
<para/>
|
||||
</legalnotice>
|
||||
<annotation>
|
||||
<xi:include href="itemizedlist-service-list.xml"/>
|
||||
</annotation>
|
||||
</info>
|
||||
<xi:include href="ch_images-v2.xml"/>
|
||||
</book>
|
||||
@ -6,9 +6,9 @@
|
||||
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">
|
||||
xml:id="api.openstack.org-networking" status="CURRENT">
|
||||
<info xreflabel="api-ref-networking.html">
|
||||
<title>OpenStack Networking (neutron) API v2.0 and extensions</title>
|
||||
<title>OpenStack Networking API v2.0</title>
|
||||
<copyright>
|
||||
<year>2010-2014</year>
|
||||
</copyright>
|
||||
@ -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="api.openstack.org-objectstorage">
|
||||
xml:id="api.openstack.org-objectstorage" status="SUPPORTED">
|
||||
<info xreflabel="api-ref-objectstorage.html">
|
||||
<title>OpenStack Object Storage API v1</title>
|
||||
<copyright>
|
||||
@ -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="api.openstack.org-orchestration">
|
||||
xml:id="api.openstack.org-orchestration" status="CURRENT">
|
||||
<info xreflabel="api-ref-orchestration.html">
|
||||
<title>OpenStack Orchestration API v1</title>
|
||||
<copyright>
|
||||
@ -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="api.openstack.org-telemetry">
|
||||
xml:id="api.openstack.org-telemetry" status="CURRENT">
|
||||
<info xreflabel="api-ref-telemetry">
|
||||
<title>OpenStack Telemetry API v2</title>
|
||||
<copyright>
|
||||
@ -20,4 +20,4 @@ xml:id="api.openstack.org">
|
||||
</annotation>
|
||||
</info>
|
||||
<xi:include href="preface.xml"/>
|
||||
</book>
|
||||
</book>
|
||||
@ -7,7 +7,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
version="5.0-extension RackBook-2.0" xml:id="blockstorage-v1"
|
||||
role="api-reference">
|
||||
<title>Block Storage API v1</title>
|
||||
<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>
|
||||
<section xml:id="versions-cinder-v1">
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
version="5.0-extension RackBook-2.0" xml:id="blockstorage-v2"
|
||||
role="api-reference">
|
||||
<title>Block Storage API v2</title>
|
||||
<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>
|
||||
<section xml:id="versions-cinder-v2">
|
||||
|
||||
@ -10,14 +10,14 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
version="5.0-extension RackBook-2.0" xml:id="compute-ext-v2"
|
||||
role="api-reference">
|
||||
<title>Compute API v2 extensions</title>
|
||||
<title>Compute API v2 extensions (CURRENT)</title>
|
||||
<para>Extensions add features, MIME types, actions, states,
|
||||
headers, parameters, and resources to the core Compute API
|
||||
without requiring a version change.</para>
|
||||
<section xml:id="compute_extensions">
|
||||
<title>Extensions</title>
|
||||
<para>List available Compute API v2 extensions and show details for a
|
||||
specified extension.</para>
|
||||
<para>List available Compute API v2 extensions and show
|
||||
details for a specified extension.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#extensions">
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
version="5.0-extension RackBook-2.0" xml:id="compute-core-v2"
|
||||
role="api-reference">
|
||||
<title>Compute API v2</title>
|
||||
<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>
|
||||
<section xml:id="compute_versions">
|
||||
|
||||
@ -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="databases-v1.0">
|
||||
<title>Databases Service API v1.0</title>
|
||||
<title>Databases 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">
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
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" role="api-reference">
|
||||
<title>Identity admin API v2.0</title>
|
||||
<title>Identity admin API v2.0 (STABLE)</title>
|
||||
<para>Get an authentication token that permits access to the
|
||||
Compute API.</para>
|
||||
<wadl:resources
|
||||
|
||||
@ -10,7 +10,7 @@
|
||||
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">
|
||||
<title>Identity API v2.0 extensions</title>
|
||||
<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>
|
||||
<section xml:id="hp-idm-admin-ext">
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
version="5.0-extension RackBook-2.0" xml:id="identity-v2"
|
||||
xlink:href="#identity-v2">
|
||||
<title>Identity API v2.0</title>
|
||||
<title>Identity API v2.0 (STABLE)</title>
|
||||
<para>Get an authentication token that permits access to the
|
||||
Compute API.</para>
|
||||
<section xml:id="identity-v2-versions">
|
||||
|
||||
@ -10,7 +10,7 @@
|
||||
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">
|
||||
<title>Identity API v3 extensions</title>
|
||||
<title>Identity API v3 extensions (STABLE)</title>
|
||||
<para>Query the Identity API to list available extensions
|
||||
with a &GET; request to <code>v3/extensions</code>.</para>
|
||||
<section xml:id="identity_v3_OS-OAUTH1-ext">
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
version="5.0-extension RackBook-2.0" xml:id="identity-v3"
|
||||
xlink:href="#identity-v3" role="api-reference">
|
||||
<title>Identity API v3</title>
|
||||
<title>Identity API v3 (STABLE)</title>
|
||||
<para>Get an authentication token that permits access to the
|
||||
Compute API.</para>
|
||||
<section xml:id="versions-identity-v3">
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
version="5.0-extension RackBook-2.0" xml:id="image-v1"
|
||||
role="api-reference">
|
||||
<title>Image Service API v1</title>
|
||||
<title>Image Service API v1 (SUPPORTED)</title>
|
||||
<para>Load images for use at launch time by the Compute API. Also,
|
||||
assign metadata to images.</para>
|
||||
<para>Some cloud implementations do not expose this API and offer
|
||||
|
||||
@ -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="image-v2">
|
||||
<title>Image Service API v2</title>
|
||||
<title>Image Service API v2 (SUPPORTED)</title>
|
||||
<para>Image Service API v2.0, API v2.1, and API v2.2.</para>
|
||||
<section xml:id="versions-images-v2">
|
||||
<title>API versions</title>
|
||||
|
||||
@ -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="netconn-v2-ext">
|
||||
<title>Networking (neutron) API v2.0 extensions</title>
|
||||
<title>Networking API v2.0 extensions (CURRENT)</title>
|
||||
<section xml:id="quotas-ext">
|
||||
<title>Quotas extension (quotas)</title>
|
||||
<para>List, show information for, update, and reset
|
||||
|
||||
@ -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="netconn-v2">
|
||||
<title>Networking (neutron) API v2.0</title>
|
||||
<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
|
||||
|
||||
@ -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="objectstorage-v1">
|
||||
<title>Object Storage API v1</title>
|
||||
<title>Object Storage API v1 (SUPPORTED)</title>
|
||||
<para>Manage the accounts, containers, and objects in the Object
|
||||
Storage system.</para>
|
||||
<para>To run the cURL command examples for these requests, set
|
||||
|
||||
@ -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="orchestration-v1">
|
||||
<title>Orchestration API v1</title>
|
||||
<title>Orchestration API v1 (CURRENT)</title>
|
||||
<para>Use a template language to orchestrate OpenStack
|
||||
services.</para>
|
||||
<section xml:id="heat-versions">
|
||||
|
||||
@ -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="telemetry-v2">
|
||||
<title>Telemetry API v2</title>
|
||||
<title>Telemetry API v2 (CURRENT)</title>
|
||||
<para>Manage telemetry operations.</para>
|
||||
<section xml:id="alarms">
|
||||
<title>Alarms</title>
|
||||
|
||||
@ -9,51 +9,59 @@
|
||||
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.html">Block
|
||||
Storage API</link></para>
|
||||
<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.html">Compute API
|
||||
v2</link></para>
|
||||
v2 (CURRENT)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-compute-v2-ext.html">Compute
|
||||
API v2 extensions</link></para>
|
||||
API v2 extensions (CURRENT)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-compute-v3.html">Compute API
|
||||
v3 (EXPERIMENTAL)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-databases.html">Database
|
||||
Service API</link></para>
|
||||
<para><link xlink:href="api-ref-databases-v1.html">Database
|
||||
Service API v1.0 (CURRENT)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-identity-v3.html">Identity API
|
||||
v3 and extensions</link></para>
|
||||
v3 (STABLE)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-identity-v2.html">Identity API
|
||||
v2.0 and extensions</link></para>
|
||||
v2.0 (STABLE)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-image.html">Image Service
|
||||
API</link></para>
|
||||
<para><link xlink:href="api-ref-image-v2.html">Image Service
|
||||
API v2 (SUPPORTED)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-networking.html">Networking
|
||||
(neutron) API and extensions</link></para>
|
||||
<para><link xlink:href="api-ref-image-v1.html">Image Service
|
||||
API v1 (SUPPORTED)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-objectstorage.html">Object
|
||||
Storage API</link></para>
|
||||
<para><link xlink:href="api-ref-networking-v2.html">Networking
|
||||
API v2.0 (CURRENT)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-orchestration.html"
|
||||
>Orchestration API</link></para>
|
||||
<para><link xlink:href="api-ref-objectstorage-v1.html">Object
|
||||
Storage API v1 (SUPPORTED)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-telemetry.html">Telemetry
|
||||
API</link></para>
|
||||
<para><link xlink:href="api-ref-orchestration-v1.html"
|
||||
>Orchestration API v1 (CURRENT)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="api-ref-telemetry-v2.html">Telemetry
|
||||
API v2 (CURRENT)</link></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
@ -13,7 +13,6 @@
|
||||
<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"/>-->
|
||||
<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>,
|
||||
@ -24,6 +23,65 @@
|
||||
see the <link
|
||||
xlink:href="http://docs.openstack.org/api/quick-start/content/"
|
||||
>OpenStack API Quick Start</link>.</para>
|
||||
<para>The API <emphasis role="bold">status</emphasis> reflects the
|
||||
state of the endpoint on the service. This table shows the
|
||||
possible API <emphasis role="bold">status</emphasis> values
|
||||
and descriptions:</para>
|
||||
<informaltable rules="all">
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Status</th>
|
||||
<th>Stable</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<emphasis role="bold">CURRENT</emphasis>
|
||||
</td>
|
||||
<td>Yes</td>
|
||||
<td>This version is up-to-date, recent, and might
|
||||
receive future versions. This endpoint should be
|
||||
prioritized over all others. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<emphasis role="bold">SUPPORTED</emphasis>
|
||||
</td>
|
||||
<td>Yes</td>
|
||||
<td>This version is available on the server, however
|
||||
is not likely the most recent available and might
|
||||
not be updated or might be deprecated at some time
|
||||
in the future.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<emphasis role="bold">DEPRECATED</emphasis>
|
||||
</td>
|
||||
<td>Yes</td>
|
||||
<td>This version is still available but is being
|
||||
deprecated and might be removed in the
|
||||
future.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<emphasis role="bold">EXPERIMENTAL</emphasis>
|
||||
</td>
|
||||
<td>No</td>
|
||||
<td>This version is under development or contains
|
||||
features that are otherwise subject to
|
||||
change.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</informaltable>
|
||||
<note>
|
||||
<para>An API that is not marked as stable is still under
|
||||
development.</para>
|
||||
</note>
|
||||
<para>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>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/identity-api/src/v2.0/wadl/identity.wadl#tokens"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user