diff --git a/api-guide/pom.xml b/api-guide/pom.xml index dbc1434eb..aeacf404c 100644 --- a/api-guide/pom.xml +++ b/api-guide/pom.xml @@ -26,7 +26,7 @@ clouddocs-maven-plugin - + os-api-guide diff --git a/api-ref-guides/pom.xml b/api-ref-guides/pom.xml new file mode 100644 index 000000000..6de10a538 --- /dev/null +++ b/api-ref-guides/pom.xml @@ -0,0 +1,180 @@ + + + org.openstack.docs + parent-pom + 1.0.0-SNAPSHOT + ../pom.xml + + 4.0.0 + openstack-api-ref-guides + jar + OpenStack API Complete Reference Guides + + + local + 0 + + + + + + + + com.rackspace.cloud.api + clouddocs-maven-plugin + + + + + os-api-ref-blockstorage + + generate-pdf + + generate-sources + + bk-api-ref-blockstorage.xml + api-ref-blockstorage + + + + os-api-ref-compute-v2 + + generate-pdf + + generate-sources + + bk-api-ref-compute-v2.xml + api-ref-compute-v2 + + + + os-api-ref-compute-v2-ext + + generate-pdf + + generate-sources + + bk-api-ref-compute-v2-ext.xml + api-ref-compute-v2-ext + + + + os-api-ref-compute-v3 + + generate-pdf + + generate-sources + + bk-api-ref-compute-v3.xml + api-ref-compute-v3 + + + + os-api-ref-identity + + generate-pdf + + generate-sources + + bk-api-ref-identity.xml + api-ref-identity + + + + os-api-ref-image + + generate-pdf + + generate-sources + + bk-api-ref-image.xml + api-ref-image + + + + os-api-ref-networking + + generate-pdf + + generate-sources + + bk-api-ref-networking.xml + api-ref-networking + + + + os-api-ref-objectstorage + + generate-pdf + + generate-sources + + bk-api-ref-objectstorage.xml + api-ref-objectstorage + + + + os-api-ref-orchestration + + generate-pdf + + generate-sources + + bk-api-ref-orchestration.xml + api-ref-orchestration + + + + os-api-ref-telemetry + + generate-pdf + + generate-sources + + bk-api-ref-telemetry.xml + api-ref-telemetry + + + + + + api-ref-guides + appendix toc,title + article/appendix nop + article toc,title + book toc,title + + part toc,title + qandadiv toc + qandaset to + reference toc,title + set toc,title + true + src + openstack + 1 + true + + false + external + 0 + + + + + diff --git a/api-ref/src/docbkx/bk-api-ref-blockstorage.xml b/api-ref-guides/src/bk-api-ref-blockstorage.xml similarity index 91% rename from api-ref/src/docbkx/bk-api-ref-blockstorage.xml rename to api-ref-guides/src/bk-api-ref-blockstorage.xml index b56c20123..74d6f9ddf 100644 --- a/api-ref/src/docbkx/bk-api-ref-blockstorage.xml +++ b/api-ref-guides/src/bk-api-ref-blockstorage.xml @@ -33,7 +33,7 @@ - 2010-2013 + 2010-2014 OpenStack Foundation OpenStack Block Storage @@ -45,6 +45,6 @@ - - + + diff --git a/api-ref/src/docbkx/bk-api-ref-compute-v2-ext.xml b/api-ref-guides/src/bk-api-ref-compute-v2-ext.xml similarity index 91% rename from api-ref/src/docbkx/bk-api-ref-compute-v2-ext.xml rename to api-ref-guides/src/bk-api-ref-compute-v2-ext.xml index b6e0331e9..b24c1f4b6 100644 --- a/api-ref/src/docbkx/bk-api-ref-compute-v2-ext.xml +++ b/api-ref-guides/src/bk-api-ref-compute-v2-ext.xml @@ -32,7 +32,7 @@ - - + + diff --git a/api-ref/src/docbkx/bk-api-ref-compute-v2.xml b/api-ref-guides/src/bk-api-ref-compute-v2.xml similarity index 94% rename from api-ref/src/docbkx/bk-api-ref-compute-v2.xml rename to api-ref-guides/src/bk-api-ref-compute-v2.xml index 97c844790..add2aab70 100644 --- a/api-ref/src/docbkx/bk-api-ref-compute-v2.xml +++ b/api-ref-guides/src/bk-api-ref-compute-v2.xml @@ -45,6 +45,6 @@ - - + + diff --git a/api-ref/src/docbkx/bk-api-ref-compute-v3.xml b/api-ref-guides/src/bk-api-ref-compute-v3.xml similarity index 81% rename from api-ref/src/docbkx/bk-api-ref-compute-v3.xml rename to api-ref-guides/src/bk-api-ref-compute-v3.xml index efe805825..37a0809a1 100644 --- a/api-ref/src/docbkx/bk-api-ref-compute-v3.xml +++ b/api-ref-guides/src/bk-api-ref-compute-v3.xml @@ -8,8 +8,8 @@ version="5.0-extension RackBook-2.0" status="EXPERIMENTAL" xml:id="api.openstack.org-compute-v3-pdf"> - OpenStack Compute API v2 Reference - API Reference + OpenStack Compute API v3 Reference (EXPERIMENTAL) + API Reference (EXPERIMENTAL) @@ -32,6 +32,6 @@ - - + + diff --git a/api-ref/src/docbkx/bk-api-ref-identity.xml b/api-ref-guides/src/bk-api-ref-identity.xml similarity index 79% rename from api-ref/src/docbkx/bk-api-ref-identity.xml rename to api-ref-guides/src/bk-api-ref-identity.xml index 91718ca04..4690dc76e 100644 --- a/api-ref/src/docbkx/bk-api-ref-identity.xml +++ b/api-ref-guides/src/bk-api-ref-identity.xml @@ -32,7 +32,7 @@ - 2010-2013 + 2010-2014 OpenStack Foundation OpenStack Identity @@ -44,10 +44,10 @@ - - - - - - + + + + + + diff --git a/api-ref/src/docbkx/bk-api-ref-image.xml b/api-ref-guides/src/bk-api-ref-image.xml similarity index 84% rename from api-ref/src/docbkx/bk-api-ref-image.xml rename to api-ref-guides/src/bk-api-ref-image.xml index fc17595ac..d20535c34 100644 --- a/api-ref/src/docbkx/bk-api-ref-image.xml +++ b/api-ref-guides/src/bk-api-ref-image.xml @@ -20,7 +20,7 @@ - 2010-2013 + 2010-2014 OpenStack Foundation OpenStack Image Service @@ -32,7 +32,7 @@ - - - + + + diff --git a/api-ref/src/docbkx/bk-api-ref-networking.xml b/api-ref-guides/src/bk-api-ref-networking.xml similarity index 85% rename from api-ref/src/docbkx/bk-api-ref-networking.xml rename to api-ref-guides/src/bk-api-ref-networking.xml index 1d27b8d76..1b9a27c89 100644 --- a/api-ref/src/docbkx/bk-api-ref-networking.xml +++ b/api-ref-guides/src/bk-api-ref-networking.xml @@ -23,7 +23,7 @@ - 2010-2013 + 2010-2014 OpenStack Foundation OpenStack Networking @@ -35,7 +35,7 @@ - - - + + + diff --git a/api-ref/src/docbkx/bk-api-ref-objectstorage.xml b/api-ref-guides/src/bk-api-ref-objectstorage.xml similarity index 88% rename from api-ref/src/docbkx/bk-api-ref-objectstorage.xml rename to api-ref-guides/src/bk-api-ref-objectstorage.xml index dee3d802f..eaf66016b 100644 --- a/api-ref/src/docbkx/bk-api-ref-objectstorage.xml +++ b/api-ref-guides/src/bk-api-ref-objectstorage.xml @@ -20,7 +20,7 @@ - 2010-2013 + 2010-2014 OpenStack Foundation OpenStack Object Storage @@ -32,6 +32,6 @@ - - + + diff --git a/api-ref/src/docbkx/bk-api-ref-orchestration.xml b/api-ref-guides/src/bk-api-ref-orchestration.xml similarity index 88% rename from api-ref/src/docbkx/bk-api-ref-orchestration.xml rename to api-ref-guides/src/bk-api-ref-orchestration.xml index 68c29bc5c..06c41f905 100644 --- a/api-ref/src/docbkx/bk-api-ref-orchestration.xml +++ b/api-ref-guides/src/bk-api-ref-orchestration.xml @@ -20,7 +20,7 @@ - 2010-2013 + 2010-2014 OpenStack Foundation OpenStack Orchestration @@ -32,6 +32,6 @@ - - + + diff --git a/api-ref/src/docbkx/bk-api-ref-telemetry.xml b/api-ref-guides/src/bk-api-ref-telemetry.xml similarity index 88% rename from api-ref/src/docbkx/bk-api-ref-telemetry.xml rename to api-ref-guides/src/bk-api-ref-telemetry.xml index 59c3e5e89..474a64475 100644 --- a/api-ref/src/docbkx/bk-api-ref-telemetry.xml +++ b/api-ref-guides/src/bk-api-ref-telemetry.xml @@ -20,7 +20,7 @@ - 2010-2013 + 2010-2014 OpenStack Foundation OpenStack Metering @@ -32,6 +32,6 @@ - - + + diff --git a/api-ref-guides/src/bk-api-ref.xml b/api-ref-guides/src/bk-api-ref.xml new file mode 100644 index 000000000..d36d8a534 --- /dev/null +++ b/api-ref-guides/src/bk-api-ref.xml @@ -0,0 +1,52 @@ + + + + OpenStack API Complete Reference + API Complete Reference + + + + + + + OpenStack Foundation + + + + 2010-2014 + OpenStack Foundation + + OpenStack + + + + Copyright details are filled in by the + template. + + + + + + + + + + + + + + + + + + + + + diff --git a/api-ref-guides/src/preface.xml b/api-ref-guides/src/preface.xml new file mode 100644 index 000000000..1b473c224 --- /dev/null +++ b/api-ref-guides/src/preface.xml @@ -0,0 +1,29 @@ + + + +]> + + Preface + Use the OpenStack APIs and extensions in your OpenStack + cloud. + + You must install the packages for each API separately. After + you authenticate through the Identity API, + you can use the other APIs and extensions to launch server + instances, create images, assign metadata to instances and + images, create containers and objects, and complete other + actions in your OpenStack cloud. To get started with the APIs, + see the OpenStack API Quick Start. +   + diff --git a/api-ref/pom.xml b/api-ref/pom.xml index 41bb4b9a3..8dd770088 100644 --- a/api-ref/pom.xml +++ b/api-ref/pom.xml @@ -46,127 +46,7 @@ - + diff --git a/api-ref/src/docbkx/api-ref-compute-v2-ext.xml b/api-ref/src/docbkx/api-ref-compute-v2-ext.xml index af1ed9431..0e25c31e3 100644 --- a/api-ref/src/docbkx/api-ref-compute-v2-ext.xml +++ b/api-ref/src/docbkx/api-ref-compute-v2-ext.xml @@ -16,6 +16,6 @@ - + diff --git a/api-ref/src/docbkx/bk-api-ref.xml b/api-ref/src/docbkx/bk-api-ref.xml deleted file mode 100644 index b3bc5c901..000000000 --- a/api-ref/src/docbkx/bk-api-ref.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - OpenStack API Reference - API Reference - - - - - - - OpenStack Foundation - - - - 2010-2013 - OpenStack Foundation - - OpenStack - - - - Copyright details are filled in by the - template. - - - - - - - - - - - - - - - - - - - - - diff --git a/api-ref/src/docbkx/ch_blockstorage-api.xml b/api-ref/src/docbkx/ch_blockstorage-api.xml index 4db060083..de8d45748 100644 --- a/api-ref/src/docbkx/ch_blockstorage-api.xml +++ b/api-ref/src/docbkx/ch_blockstorage-api.xml @@ -5,7 +5,7 @@ xmlns:linkend="http://www.w3.org/1999/linkend" xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" - version="5.0-extension RackBook-2.0" xml:id="blockstorage-v2"> + version="5.0-extension RackBook-2.0" xml:id="blockstorage-v2" role="api-reference"> Block Storage API v2.0 Manage volumes and snapshots for use with the Block Storage API, also known as cinder services. @@ -13,16 +13,16 @@ Volumes + href="../wadls/volume-api/src/v2/volume-api-v2.wadl#volumes"> + href="../wadls/volume-api/src/v2/volume-api-v2.wadl#detail"> + href="../wadls/volume-api/src/v2/volume-api-v2.wadl#volume_id"> @@ -33,11 +33,11 @@ Volume types + href="../wadls/volume-api/src/v2/volume-api-v2.wadl#types"> + href="../wadls/volume-api/src/v2/volume-api-v2.wadl#volume_type_id"> @@ -46,16 +46,16 @@ Snapshots + href="../wadls/volume-api/src/v2/volume-api-v2.wadl#snapshots"> + href="../wadls/volume-api/src/v2/volume-api-v2.wadl#detail-snapshot"> + href="../wadls/volume-api/src/v2/volume-api-v2.wadl#snapshot_id"> diff --git a/api-ref/src/docbkx/ch_compute-v2-ext.xml b/api-ref/src/docbkx/ch_compute-v2-ext.xml index f3d1139f8..6e62a8a24 100644 --- a/api-ref/src/docbkx/ch_compute-v2-ext.xml +++ b/api-ref/src/docbkx/ch_compute-v2-ext.xml @@ -8,7 +8,7 @@ xmlns:linkend="http://www.w3.org/1999/linkend" xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" - version="5.0-extension RackBook-2.0" xml:id="compute-ext-v2"> + version="5.0-extension RackBook-2.0" xml:id="compute-ext-v2" role="api-reference"> Compute API v2 extensions Extensions add features, MIME types, actions, states, headers, parameters, and resources to the core Compute API. @@ -239,9 +239,28 @@ Display extra statistical information from the machine that hosts the hypervisor through the API for the hypervisor (XenAPI or KVM/libvirt). - + + + + + + + + + + + + + + + + +
Server actions (os-instance-actions) @@ -415,7 +434,8 @@ images) Extend servers with the diskConfig attribute. + href="../wadls/compute-api/src/v2/ext/os-disk-config.wadl" + />
Server IP type (servers) diff --git a/api-ref/src/docbkx/ch_compute-v2.xml b/api-ref/src/docbkx/ch_compute-v2.xml index 27391ba99..933269cef 100644 --- a/api-ref/src/docbkx/ch_compute-v2.xml +++ b/api-ref/src/docbkx/ch_compute-v2.xml @@ -5,8 +5,8 @@ xmlns:linkend="http://www.w3.org/1999/linkend" xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" - version="5.0-extension RackBook-2.0" xml:id="compute-core-v2"> - Compute API v2 + version="5.0-extension RackBook-2.0" xml:id="compute-core-v2" role="api-reference"> + Compute API v2 Launch virtual machines from images or images stored on persistent volumes. API v1.1 is identical to API v2.
@@ -65,27 +65,26 @@ href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#server_id"> - +
Server metadata - Set, list, get details for, and delete server + Show details for, set, update, and delete server metadata or metadata items. - - - - + href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#server_metadata"> + + + - - - + href="../wadls/compute-api/src/v2/wadl/os-compute-2.wadl#ServerMetadataKey"> + + +
@@ -103,9 +102,9 @@
Server actions - Perform actions for a specified server, including - change administrator password, reboot, rebuild, resize, - and create image from server. + Perform actions for a specified server, including change + administrator password, reboot, rebuild, resize, and + create image from server. @@ -169,21 +168,20 @@
Image metadata - Set, list, get details for, and delete image - metadata or metadata items. + Show details for, set, update, and delete image metadata + or metadata items. - - - - + + + - - - + + +
diff --git a/api-ref/src/docbkx/ch_compute-v3.xml b/api-ref/src/docbkx/ch_compute-v3.xml index b583e5c8c..aaa5f564d 100755 --- a/api-ref/src/docbkx/ch_compute-v3.xml +++ b/api-ref/src/docbkx/ch_compute-v3.xml @@ -18,16 +18,37 @@ xmlns:linkend="http://www.w3.org/1999/linkend" xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" - version="5.0-extension RackBook-2.0" xml:id="compute-ext-v3"> + version="5.0-extension RackBook-2.0" xml:id="compute-ext-v3" role="api-reference"> Compute API v3 (EXPERIMENTAL) Query the Compute API to list available extensions with a &GET; request to v3/extensions.
- Server admin actions - Permits administrators to perform actions on a server. - Specify the action in the request body. + Server admin actions (servers) + Administrators only. Perform actions on a server. Specify + the action in the request body. +
+
+ Guest agents (os-agents) + Creates, updates, and deletes guest agents. Use guest agents + to access files on the disk, configure networking, or run other + applications or scripts in the guest while it runs. This + hypervisor-specific extension is not currently enabled for KVM. + Use of guest agents is possible only if the underlying service + provider uses the Xen driver. + +
+
+ Host aggregates (os-aggregates) + Creates and manages host aggregates. An aggregate assigns + metadata to groups of compute nodes. Aggregates are only visible + to the cloud provider. +
@@ -36,29 +57,36 @@ cells, listing neighbor cells, and getting the capabilities of the local cell. +
+
+ Root certificates (os-certificates) + Creates and shows details for a root certificate. +
- Configuration Drive (os-config-drive) + Configuration drive (os-config-drive) Returns server details for a specific service ID or user.
Server deferred delete (os-deferred-delete) Force-deletes a server or restores a deleted server.
Evacuate (os-evacuate) Enables server evacuation.
@@ -68,7 +96,7 @@ (nova-compute). Internal services appear in their own internal availability zone.
@@ -76,7 +104,7 @@ (os-extended-server-attributes) Shows metadata for servers.
@@ -84,21 +112,14 @@ Shows extended status information, vm_state, task_state, and power_state, in detailed server responses. -
-
- Multinic (os-multinic) - Multiple network support. -
Flavor access (os-flavor-access) Flavor access support.
@@ -106,7 +127,14 @@ Lists, creates, deletes, and updates the extra-specs or keys for a flavor. +
+
+ Flavors manage (flavor-manage) + Support for creating and deleting flavor. +
@@ -114,63 +142,21 @@ (os-flavor-rxtx) Support to show the rxtx status of a flavor.
Flavors with extended attributes (flavors) Returns information about Flavors. -
-
- Flavors manage (flavor-manage) - Support for creating and deleting flavor. - -
-
- Limits (limits) - Provide all global and rate limit information. - -
-
- Guest Agents (os-agents) - Creates, updates, and deletes guest agents. Use guest agents - to access files on the disk, configure networking, or run other - applications or scripts in the guest while it runs. This - hypervisor-specific extension is not currently enabled for KVM. - Use of guest agents is possible only if the underlying service - provider uses the Xen driver. - -
-
- Host aggregates (os-aggregates) - Creates and manages host aggregates. An aggregate assigns - metadata to groups of compute nodes. Aggregates are only visible - to the cloud provider. - -
-
- Root certificates (os-certificates) - Creates and shows details for a root certificate. -
Hosts (os-hosts) Manages physical hosts.
@@ -179,23 +165,52 @@ hosts the hypervisor through the API for the hypervisor (XenAPI or KVM/libvirt).
- Server actions (os-instance-actions) + Server actions (servers) Permits all users to list available actions for a specified server. Permits administrators to get details for a specified action for a specified server. +
+
+ Instance usage audit log + (os-instance-usage-audit-log) + Admin-only task log monitoring. + +
+
+ Limits (limits) + Provide all global and rate limit information. +
Migrations (os-migrations) Provide data on migrations. +
+
+ Multinic (os-multinic) + Multiple network support. + +
+
+ Quota class (os-quota-class-sets) + Quota classes management support. +
@@ -204,43 +219,28 @@ view quotas for a tenant and view and update default quotas. -
-
- Quota class (os-quota-class-sets) - Quota classes management support. -
Server remote console (os-remote-consoles) - Interactive Console support. + Interactive console support.
-
- Instance Usage Audit Log - (os-instance-usage-audit-log) - Admin-only Task Log Monitoring. +
+ Server usage (os-server-usage) + Adds launched_at and terminated_at to servers.
Usage reports (os-simple-tenant-usage) Provide simple tenant usage for tenant. -
-
- Server usage (os-server-usage) - Adds launched_at and terminated_at on Servers. -
diff --git a/api-ref/src/docbkx/ch_identity-admin-v2.xml b/api-ref/src/docbkx/ch_identity-admin-v2.xml index 80188ea99..38429c454 100644 --- a/api-ref/src/docbkx/ch_identity-admin-v2.xml +++ b/api-ref/src/docbkx/ch_identity-admin-v2.xml @@ -6,7 +6,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="identity-admin-v2" - xlink:href="#identity-admin-v2"> + xlink:href="#identity-admin-v2" role="api-reference"> Identity admin API v2.0 Get an authentication token that permits access to the Compute API. diff --git a/api-ref/src/docbkx/ch_identity-v2-ext.xml b/api-ref/src/docbkx/ch_identity-v2-ext.xml index 6c946a2bb..657dd25f6 100644 --- a/api-ref/src/docbkx/ch_identity-v2-ext.xml +++ b/api-ref/src/docbkx/ch_identity-v2-ext.xml @@ -9,7 +9,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="identity-v2-ext" - xlink:href="#identity-v2-ext"> + xlink:href="#identity-v2-ext" role="api-reference"> Identity API v2.0 extensions Query the Identity API to list available extensions with a &GET; request to v2.0/extensions. diff --git a/api-ref/src/docbkx/ch_identity-v3-ext.xml b/api-ref/src/docbkx/ch_identity-v3-ext.xml index 482ba8c65..194e24525 100644 --- a/api-ref/src/docbkx/ch_identity-v3-ext.xml +++ b/api-ref/src/docbkx/ch_identity-v3-ext.xml @@ -9,7 +9,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="identity-v3-ext" - xlink:href="#identity-v3-ext"> + xlink:href="#identity-v3-ext" role="api-reference"> Identity API v3 extensions Query the Identity API to list available extensions with a &GET; request to v3/extensions. @@ -62,5 +62,8 @@ Identity API token. +
diff --git a/api-ref/src/docbkx/ch_identity-v3.xml b/api-ref/src/docbkx/ch_identity-v3.xml index 64e685138..b0e6f76fb 100644 --- a/api-ref/src/docbkx/ch_identity-v3.xml +++ b/api-ref/src/docbkx/ch_identity-v3.xml @@ -6,7 +6,7 @@ xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" version="5.0-extension RackBook-2.0" xml:id="identity-v3" - xlink:href="#identity-v3"> + xlink:href="#identity-v3" role="api-reference"> Identity API v3 Get an authentication token that permits access to the Compute API. @@ -15,7 +15,7 @@ @@ -26,7 +26,7 @@ @@ -38,9 +38,9 @@ + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#catalog"/> @@ -51,9 +51,9 @@ + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#endpoints"/> @@ -96,17 +96,17 @@ + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#domains"/> + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#domainID"/> + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#domainIDUserIDRoles"/> + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#domainIDUserIDRoleID"/> + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#domainIDGroupIDRoles"/> @@ -117,23 +117,23 @@ + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#projects"/> + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#projectID"/> + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#projectIDUsers"/> + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#projectIDUserIDRoles"/> + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#projectIDUserIDRoleID"/> + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#projectIDGroupIDRoles"/> @@ -144,15 +144,15 @@ + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#users"/> + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#userID"/> + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#userIDGroups"/> + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#userIDProjects"/> @@ -163,16 +163,16 @@ + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#groups"/> + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#groupID"/> + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#groupIDUsers"/> @@ -183,9 +183,9 @@ + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#credentials"/> @@ -196,11 +196,11 @@ + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#roles"/> + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#roleID"/> @@ -211,9 +211,9 @@ + href="../wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl#policies"/> diff --git a/api-ref/src/docbkx/ch_images-v1.xml b/api-ref/src/docbkx/ch_images-v1.xml index c79405033..032ffdca1 100644 --- a/api-ref/src/docbkx/ch_images-v1.xml +++ b/api-ref/src/docbkx/ch_images-v1.xml @@ -5,7 +5,7 @@ xmlns:linkend="http://www.w3.org/1999/linkend" xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02" - version="5.0-extension RackBook-2.0" xml:id="image-v1"> + version="5.0-extension RackBook-2.0" xml:id="image-v1" role="api-reference"> Image Service API v1 Load images for use at launch time by the Compute API. Also, assign metadata to images. diff --git a/api-ref/src/docbkx/preface.xml b/api-ref/src/docbkx/preface.xml index 244bd8915..49ba7c29b 100644 --- a/api-ref/src/docbkx/preface.xml +++ b/api-ref/src/docbkx/preface.xml @@ -13,15 +13,16 @@ OpenStack API Complete Reference Use the OpenStack APIs and extensions in your OpenStack cloud. - + You must install the packages for each API separately. After you authenticate through the Identity - API, you can use the other APIs and extensions to - launch server instances, create images, assign metadata to - instances and images, create containers and objects, and - complete other actions in your OpenStack cloud. To get started - with the APIs, see the Identity API, + you can use the other APIs and extensions to launch server + instances, create images, assign metadata to instances and + images, create containers and objects, and complete other + actions in your OpenStack cloud. To get started with the APIs, + see the OpenStack API Quick Start.   diff --git a/api-ref/src/wadls/compute-api/src/v2/common.ent b/api-ref/src/wadls/compute-api/src/v2/common.ent index 10a71b54b..93f99143d 100644 --- a/api-ref/src/wadls/compute-api/src/v2/common.ent +++ b/api-ref/src/wadls/compute-api/src/v2/common.ent @@ -83,651 +83,698 @@ - - - A time/date stamp for when the image last changed status. - - - Name of the server in URL format. - - - Name of the image as a string. - - - Value of the status of the image so that you can filter on "ACTIVE" for example. - - - UUID of the image at which you want to set a marker. - - - Integer value for the limit of values to return. - - - Value of the type of image, such as BASE, SERVER, or ALL. -
+ + + &commonFaults; + &getFaults; &inProgressFault; + + + Deletes a metadata item by key for + a specified image. &commonFaults; diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-admin-actions.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-admin-actions-v3.wadl similarity index 99% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-admin-actions.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-admin-actions-v3.wadl index 0101c3088..70385f392 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-admin-actions.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-admin-actions-v3.wadl @@ -81,7 +81,6 @@ - @@ -107,7 +106,6 @@ - @@ -207,7 +205,6 @@ - @@ -233,7 +230,6 @@ - @@ -259,7 +255,6 @@ - diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-agents.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-agents-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-agents.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-agents-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-aggregates.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-aggregates-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-aggregates.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-aggregates-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-cell.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-cells-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-cell.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-cells-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-certificate.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-certificates-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-certificate.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-certificates-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-config-drive.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-config-drive-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-config-drive.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-config-drive-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-deferred-delete.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-deferred-delete-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-deferred-delete.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-deferred-delete-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-evacuate.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-evacuate-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-evacuate.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-evacuate-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-availability-zone.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-availability-zone-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-availability-zone.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-availability-zone-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-server-attributes.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-server-attributes-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-server-attributes.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-server-attributes-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-status.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-status-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-status.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-extended-status-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-access.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-access-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-access.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-access-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/flavor-manage.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-manage-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/flavor-manage.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-manage-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-rxtx.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-rxtx-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-rxtx.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-flavor-rxtx-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/flavors.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavors-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/flavors.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-flavors-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/flavorspecs.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-flavorspecs-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/flavorspecs.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-flavorspecs-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-hosts.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-hosts-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-hosts.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-hosts-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-hypervisors.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-hypervisors-v3.wadl similarity index 75% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-hypervisors.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-hypervisors-v3.wadl index 0465bb998..1b70f5895 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-hypervisors.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-hypervisors-v3.wadl @@ -14,7 +14,17 @@ - + + + Filters the search + results by the specified + ?query={filter} query + parameter. + + @@ -40,18 +50,20 @@ - + - + - + - + @@ -64,18 +76,20 @@ - + - + - + - + @@ -87,34 +101,38 @@ - + - + - + - + - + - + - + - + @@ -127,18 +145,20 @@ - + - + - + - + @@ -151,18 +171,20 @@ - + - + - + - + @@ -175,18 +197,20 @@ - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-actions.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-actions-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-actions.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-actions-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-usage-audit-log.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-usage-audit-log-v3.wadl similarity index 75% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-usage-audit-log.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-usage-audit-log-v3.wadl index cc6b89138..c8d00de3d 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-usage-audit-log.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-instance-usage-audit-log-v3.wadl @@ -12,7 +12,14 @@ - + + + + The date and time stamp. + + @@ -27,21 +34,22 @@ Lists usage audits for a specified instance. - - + - + - + - + @@ -51,21 +59,22 @@ Lists instance usage audits that occurred before a specified time. - - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/limits.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-limits-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/limits.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-limits-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-migrations.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-migrations-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-migrations.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-migrations-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-multinic.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-multinic-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-multinic.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-multinic-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-class-sets.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-class-sets-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-class-sets.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-class-sets-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-sets.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-sets-v3.wadl similarity index 71% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-sets.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-sets-v3.wadl index aab837fe5..e5716f70a 100755 --- a/api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-sets.wadl +++ b/api-ref/src/wadls/compute-api/src/v3/wadl/os-quota-sets-v3.wadl @@ -18,8 +18,19 @@ - + + + Specify the user + in the + ?user_id={user_id} + query parameter. + + @@ -35,29 +46,30 @@ xmlns="http://docbook.org/ns/docbook"> Deletes a quota for tenant. - - Shows default quotas for tenant. + Shows default quotas for + tenant. - - + - + - + - + @@ -66,59 +78,65 @@ xmlns="http://docbook.org/ns/docbook"> Shows quotas for tenant. - - + - + - + - + - Force-updates quota for tenant. + Force-updates quota for + tenant. - + - + - + - + - + - + - + - + @@ -129,41 +147,46 @@ - + - + - + - + - + - + - + - + - Deletes quota for user. + Deletes quota for a specified + user. @@ -172,21 +195,22 @@ xmlns="http://docbook.org/ns/docbook"> Shows quota for user. - - + - + - + - + @@ -197,34 +221,38 @@ - + - + - + - + - + - + - + - + diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-remote-consoles.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-remote-consoles-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-remote-consoles.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-remote-consoles-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-server-usage.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-server-usage-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-server-usage.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-server-usage-v3.wadl diff --git a/api-ref/src/wadls/compute-api/src/v3/wadl/os-simple-tenant-usage.wadl b/api-ref/src/wadls/compute-api/src/v3/wadl/os-simple-tenant-usage-v3.wadl similarity index 100% rename from api-ref/src/wadls/compute-api/src/v3/wadl/os-simple-tenant-usage.wadl rename to api-ref/src/wadls/compute-api/src/v3/wadl/os-simple-tenant-usage-v3.wadl diff --git a/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl b/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl index 02f5344f2..99f2cd19a 100644 --- a/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl +++ b/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl @@ -711,8 +711,7 @@ + href="../samples/tenants-request-JSON.txt"/> diff --git a/api-ref/src/wadls/identity-api/src/v3/wadl/OS-OAUTH1.wadl b/api-ref/src/wadls/identity-api/src/v3/wadl/OS-OAUTH1-v3.wadl similarity index 99% rename from api-ref/src/wadls/identity-api/src/v3/wadl/OS-OAUTH1.wadl rename to api-ref/src/wadls/identity-api/src/v3/wadl/OS-OAUTH1-v3.wadl index e77ddc032..353a316c9 100644 --- a/api-ref/src/wadls/identity-api/src/v3/wadl/OS-OAUTH1.wadl +++ b/api-ref/src/wadls/identity-api/src/v3/wadl/OS-OAUTH1-v3.wadl @@ -38,7 +38,6 @@ - - + @@ -280,7 +279,6 @@ - &commonFaults; - + diff --git a/api-ref/src/wadls/identity-api/src/v3/wadl/identity-admin.wadl b/api-ref/src/wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl similarity index 100% rename from api-ref/src/wadls/identity-api/src/v3/wadl/identity-admin.wadl rename to api-ref/src/wadls/identity-api/src/v3/wadl/identity-admin-v3.wadl diff --git a/api-ref/src/wadls/volume-api/src/v1/volume-api.wadl b/api-ref/src/wadls/volume-api/src/v1/volume-api-v1.wadl similarity index 100% rename from api-ref/src/wadls/volume-api/src/v1/volume-api.wadl rename to api-ref/src/wadls/volume-api/src/v1/volume-api-v1.wadl diff --git a/api-ref/src/wadls/volume-api/src/v2/volume-api.wadl b/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl similarity index 100% rename from api-ref/src/wadls/volume-api/src/v2/volume-api.wadl rename to api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl diff --git a/doc-test.conf b/doc-test.conf index 9952ae6da..e6b25b8a6 100644 --- a/doc-test.conf +++ b/doc-test.conf @@ -18,3 +18,12 @@ target_dir = target/docbkx/html # Published at api.openstack.org/ but Jenkins will # copy directory api-ref. publish_dir = api-ref + +## API-Ref-Guides +book = api-ref-guides +target_dir = target/docbkx/pdf/ +# Published at api.openstack.org/ but Jenkins will +# copy directory api-ref. +# Note: The tox.ini file needs to move this to the proper places since +# the publish_dirs have to be different! +publish_dir = api-ref-guides diff --git a/pom.xml b/pom.xml index 4a71d35c3..928619c4c 100644 --- a/pom.xml +++ b/pom.xml @@ -12,6 +12,7 @@ api-quick-start api-guide api-ref + api-ref-guides diff --git a/tox.ini b/tox.ini index ec256ad26..34a823110 100644 --- a/tox.ini +++ b/tox.ini @@ -31,4 +31,10 @@ commands = openstack-doc-test --check-build --nocreate-index --only-book api-qui [testenv:publishdocs-api] # Prepare documents (without www) so that they can get published on # api.openstack.org with just copying publish-docs/* over. -commands = openstack-doc-test --check-build --nocreate-index --only-book api-ref +commands = + openstack-doc-test --check-build --nocreate-index --only-book api-ref + # TODO(jaegerandi,dfleming): Add "--only-book api-ref-guides" + # We need to move api-ref-guides to the proper place + # TODO(jaegerandi,dfleming): Uncomment once we're sure this is the proper + # place: + # mv publish-docs/api-ref-guides publish-docs/api-ref/