From 6bdcc1f02936f3414ac727418310770e864cab4c Mon Sep 17 00:00:00 2001 From: Diane Fleming Date: Mon, 30 Mar 2015 21:00:05 -0500 Subject: [PATCH] Update to generate all PDFs. Change-Id: I22edf77b873ef6073043654d28e895140ee9774a --- api-ref-guides/pom.xml | 23 ++- .../src/bk-api-ref-blockstorage-v1.xml | 15 +- .../src/bk-api-ref-blockstorage-v2.xml | 15 +- .../src/bk-api-ref-compute-v2-ext.xml | 2 +- .../src/bk-api-ref-compute-v2.1.xml | 37 ++++ api-ref-guides/src/bk-api-ref-compute-v2.xml | 13 -- .../src/bk-api-ref-data-processing-v1.1.xml | 36 ++++ api-ref-guides/src/bk-api-ref-database-v1.xml | 36 ++++ .../src/bk-api-ref-databases-v1.xml | 23 --- api-ref-guides/src/bk-api-ref-identity-v2.xml | 15 +- api-ref-guides/src/bk-api-ref-identity-v3.xml | 15 +- .../src/bk-api-ref-networking-v2.xml | 2 +- .../src/bk-api-ref-orchestration-v1.xml | 2 +- .../src/bk-api-ref-telemetry-v2.xml | 2 +- api-ref-guides/src/bk-api-ref.xml | 1 + api-ref/src/docbkx/api-ref-compute-v2.xml | 33 ++- .../docbkx/api-ref-data-processing-v1.1.xml | 33 ++- .../src/docbkx/ch_data-processing-v1.1.xml | 115 +++++------ api-ref/src/wadls/common_project.ent | 6 + .../src/v1.1/wadl/image-registry.wadl | 10 +- .../src/v1.1/wadl/job-binaries.wadl | 7 +- .../src/v1.1/wadl/job-binary-internals.wadl | 5 +- .../src/v1.1/wadl/job-types.wadl | 44 ++-- .../src/v1.1/wadl/node-group-template.wadl | 28 +-- www/index.html | 193 +++++++++--------- 25 files changed, 375 insertions(+), 336 deletions(-) create mode 100644 api-ref-guides/src/bk-api-ref-compute-v2.1.xml create mode 100644 api-ref-guides/src/bk-api-ref-data-processing-v1.1.xml create mode 100644 api-ref-guides/src/bk-api-ref-database-v1.xml delete mode 100644 api-ref-guides/src/bk-api-ref-databases-v1.xml diff --git a/api-ref-guides/pom.xml b/api-ref-guides/pom.xml index ca601fa03..ebbec694f 100644 --- a/api-ref-guides/pom.xml +++ b/api-ref-guides/pom.xml @@ -70,8 +70,8 @@ bk-api-ref-blockstorage-v1.xml api-ref-blockstorage-v1 - - + + os-api-ref-compute-v2 generate-pdf @@ -104,17 +104,28 @@ api-ref-compute-v2.1 - - os-api-ref-databases-v1 + + os-api-ref-database-v1 generate-pdf generate-sources - bk-api-ref-databases-v1.xml - api-ref-databases-v1 + bk-api-ref-database-v1.xml + api-ref-database-v1 + + os-api-ref-data-processing-v1.1 + + generate-pdf + + generate-sources + + bk-api-ref-data-processing-v1.1.xml + api-ref-data-processing-v1.1 + + os-api-ref-identity-v3 diff --git a/api-ref-guides/src/bk-api-ref-blockstorage-v1.xml b/api-ref-guides/src/bk-api-ref-blockstorage-v1.xml index 34bf43eb0..39c6b6782 100644 --- a/api-ref-guides/src/bk-api-ref-blockstorage-v1.xml +++ b/api-ref-guides/src/bk-api-ref-blockstorage-v1.xml @@ -1,17 +1,4 @@ - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> + xml:id="api.openstack.org-blockstorage-v1-pdf"> OpenStack Block Storage API v1 Reference API Reference diff --git a/api-ref-guides/src/bk-api-ref-blockstorage-v2.xml b/api-ref-guides/src/bk-api-ref-blockstorage-v2.xml index 80ac83565..55147d60a 100644 --- a/api-ref-guides/src/bk-api-ref-blockstorage-v2.xml +++ b/api-ref-guides/src/bk-api-ref-blockstorage-v2.xml @@ -1,17 +1,4 @@ - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> + xml:id="api.openstack.org-blockstorage-v2-pdf"> OpenStack Block Storage API v2 Reference API Reference diff --git a/api-ref-guides/src/bk-api-ref-compute-v2-ext.xml b/api-ref-guides/src/bk-api-ref-compute-v2-ext.xml index c94462788..9f81fd74b 100644 --- a/api-ref-guides/src/bk-api-ref-compute-v2-ext.xml +++ b/api-ref-guides/src/bk-api-ref-compute-v2-ext.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="api.openstack.org-compute-ext-pdf"> + xml:id="api.openstack.org-compute-v2-ext-pdf"> OpenStack Compute API v2 Extensions Reference API Reference diff --git a/api-ref-guides/src/bk-api-ref-compute-v2.1.xml b/api-ref-guides/src/bk-api-ref-compute-v2.1.xml new file mode 100644 index 000000000..0dc3fa080 --- /dev/null +++ b/api-ref-guides/src/bk-api-ref-compute-v2.1.xml @@ -0,0 +1,37 @@ + + + + OpenStack Compute API v2.1 Reference + API Reference + + + + + + + OpenStack Foundation + + + + 2010-2015 + OpenStack Foundation + + OpenStack Compute + + + + Copyright details are filled in by the + template. + + + + + + diff --git a/api-ref-guides/src/bk-api-ref-compute-v2.xml b/api-ref-guides/src/bk-api-ref-compute-v2.xml index 122d99553..a71e9ba85 100644 --- a/api-ref-guides/src/bk-api-ref-compute-v2.xml +++ b/api-ref-guides/src/bk-api-ref-compute-v2.xml @@ -1,17 +1,4 @@ - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> + + + OpenStack Data Processing API v1.1 Reference + API Reference + + + + + + + OpenStack Foundation + + + + 2010-2015 + OpenStack Foundation + + OpenStack Data Processing + + + + Copyright details are filled in by the + template. + + + + + diff --git a/api-ref-guides/src/bk-api-ref-database-v1.xml b/api-ref-guides/src/bk-api-ref-database-v1.xml new file mode 100644 index 000000000..6230967a9 --- /dev/null +++ b/api-ref-guides/src/bk-api-ref-database-v1.xml @@ -0,0 +1,36 @@ + + + + OpenStack Database Service API v1.0 Reference + API Reference + + + + + + + OpenStack Foundation + + + + 2010-2015 + OpenStack Foundation + + OpenStack Database Service + + + + Copyright details are filled in by the + template. + + + + + diff --git a/api-ref-guides/src/bk-api-ref-databases-v1.xml b/api-ref-guides/src/bk-api-ref-databases-v1.xml deleted file mode 100644 index ce87b63a8..000000000 --- a/api-ref-guides/src/bk-api-ref-databases-v1.xml +++ /dev/null @@ -1,23 +0,0 @@ - - - - OpenStack Database Service API v1.0 - - 2010-2015 - - - - Copyright details are filled in by the - template. - - - - - diff --git a/api-ref-guides/src/bk-api-ref-identity-v2.xml b/api-ref-guides/src/bk-api-ref-identity-v2.xml index 112db2be4..a8f8d91bc 100644 --- a/api-ref-guides/src/bk-api-ref-identity-v2.xml +++ b/api-ref-guides/src/bk-api-ref-identity-v2.xml @@ -1,17 +1,4 @@ - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> OpenStack Identity API v2.0 Reference - Identity API Reference + API Reference diff --git a/api-ref-guides/src/bk-api-ref-identity-v3.xml b/api-ref-guides/src/bk-api-ref-identity-v3.xml index 341dd954e..c2212d031 100644 --- a/api-ref-guides/src/bk-api-ref-identity-v3.xml +++ b/api-ref-guides/src/bk-api-ref-identity-v3.xml @@ -1,17 +1,4 @@ - - - - - - - -GET'> -PUT'> -POST'> -DELETE'> -]> OpenStack Identity API v3 Reference - Identity API Reference + API Reference diff --git a/api-ref-guides/src/bk-api-ref-networking-v2.xml b/api-ref-guides/src/bk-api-ref-networking-v2.xml index 78eafa516..301f65b3f 100644 --- a/api-ref-guides/src/bk-api-ref-networking-v2.xml +++ b/api-ref-guides/src/bk-api-ref-networking-v2.xml @@ -12,7 +12,7 @@ Reference - Networking (neutron) API Reference + API Reference diff --git a/api-ref-guides/src/bk-api-ref-orchestration-v1.xml b/api-ref-guides/src/bk-api-ref-orchestration-v1.xml index f64cf6e14..330bab76a 100644 --- a/api-ref-guides/src/bk-api-ref-orchestration-v1.xml +++ b/api-ref-guides/src/bk-api-ref-orchestration-v1.xml @@ -9,7 +9,7 @@ xml:id="api.openstack.org-orchestration-pdf"> OpenStack Orchestration API v1 Reference - Orchestration API Reference + API Reference diff --git a/api-ref-guides/src/bk-api-ref-telemetry-v2.xml b/api-ref-guides/src/bk-api-ref-telemetry-v2.xml index 9516e227c..dfda3b489 100644 --- a/api-ref-guides/src/bk-api-ref-telemetry-v2.xml +++ b/api-ref-guides/src/bk-api-ref-telemetry-v2.xml @@ -9,7 +9,7 @@ xml:id="api.openstack.org-telemetry-pdf"> OpenStack Telemetry API v2 Reference - Telemetry API Reference + API Reference diff --git a/api-ref-guides/src/bk-api-ref.xml b/api-ref-guides/src/bk-api-ref.xml index 84e23b0e3..428fa8135 100644 --- a/api-ref-guides/src/bk-api-ref.xml +++ b/api-ref-guides/src/bk-api-ref.xml @@ -39,6 +39,7 @@ + diff --git a/api-ref/src/docbkx/api-ref-compute-v2.xml b/api-ref/src/docbkx/api-ref-compute-v2.xml index 00abcfa19..ced58af53 100644 --- a/api-ref/src/docbkx/api-ref-compute-v2.xml +++ b/api-ref/src/docbkx/api-ref-compute-v2.xml @@ -1,23 +1,22 @@ - - OpenStack Compute API v2 (SUPPORTED) - - 2010-2015 - - - - - - - - - + + OpenStack Compute API v2 (SUPPORTED) + + 2010-2015 + + + + + + + + + diff --git a/api-ref/src/docbkx/api-ref-data-processing-v1.1.xml b/api-ref/src/docbkx/api-ref-data-processing-v1.1.xml index 65fc3c878..fd12369e3 100644 --- a/api-ref/src/docbkx/api-ref-data-processing-v1.1.xml +++ b/api-ref/src/docbkx/api-ref-data-processing-v1.1.xml @@ -1,23 +1,22 @@ - - OpenStack Data Processing API v1.1 (CURRENT) - - 2010-2015 - - - - - - - - - + + OpenStack Data Processing API v1.1 (CURRENT) + + 2010-2015 + + + + + + + + + diff --git a/api-ref/src/docbkx/ch_data-processing-v1.1.xml b/api-ref/src/docbkx/ch_data-processing-v1.1.xml index 42c3a2a3f..27d2e34f9 100644 --- a/api-ref/src/docbkx/ch_data-processing-v1.1.xml +++ b/api-ref/src/docbkx/ch_data-processing-v1.1.xml @@ -15,9 +15,17 @@ A plugin object defines the Hadoop or Spark version that it can install and which configurations can be set for the cluster. - + + + + + + + + + + +
Image registry @@ -31,9 +39,22 @@ The image registry enables you to add tags to and remove tags from images and define the OS user name. - + + + + + + + + + + + + + + + +
Jobs @@ -44,11 +65,21 @@ You can run a job on an existing or new transient cluster. - + + + + + + + + + + + + +
-
+
Job types Each plugin that supports EDP also supports specific job types. @@ -60,9 +91,11 @@ The job types provide information about which plugins support which job types and how to configure the job types. - + + + + +
Job executions @@ -71,25 +104,17 @@ specified cluster. A job execution polls the status of a running job and reports it to the user. Also a user can cancel a running job. - - - - - - - @@ -105,9 +130,16 @@ The Data Processing service does not validate data source locations. - + + + + + + + + + +
Node group templates @@ -121,8 +153,6 @@ CPUs, and the amount of RAM. The template specifies the VM characteristics through an OpenStack flavor. - @@ -186,8 +216,6 @@ can also define cluster-scoped configurations in a cluster template. - @@ -200,35 +228,4 @@
-
- Clusters - - A cluster is a group of nodes with the same configuration. - - - - - - - - - - - - - -
-
- Event log - - The event log feature provides information about cluster provisioning. - In the event of errors, the event log shows the reason for the failure. - - - - - - -
diff --git a/api-ref/src/wadls/common_project.ent b/api-ref/src/wadls/common_project.ent index 4ce427a61..9d34be8af 100644 --- a/api-ref/src/wadls/common_project.ent +++ b/api-ref/src/wadls/common_project.ent @@ -31,3 +31,9 @@ PUT'> POST'> DELETE'> + + + + + + diff --git a/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/image-registry.wadl b/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/image-registry.wadl index ee7e42223..b02578cee 100644 --- a/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/image-registry.wadl +++ b/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/image-registry.wadl @@ -24,12 +24,12 @@ - - + + - + @@ -46,7 +46,8 @@ Lists all images registered in the image registry. - + + Lists images only with specific tag. Can be used @@ -54,6 +55,7 @@ + diff --git a/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-binaries.wadl b/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-binaries.wadl index 9107a3428..bb4a177c0 100644 --- a/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-binaries.wadl +++ b/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-binaries.wadl @@ -115,7 +115,7 @@ xmlns="http://docbook.org/ns/docbook"> Gets data for a specified job binary. - The response body shows the job binary raw data and + The response body shows the job binary raw data and the response headers show the data length. Example response: HTTP/1.1 200 OK @@ -129,7 +129,8 @@ B = foreach A generate com.hadoopbook.pig.Trim(fruit); store B into '$OUTPUT' USING PigStorage(); - + The length of the returned data in bytes. @@ -137,7 +138,7 @@ store B into '$OUTPUT' USING PigStorage(); - + diff --git a/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-binary-internals.wadl b/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-binary-internals.wadl index 2663e75c9..8c2519470 100644 --- a/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-binary-internals.wadl +++ b/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-binary-internals.wadl @@ -142,7 +142,8 @@ B = foreach A generate com.hadoopbook.pig.Trim(fruit); store B into '$OUTPUT' USING PigStorage(); - + The length of the returned data in bytes. @@ -150,7 +151,7 @@ store B into '$OUTPUT' USING PigStorage(); - + diff --git a/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-types.wadl b/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-types.wadl index c40ef8139..754484d95 100644 --- a/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-types.wadl +++ b/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-types.wadl @@ -16,26 +16,6 @@ - - - Filter results by plugin name. - - - - - Filter results by plugin version. - - - - - Filter results by job type. - - - - - Include configuration hints in results. - - @@ -49,6 +29,30 @@ xmlns="http://docbook.org/ns/docbook"> Lists job types filtered by specified filter parameters. + + + + + Filter results by plugin name. + + + + + Filter results by plugin version. + + + + + Filter results by job type. + + + + + Include configuration hints in results. + + + + - - %common_project; -]> + xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wadl="http://wadl.dev.java.net/2009/02" + xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:db="http://docbook.org/ns/docbook" + xmlns:common="http://docs.openstack.org/common/api/v1.0" + xmlns:capi="http://docs.openstack.org/common/api/v1.0"> @@ -55,7 +51,8 @@ - + @@ -70,7 +67,8 @@ - + @@ -86,7 +84,7 @@ + xml:lang="EN"> @@ -95,7 +93,8 @@ - + @@ -118,7 +117,7 @@ + xml:lang="EN"> @@ -127,7 +126,8 @@ - + diff --git a/www/index.html b/www/index.html index 4c8228d6a..ea1238b1c 100644 --- a/www/index.html +++ b/www/index.html @@ -836,104 +836,101 @@