openstack/api-site
Code Issues Proposed changes

Updated to omit need for preface on each API page

Browse Source 
Change-Id: I4e8ef5bca48aee02caf3dca495de064aac9e2bdc
author: diane fleming
This commit is contained in:
Diane Fleming 2014-02-17 16:02:23 -06:00
parent 703d933293
commit 2662c0b219
22 changed files with 203 additions and 193 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api-ref/pom.xml
View File

@ -32,7 +32,7 @@
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> api-ref.xml, api-ref-compute.xml, api-ref-compute-ext.xml,
<includes> api-ref.xml, api-ref-blockstorage.xml, api-ref-compute.xml, api-ref-compute-ext.xml,
api-ref-identity.xml, api-ref-image.xml,
api-ref-networking.xml, api-ref-objectstorage.xml,
api-ref-blockstorage.xml, api-ref-orchestration.xml,
@ -54,7 +54,7 @@
<includes> bk-api-ref.xml </includes>
<pdfFilenameBase>api-ref</pdfFilenameBase>
</configuration>
</execution> -->
</execution>
<execution>
<id>os-api-ref-blockstorage</id>
<goals>
@ -153,7 +153,7 @@
<includes> bk-api-ref-telemetry.xml </includes>
<pdfFilenameBase>api-ref-telemetry</pdfFilenameBase>
</configuration>
</execution>
</execution>-->
</executions>
<configuration>
<!-- These parameters apply to pdf and webhelp -->

8
api-ref/src/docbkx/api-ref-blockstorage.xml
View File

@ -7,15 +7,17 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-blockstorage">
<info>
<title>OpenStack Block Storage APIs</title>
<info xreflabel="api-ref-blockstorage.html">
<title>OpenStack Block Storage API</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="preface.xml"/>
<xi:include href="ch_blockstorage-api.xml"/>
</book>

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

@ -7,7 +7,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-compute-ext">
<info>
<info xreflabel="api-ref-compute-ext.html">
<title>OpenStack Compute API extensions</title>
<copyright>
<year>2010-2014</year>
@ -15,7 +15,9 @@
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="preface.xml"/>
<xi:include href="ch_compute-ext.xml"/>
</book>

6
api-ref/src/docbkx/api-ref-compute.xml
View File

@ -7,7 +7,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-compute">
<info>
<info xreflabel="api-ref-compute.html">
<title>OpenStack Compute API</title>
<copyright>
<year>2010-2014</year>
@ -15,7 +15,9 @@
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="preface.xml"/>
<xi:include href="ch_compute-core.xml"/>
</book>

8
api-ref/src/docbkx/api-ref-identity.xml
View File

@ -6,8 +6,8 @@
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">
<info>
xml:id="api.openstack.org-identity-v2">
<info xreflabel="api-ref-identity.html">
<title>OpenStack Identity Service APIs and extensions</title>
<copyright>
<year>2010-2014</year>
@ -15,8 +15,10 @@
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</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"/>

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

@ -7,7 +7,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-image">
<info>
<info xreflabel="api-ref-image.html">
<title>OpenStack Image Service APIs</title>
<copyright>
<year>2010-2014</year>
@ -15,8 +15,10 @@
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="preface.xml"/>
<xi:include href="ch_images-v2.xml"/>
<xi:include href="ch_images-v1.xml"/>
</book>

6
api-ref/src/docbkx/api-ref-networking.xml
View File

@ -7,7 +7,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-networking">
<info>
<info xreflabel="api-ref-networking.html">
<title>OpenStack Networking APIs and extensions</title>
<copyright>
<year>2010-2014</year>
@ -15,8 +15,10 @@
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="preface.xml"/>
<xi:include href="ch_netconn-v2.xml"/>
<xi:include href="ch_netconn-ext-v2.xml"/>
</book>

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

@ -7,7 +7,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-objectstorage">
<info>
<info xreflabel="api-ref-objectstorage.html">
<title>OpenStack Object Storage API</title>
<copyright>
<year>2010-2014</year>
@ -15,7 +15,9 @@
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="preface.xml"/>
<xi:include href="ch_objectstorage-v1.xml"/>
</book>

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

@ -7,7 +7,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-orchestration">
<info>
<info xreflabel="api-ref-orchestration.html">
<title>OpenStack Orchestration API</title>
<copyright>
<year>2010-2014</year>
@ -15,7 +15,9 @@
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="preface.xml"/>
<xi:include href="ch_orchestration-v1.xml"/>
</book>

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

@ -7,7 +7,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-telemetry">
<info>
<info xreflabel="api-ref-telemetry">
<title>OpenStack Telemetry API</title>
<copyright>
<year>2010-2014</year>
@ -15,7 +15,9 @@
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="preface.xml"/>
<xi:include href="ch_telemetry-v2.xml"/>
</book>

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

@ -7,7 +7,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="blockstorage-v2">
<title>Block Storage API v2.0</title>
<para>Manages volumes and snapshots for use with the Block Storage
<para>Manage volumes and snapshots for use with the Block Storage
API, also known as cinder services.</para>
<section xml:id="volumes">
<title>Volumes</title>

43
api-ref/src/docbkx/ch_compute-core.xml
View File

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">
<!-- 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>'>
]>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
@ -19,12 +6,12 @@
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>
<para>Launches virtual machines from images or images stored on
<title>Compute API v2</title>
<para>Launch virtual machines from images or images stored on
persistent volumes. API v1.1 is identical to API v2.</para>
<section xml:id="compute_versions">
<title>Versions</title>
<para>Gets information about a specific version of the
<para>Get information about a specific version of the
API.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
@ -35,7 +22,7 @@
</section>
<section xml:id="compute_extensions">
<title>Extensions</title>
<para>Lists all available extensions and gets details for a
<para>List all available extensions and get details for a
specified extension. Extensions introduce features and
vendor-specific functionality in the API without requiring
a version change.</para>
@ -52,7 +39,7 @@
</section>
<section xml:id="compute_limits">
<title>Limits</title>
<para>Gets rate and absolute limits.</para>
<para>Get rate and absolute limits.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/compute-api/src/wadl/os-compute-2.wadl#limits">
@ -62,7 +49,7 @@
</section>
<section xml:id="compute_servers">
<title>Servers</title>
<para>Lists, creates, gets details for, updates, and deletes
<para>List, create, get details for, update, and delete
servers.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
@ -78,13 +65,13 @@
href="../wadls/compute-api/src/wadl/os-compute-2.wadl#server_id">
<wadl:method href="#getServer"/>
<wadl:method href="#updateServer"/>
<wadl:method href="#deleteServer"/>
<wadl:method href="#deleteerver"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="compute_server_metadata">
<title>Server metadata</title>
<para>Sets, lists, gets details for, and deletes server
<para>Set, list, get details for, and delete server
metadata or metadata items.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
@ -104,7 +91,7 @@
</section>
<section xml:id="compute_server-addresses">
<title>Server addresses</title>
<para>Lists addresses for a specified server or a specified
<para>List addresses for a specified server or a specified
server and network.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
@ -116,7 +103,7 @@
</section>
<section xml:id="compute_server-actions">
<title>Server actions</title>
<para>Performs actions for a specified server, including
<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">
@ -134,7 +121,7 @@
</section>
<section xml:id="compute_flavors">
<title>Flavors</title>
<para>Lists available flavors and gets details for a specified
<para>List available flavors and get details for a specified
flavor. A flavor is a hardware configuration for a server.
Each flavor is a unique combination of disk space and
memory capacity.</para>
@ -155,9 +142,9 @@
</section>
<section xml:id="compute_images">
<title>Images</title>
<para>Lists available images, gets details for a specified
image, and deletes an image.</para>
<para>Also, sets, lists, gets details for, and deletes image
<para>List available images, get details for a specified
image, and delete an image.</para>
<para>Also, set, list, get details for, and delete image
metadata.</para>
<para>An image is a collection of files that you use to create
or rebuild a server. By default, operators provide
@ -182,7 +169,7 @@
</section>
<section xml:id="compute_image_metadata">
<title>Image metadata</title>
<para>Sets, lists, gets details for, and deletes image
<para>Set, list, get details for, and delete image
metadata or metadata items.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource

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

@ -10,36 +10,35 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="compute-ext-v2">
<title>Compute API v2 extensions</title>
<para>Adds capabilities to the core Compute API. Use extensions to
add features, MIME types, actions, states, headers,
parameters, and resources to the core API. Query the Compute
API to list available extensions with a &GET; request to
v2/extensions.</para>
<para>Extensions add features, MIME types, actions, states,
headers, parameters, and resources to the core Compute API.
Query the Compute API to list available extensions with a
&GET; request to v2/extensions.</para>
<section xml:id="ext-action">
<title>Server admin actions (action)</title>
<para>Permits administrators to perform actions on a server.
Specify the action in the request body.</para>
<para>Administrator only. Perform actions on a server. Specify
the action in the request body.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-admin-actions.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-console-output">
<title>Server console output (os-console-output)</title>
<para>Gets console output for a server instance.</para>
<para>Get console output for a server instance.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/compute-api/src/ext/os-console-output.wadl"
/>
</section>
<section xml:id="ext-os-consoles">
<title>Server console (os-consoles)</title>
<para>Gets a console for a server instance.</para>
<para>Get a console for a server instance.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-consoles.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-deferred-delete">
<title>Server deferred delete (os-deferred-delete)</title>
<para>Force-deletes a server or restores a deleted
<para>Force-delete a server or restore a deleted
server.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-deferred-delete.wadl"
@ -47,24 +46,23 @@
</section>
<section xml:id="ext-diagnostics">
<title>Server diagnostics (diagnostics)</title>
<para>Gets the usage data for a server.</para>
<para>Get the usage data for a server.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-diagnostics.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-flavor-access">
<title>Flavor access (flavors)</title>
<para>Creates and gets details for private flavors. Also,
lists, adds and removes tenants' access to private
flavors.</para>
<para>Create and get details for private flavors. Also, list,
add, and remove tenants' access to private flavors.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-flavor-access.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-flv-disabled">
<title>Flavors with FlavorDisabled attribute (flavors)</title>
<para>Gets details for a flavor, and lists details for
available flavors. Includes the
<para>Get details for a flavor, and list details for available
flavors. Includes the
<literal>OS-FLV-DISABLED:disabled</literal> extended
attribute.</para>
<wadl:resources
@ -73,8 +71,8 @@
</section>
<section xml:id="ext-os-flavor-extra-specs">
<title>Flavor extra-specs (os-extra-specs)</title>
<para>Lists, creates, and updates the extra-specs or keys for
a flavor.</para>
<para>List, create, and update the extra-specs or keys for a
flavor.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-flavor-extra-specs.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
@ -82,8 +80,8 @@
<section xml:id="ext-os-flavor-rxtx">
<title>Flavors with rxtx_factor extended attribute
(flavors)</title>
<para>Creates a flavor, gets details for a specified flavor,
and lists details for available flavors. Includes the
<para>Create a flavor, get details for a specified flavor, and
list details for available flavors. Includes the
<literal>rxtx_factor</literal> extended attribute,
related to configured bandwidth cap values.</para>
<wadl:resources
@ -92,7 +90,7 @@
</section>
<section xml:id="ext-os-flavorextradata">
<title>Flavors with extended attributes (flavors)</title>
<para>Creates a flavor, gets details for a flavor, and lists
<para>Create a flavor, get details for a flavor, and list
details for available flavors. Includes the
<literal>rxtx_factor</literal>,
<literal>OS-FLV-EXT-DATA:ephemeral</literal>, and
@ -103,14 +101,14 @@
</section>
<section xml:id="ext-os-flavormanage">
<title>Flavors create or delete (flavors)</title>
<para>Creates or deletes flavors.</para>
<para>Create or delete flavors.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-flavormanage.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-ext-img-size">
<title>Images with size attribute (images)</title>
<para>Lists details for available images or gets details for a
<para>List details for available images or get details for a
specified image. Includes the
<code>OS-EXT-IMG-SIZE:size</code> extended attribute,
which shows the image size.</para>
@ -120,7 +118,7 @@
</section>
<section xml:id="ext-limits">
<title>Limits with project usage (limits)</title>
<para>Extends limits to show the project usage. Shows
<para>Extend limits to show the project usage. Show
information such as RAM or instance quotas usage.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-used-limits.wadl"
@ -129,8 +127,8 @@
<section xml:id="ext-compute_limits_admins">
<title>Limits with project usage for administrators
(limits)</title>
<para>Extends limits to enable administrators to show the
project usage for a specified customer project ID. Shows
<para>Extend limits to enable administrators to show the
project usage for a specified customer project ID. Show
information such as RAM or instance quotas usage.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/compute-api/src/ext/os-used-limits-for-admins.wadl"
@ -138,7 +136,7 @@
</section>
<section xml:id="ext-os-agents">
<title>Guest agents (os-agents)</title>
<para>Creates, updates, and deletes guest agents. Use guest
<para>Create, update, and delete 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
@ -151,16 +149,16 @@
</section>
<section xml:id="ext-os-aggregates">
<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>
<para>Create and manage 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/ext/os-aggregates.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-attach-interfaces">
<title>Attach interfaces (os-attach-interfaces)</title>
<para>Creates, lists, and gets details for port
<para>Create, list, and get details for port
interfaces.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-attach-interfaces.wadl"
@ -168,14 +166,14 @@
</section>
<section xml:id="ext-os-certificates">
<title>Root certificates (os-certificates)</title>
<para>Creates and shows details for a root certificate.</para>
<para>Creates and show details for a root certificate.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-certificates.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-cloudpipe">
<title>Cloudpipe (os-cloudpipe)</title>
<para>Manages virtual VPNs for projects.</para>
<para>Manage virtual VPNs for projects.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-cloudpipe.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
@ -189,7 +187,7 @@
<section xml:id="ext-os-fixed-ips">
<title>Fixed IPs (os-fixed-ips)</title>
<para>Shows data for a specified fixed IP, such as host name,
CIDR, and address. Also, reserves or frees a fixed
CIDR, and address. Also, reserve or free a fixed
IP.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-fixed-ips.wadl"
@ -197,8 +195,8 @@
</section>
<section xml:id="ext-os-floating-ip-dns">
<title>Floating IP DNS records (os-floating-ip-dns)</title>
<para>Manages DNS records associated with IP addresses
allocated by the Floating IPs extension. Requests are
<para>Manage DNS records associated with IP addresses
allocated by the floating IPs extension. Requests are
dispatched to a DNS driver selected at startup.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-floating-ip-dns.wadl"
@ -206,14 +204,14 @@
</section>
<section xml:id="ext-os-floating-ip-pools">
<title>Floating IP pools (os-floating-ip-pools)</title>
<para>Manages groups of floating IPs.</para>
<para>Manage groups of floating IPs.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-floating-ip-pools.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-floating-ips">
<title>Floating IPs (os-floating-ips)</title>
<para>Assigns and allocates floating IP addresses to instances
<para>Assign and allocate floating IP addresses to instances
that run in an OpenStack cloud.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-floating-ips.wadl"
@ -221,8 +219,8 @@
</section>
<section xml:id="ext-os-floating-ips-bulk">
<title>Floating IPs bulk (os-floating-ips-bulk)</title>
<para>Bulk creates, deletes, and lists floating IPs. By
default, the pool is named nova. Use the
<para>Bulk create, delete, and list floating IPs. By default,
the pool is named nova. Use the
<literal>os-floating-ip-pools</literal> extension to
view available pools.</para>
<wadl:resources
@ -231,14 +229,14 @@
</section>
<section xml:id="ext-os-hosts">
<title>Hosts (os-hosts)</title>
<para>Manages physical hosts.</para>
<para>Manage physical hosts.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-hosts.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-hypervisors">
<title>Hypervisors (os-hypervisors)</title>
<para>Displays extra statistical information from the machine
<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
@ -247,33 +245,32 @@
</section>
<section xml:id="ext-os-instance-actions">
<title>Server actions (os-instance-actions)</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>
<para>List available actions for a specified server.
Administrators can get details for a specified action for
a specified server.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-instance-actions.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-keypairs">
<title>Keypairs (os-keypairs)</title>
<para>Generates, imports, and deletes SSH keys.</para>
<para>Generate, import, and delete SSH keys.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-keypairs.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-migrations">
<title>Migrations (os-migrations)</title>
<para>Enables administrative users to fetch in-progress
migrations for a region or a specified cell in a
region.</para>
<para>Administrators only. Fetch in-progress migrations for a
region or a specified cell in a region.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-migrations.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-networks">
<title>Networks (os-networks)</title>
<para>Shows network information for or deletes networks. Also,
disassociates a network from a project if you use vlan
<para>Show network information for or delete networks. Also,
disassociate a network from a project if you use vlan
mode.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-networks.wadl"
@ -281,8 +278,8 @@
</section>
<section xml:id="ext-os-quota-sets">
<title>Quota sets (os-quota-sets)</title>
<para>Permits administrators, depending on policy settings, to
view quotas for a tenant and view and update default
<para>Administrators only, depending on policy settings. View
quotas for a tenant and view and update default
quotas.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-quota-sets.wadl"
@ -290,7 +287,7 @@
</section>
<section xml:id="ext-os-rescue">
<title>Server rescue and unrescue (os-rescue)</title>
<para>Puts a server into rescue mode or unrescues a server in
<para>Put a server into rescue mode or unrescue a server in
rescue mode.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-rescue.wadl"
@ -298,16 +295,15 @@
</section>
<section xml:id="ext-os-server-start-stop">
<title>Server start and stop (os-server-start-stop)</title>
<para>Starts a stopped server or stops a running
server.</para>
<para>Start a stopped server or stop a running server.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-server-start-stop.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-security-groups">
<title>Security groups (os-security-groups)</title>
<para>Lists, shows information for, creates, and deletes
security groups.</para>
<para>List, show information for, create, and delete security
groups.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-security-groups.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
@ -315,23 +311,23 @@
<section xml:id="ext-os-security-group-default-rules">
<title>Rules for default security group
(os-security-group-default-rules)</title>
<para>Lists, shows information for, and creates default
security group rules.</para>
<para>List, show information for, and create default security
group rules.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-security-group-default-rules.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-server-password">
<title>Server password (os-server-password)</title>
<para>Retrieves and resets the encrypted admin password set
through metadata service.</para>
<para>Get and reset the encrypted admin password set through
the metadata service.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-server-password.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-services">
<title>Manage services (os-services)</title>
<para>Lists, enables, and disables Compute services in all
<para>List, enable, and disable Compute services in all
hosts.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-services.wadl"
@ -339,7 +335,7 @@
</section>
<section xml:id="ext-os-simple-tenant-usage">
<title>Usage reports (os-simple-tenant-usage)</title>
<para>Reports usage statistics on compute and storage
<para>Report usage statistics on compute and storage
resources.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-simple-tenant-usage.wadl"
@ -347,7 +343,7 @@
</section>
<section xml:id="ext-os-virtual-interfaces">
<title>Virtual interfaces (os-virtual-interfaces)</title>
<para>Lists the virtual interfaces for a specified server
<para>List the virtual interfaces for a specified server
instance.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-virtual-interfaces.wadl"
@ -355,7 +351,7 @@
</section>
<section xml:id="ext-os-volume">
<title>Volume extension (os-volumes, os-snapshots)</title>
<para>Manages volumes and snapshots for use with the Compute
<para>Manage volumes and snapshots for use with the Compute
API.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-volume.wadl"
@ -363,10 +359,10 @@
</section>
<section xml:id="ext-os-volume_attachments">
<title>Volume attachments (os-volume_attachments)</title>
<para>Attaches volumes created through the volume API to
server instances. Also, lists volume attachments for a
server instance, gets volume details for a volume
attachment, and deletes a volume attachment.</para>
<para>Attach volumes created through the volume API to server
instances. Also, list volume attachments for a server
instance, get volume details for a volume attachment, and
delete a volume attachment.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-volume_attachments.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
@ -374,7 +370,7 @@
<section xml:id="ext-os-block-device-mapping-v2-boot">
<title>Servers with block device mapping format
(servers)</title>
<para>Creates a server with a block device mapping.</para>
<para>Create a server with a block device mapping.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-block-device-mapping-v2-boot.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
@ -382,7 +378,7 @@
<section xml:id="ext-os-server-os-ext-ips-mac">
<title>Server OS-EXT-IPS-MAC:mac_addr extended attribute
(servers)</title>
<para>Adds OS-EXT-IPS-MAC:mac_addr extended attribute when you
<para>Add OS-EXT-IPS-MAC:mac_addr extended attribute when you
create, show information for, or list servers.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-server-OS-EXT-IPS-MAC.wadl"
@ -390,7 +386,7 @@
</section>
<section xml:id="ext-os-createserverext">
<title>Configuration drive (servers)</title>
<para>Extends servers and images with a configuration
<para>Extend servers and images with a configuration
drive.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-createserverext.wadl"
@ -399,7 +395,7 @@
<section xml:id="ext-os-ext-az">
<title>Servers with extended availability zones
(servers)</title>
<para>Shows the instance availability zone for compute nodes
<para>Show the instance availability zone for compute nodes
(nova-compute). Internal services appear in their own
<emphasis role="italic">internal</emphasis>
availability zone.</para>
@ -410,13 +406,13 @@
<section xml:id="ext-os-disk-config-servers">
<title>Servers and images with disk config (servers,
images)</title>
<para>Extends servers with the diskConfig attribute.</para>
<para>Extend servers with the diskConfig attribute.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/compute-api/src/ext/os-disk-config.wadl"/>
</section>
<section xml:id="ext-os-ext-ips">
<title>Server IP type (servers)</title>
<para>Shows the type of the IP addresses assigned to an
<para>Show the type of the IP addresses assigned to an
instance. Type is either fixed or floating.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-ext-ips.wadl"
@ -424,14 +420,14 @@
</section>
<section xml:id="ext-os-extended-server-attributes">
<title>Server extended attributes (servers)</title>
<para>Shows metadata for servers.</para>
<para>Show metadata for servers.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-extended-server-attributes.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-extended-status">
<title>Server extended status (servers)</title>
<para>Shows extended status information, vm_state, task_state,
<para>Show extended status information, vm_state, task_state,
and power_state, in detailed server responses.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-extended-status.wadl"
@ -439,14 +435,14 @@
</section>
<section xml:id="ext-os-scheduler-hints">
<title>Servers with scheduler hints (servers)</title>
<para>Creates a server with scheduler hints.</para>
<para>Create a server with scheduler hints.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-scheduler-hints.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-multi-server-create">
<title>Servers multiple create (servers)</title>
<para>Creates one or more servers with an optional reservation
<para>Create one or more servers with an optional reservation
ID. The request and response examples show how to create
multiple servers with or without a reservation ID.</para>
<wadl:resources

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

@ -7,9 +7,10 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="image-v1">
<title>Image Service API v1</title>
<para>Loads images for use at launch time by the Compute API.
Also, assigns metadata to images. Some cloud implementations
do not expose this API and offer pretested images only.</para>
<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
pretested images only.</para>
<wadl:resources href="../wadls/image-api/src/v1/os-image-1.0.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</chapter>

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

@ -10,15 +10,15 @@
<para>Image Service API v2.0, API v2.1, and API v2.2.</para>
<section xml:id="images-v2">
<title>Images</title>
<para>Creates, updates, and deletes image metadata records.
Enables users to share images with each other. Also,
uploads and downloads raw image data.</para>
<para>Create, update, and delete image metadata records.
Enable users to share images with each other. Also,
upload and download raw image data.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/image-api/src/v2/os-image-v2.wadl"/>
</section>
<section xml:id="image-schemas-v2">
<title>Image schemas</title>
<para>Gets a JSON-schema document that represents an images or
<para>Get a JSON-schema document that represents an images or
image entity.</para>
<wadl:resources
href="../wadls/image-api/src/v2/os-image-schemas-v2.wadl"

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

@ -7,7 +7,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="netconn-v2">
<title>Networking API v2.0</title>
<para>Provides virtual networking services among devices that are
<para>Use virtual networking services among devices that are
managed by the OpenStack Compute service. The Networking API
v2.0 combines the API v1.1 functionality with some essential
Internet Protocol Address Management (IPAM) functionality.

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

@ -7,7 +7,7 @@
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>
<para>Manages the accounts, containers, and objects in the Object
<para>Manage the accounts, containers, and objects in the Object
Storage system.</para>
<para>To run the cURL command examples for these requests, set
these environment variables:</para>
@ -46,9 +46,8 @@ Accept-Ranges: bytes</programlisting>
>Header Field Definitions</link>.</para>
<section xml:id="storage_account_services">
<title>Accounts</title>
<para>Lists containers for a specified account. Creates,
updates, and deletes account metadata. Shows account
metadata.</para>
<para>List containers for a specified account. Create,
update, show, and delete account metadata.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/object-api/src/os-object-api-1.0.wadl#account">
@ -60,9 +59,9 @@ Accept-Ranges: bytes</programlisting>
</section>
<section xml:id="storage_container_services">
<title>Containers</title>
<para>Lists objects in a specified container. Creates, shows
details for, and deletes containers. Creates, updates,
shows, and deletes container metadata.</para>
<para>List objects in a specified container. Create, show
details for, and delete containers. Create, update,
show, and delete container metadata.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/object-api/src/os-object-api-1.0.wadl#container">
@ -76,9 +75,9 @@ Accept-Ranges: bytes</programlisting>
</section>
<section xml:id="storage_object_services">
<title>Objects</title>
<para>Creates, replaces, shows details for, and deletes
objects. Copies objects with another object with a new or
different name. Updates object metadata.</para>
<para>Create, replace, show details for, and delete
objects. Copy objects from another object with a new or
different name. Update object metadata.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/object-api/src/os-object-api-1.0.wadl#object">

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

@ -7,7 +7,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="orchestration-v1">
<title>Orchestration API v1.0</title>
<para>Uses a template language to orchestrate OpenStack
<para>Use a template language to orchestrate OpenStack
services.</para>
<section xml:id="stacks">
<title>Stacks</title>

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

@ -7,7 +7,7 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="telemetry-v2">
<title>Telemetry API v2.0</title>
<para>Manages telemetry operations.</para>
<para>Manage telemetry operations.</para>
<section xml:id="alarms">
<title>Alarms</title>
<para>Lists, creates, gets details for, updates, and deletes
@ -36,7 +36,7 @@
</section>
<section xml:id="meters">
<title>Meters</title>
<para>Gets information for meters.</para>
<para>Get information for meters.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#meters">
@ -55,7 +55,7 @@
</section>
<section xml:id="resources">
<title>Resources</title>
<para>Gets information for resources.</para>
<para>Get information for resources.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#resources">

45
api-ref/src/docbkx/itemizedlist-service-list.xml Normal file
View File

@ -0,0 +1,45 @@
<?xml version="1.0" encoding="UTF-8"?>
<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">
<listitem>
<para><link xlink:href="api-ref-blockstorage.html">Block
Storage Service API</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-compute.html">Compute
API</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-compute-ext.html">Compute API
extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-identity.html">Identity
Service API and extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-image.html">Image Service
API</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-networking.html">Networking
API and extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-objectstorage.html">Object
Storage API</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-orchestration.html"
>Orchestration API</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-telemetry.html">Telemetry
API</link></para>
</listitem>
</itemizedlist>

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

@ -1,3 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE preface[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
@ -16,44 +17,7 @@
<title>OpenStack API Complete Reference</title>
<para>Use the OpenStack APIs and extensions in your OpenStack
cloud.</para>
<itemizedlist xml:id="service-list">
<listitem>
<para><link xlink:href="api-ref-blockstorage.html">Block
Storage Service API</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-compute.html">Compute
API</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-compute-ext.html">Compute
API extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-identity.html">Identity
Service API and extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-image.html">Image Service
API</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-networking.html"
>Networking API and extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-objectstorage.html">Object
Storage API</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-orchestration.html"
>Orchestration API</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-telemetry.html">Telemetry
API</link></para>
</listitem>
</itemizedlist>
<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 Service

2
pom.xml
View File

@ -40,7 +40,7 @@
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<version>1.13.0</version>
<version>1.13.1-SNAPSHOT</version>
</plugin>
</plugins>
</build>