From 7837131f36c6ea30e59fdf3a6731d0abc999b5c5 Mon Sep 17 00:00:00 2001 From: Diane Fleming Date: Sun, 9 Feb 2014 19:05:24 -0600 Subject: [PATCH] Change to allow read of service names from doc file - Clouddocs-maven-plugin reads service names and links to related API ref pages from the api-ref/src/docbkx/preface.xml file - Added an xml:id to the itemizedlist in the preface.xml file to identify it as the service names/links source - Added preface to every API reference page so that each page can auto-generate the sidebar menu from the itemizedlist in the preface Partial-Bug: #1267174 Change-Id: I8871c804c2c93f4f7625fc92ed0448de40ccb751 author: diane fleming --- api-ref/pom.xml | 11 ++-- api-ref/src/docbkx/api-ref-blockstorage.xml | 16 +---- api-ref/src/docbkx/api-ref-compute-ext.xml | 1 + api-ref/src/docbkx/api-ref-compute.xml | 1 + api-ref/src/docbkx/api-ref-identity.xml | 16 +---- api-ref/src/docbkx/api-ref-image.xml | 16 +---- api-ref/src/docbkx/api-ref-networking.xml | 1 + api-ref/src/docbkx/api-ref-objectstorage.xml | 16 +---- api-ref/src/docbkx/api-ref-orchestration.xml | 16 +---- api-ref/src/docbkx/api-ref-telemetry.xml | 3 +- api-ref/src/docbkx/api-ref.xml | 2 +- api-ref/src/docbkx/ch_blockstorage-api.xml | 13 ---- api-ref/src/docbkx/ch_compute-ext.xml | 10 ---- api-ref/src/docbkx/ch_identity-v2-ext.xml | 10 ---- api-ref/src/docbkx/ch_identity-v2.xml | 13 ---- api-ref/src/docbkx/ch_identity-v3-ext.xml | 10 ---- api-ref/src/docbkx/ch_identity-v3.xml | 13 ---- api-ref/src/docbkx/ch_images-v1.xml | 13 ---- api-ref/src/docbkx/ch_images-v2.xml | 13 ---- api-ref/src/docbkx/ch_netconn-ext-v2.xml | 13 ---- api-ref/src/docbkx/ch_netconn-v2.xml | 13 ---- api-ref/src/docbkx/ch_telemetry-v2.xml | 13 ---- api-ref/src/docbkx/preface.xml | 62 ++++++++------------ 23 files changed, 46 insertions(+), 249 deletions(-) diff --git a/api-ref/pom.xml b/api-ref/pom.xml index 8d698f3ea..aa492a5d6 100644 --- a/api-ref/pom.xml +++ b/api-ref/pom.xml @@ -32,8 +32,8 @@ generate-sources - api-ref.xml, api-ref-identity.xml, - api-ref-compute.xml, api-ref-compute-ext.xml, api-ref-image.xml, + api-ref.xml, api-ref-compute-core.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, api-ref-telemetry.xml @@ -44,7 +44,7 @@ - - appendix toc,title + + appendix toc,title article/appendix nop article toc,title book toc,title chapter toc,title - section toc, title + section toc,title part toc,title qandadiv toc qandaset toc diff --git a/api-ref/src/docbkx/api-ref-blockstorage.xml b/api-ref/src/docbkx/api-ref-blockstorage.xml index 38fe7e661..3349edce9 100644 --- a/api-ref/src/docbkx/api-ref-blockstorage.xml +++ b/api-ref/src/docbkx/api-ref-blockstorage.xml @@ -1,17 +1,4 @@ - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> OpenStack Block Storage APIs - 2010-2013 + 2010-2014 + diff --git a/api-ref/src/docbkx/api-ref-compute-ext.xml b/api-ref/src/docbkx/api-ref-compute-ext.xml index 60fe0e3bd..c4110415a 100644 --- a/api-ref/src/docbkx/api-ref-compute-ext.xml +++ b/api-ref/src/docbkx/api-ref-compute-ext.xml @@ -16,5 +16,6 @@ + diff --git a/api-ref/src/docbkx/api-ref-compute.xml b/api-ref/src/docbkx/api-ref-compute.xml index ce862c858..bd6101419 100644 --- a/api-ref/src/docbkx/api-ref-compute.xml +++ b/api-ref/src/docbkx/api-ref-compute.xml @@ -16,5 +16,6 @@ + diff --git a/api-ref/src/docbkx/api-ref-identity.xml b/api-ref/src/docbkx/api-ref-identity.xml index 38b56d82f..2361c5360 100644 --- a/api-ref/src/docbkx/api-ref-identity.xml +++ b/api-ref/src/docbkx/api-ref-identity.xml @@ -1,17 +1,4 @@ - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> OpenStack Identity Service APIs and extensions - 2010-2013 + 2010-2014 + diff --git a/api-ref/src/docbkx/api-ref-image.xml b/api-ref/src/docbkx/api-ref-image.xml index cb371377c..d26af33e9 100644 --- a/api-ref/src/docbkx/api-ref-image.xml +++ b/api-ref/src/docbkx/api-ref-image.xml @@ -1,17 +1,4 @@ - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> OpenStack Image Service APIs - 2010-2013 + 2010-2014 + diff --git a/api-ref/src/docbkx/api-ref-networking.xml b/api-ref/src/docbkx/api-ref-networking.xml index 674453204..8c9919981 100644 --- a/api-ref/src/docbkx/api-ref-networking.xml +++ b/api-ref/src/docbkx/api-ref-networking.xml @@ -16,6 +16,7 @@ + diff --git a/api-ref/src/docbkx/api-ref-objectstorage.xml b/api-ref/src/docbkx/api-ref-objectstorage.xml index df3c6b1d7..39c90e8da 100644 --- a/api-ref/src/docbkx/api-ref-objectstorage.xml +++ b/api-ref/src/docbkx/api-ref-objectstorage.xml @@ -1,17 +1,4 @@ - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> OpenStack Object Storage API - 2010-2013 + 2010-2014 + diff --git a/api-ref/src/docbkx/api-ref-orchestration.xml b/api-ref/src/docbkx/api-ref-orchestration.xml index d8ea0aa96..e80aa58ba 100644 --- a/api-ref/src/docbkx/api-ref-orchestration.xml +++ b/api-ref/src/docbkx/api-ref-orchestration.xml @@ -1,17 +1,4 @@ - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> OpenStack Orchestration API - 2010-2013 + 2010-2014 + diff --git a/api-ref/src/docbkx/api-ref-telemetry.xml b/api-ref/src/docbkx/api-ref-telemetry.xml index 543a1ea15..ac2d7d2ec 100644 --- a/api-ref/src/docbkx/api-ref-telemetry.xml +++ b/api-ref/src/docbkx/api-ref-telemetry.xml @@ -10,11 +10,12 @@ OpenStack Telemetry API - 2010-2013 + 2010-2014 + diff --git a/api-ref/src/docbkx/api-ref.xml b/api-ref/src/docbkx/api-ref.xml index b6a8ed508..2dd8171db 100644 --- a/api-ref/src/docbkx/api-ref.xml +++ b/api-ref/src/docbkx/api-ref.xml @@ -20,7 +20,7 @@ xml:id="api.openstack.org"> - 2010-2013 + 2010-2014 OpenStack Foundation OpenStack diff --git a/api-ref/src/docbkx/ch_blockstorage-api.xml b/api-ref/src/docbkx/ch_blockstorage-api.xml index daf5e928e..4f2064d14 100644 --- a/api-ref/src/docbkx/ch_blockstorage-api.xml +++ b/api-ref/src/docbkx/ch_blockstorage-api.xml @@ -1,17 +1,4 @@ - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> - - - - - - GET'> -PUT'> -POST'> -DELETE'> ]> - - - - - - GET'> -PUT'> -POST'> -DELETE'> ]> - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> - - - - - - GET'> -PUT'> -POST'> -DELETE'> ]> - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> - -GET'> -PUT'> -POST'> -DELETE'> ]> - Preface - Use these OpenStack APIs and extensions in your OpenStack - cloud: - + OpenStack API Complete Reference + Use the OpenStack APIs and extensions in your OpenStack + cloud. + - Block Storage Service API + Block + Storage Service API - Compute API + Compute + API - Compute API extensions + Compute + API extensions - Identity Service API and extensions + Identity + Service API and extensions - Image Service API + Image Service + API - Networking API and extensions @@ -57,25 +46,22 @@ Storage API - Orchestration API - Telemetry API + Telemetry + API You must install the packages for each API separately. After you authenticate through the Identity Service 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 Service + 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.