openstack/api-site
Code Issues Proposed changes

Update to generate all PDFs.

Browse Source 
Change-Id: I22edf77b873ef6073043654d28e895140ee9774a
This commit is contained in:
Diane Fleming 2015-03-30 21:00:05 -05:00
parent 87fe323597
commit 6bdcc1f029
25 changed files with 375 additions and 336 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
api-ref-guides/pom.xml
View File

@ -70,8 +70,8 @@
<includes> bk-api-ref-blockstorage-v1.xml </includes>
<pdfFilenameBase>api-ref-blockstorage-v1</pdfFilenameBase>
</configuration>
</execution>
<execution>
</execution>
<execution>
<id>os-api-ref-compute-v2</id>
<goals>
<goal>generate-pdf</goal>
@ -104,17 +104,28 @@
<pdfFilenameBase>api-ref-compute-v2.1</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-databases-v1</id>
<execution>
<id>os-api-ref-database-v1</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-databases-v1.xml </includes>
<pdfFilenameBase>api-ref-databases-v1</pdfFilenameBase>
<includes> bk-api-ref-database-v1.xml </includes>
<pdfFilenameBase>api-ref-database-v1</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-data-processing-v1.1</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-data-processing-v1.1.xml </includes>
<pdfFilenameBase>api-ref-data-processing-v1.1</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-identity-v3</id>
<goals>

15
api-ref-guides/src/bk-api-ref-blockstorage-v1.xml
View File

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book[
<!-- 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>'>
]>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
@ -19,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-blockstorage-pdf">
xml:id="api.openstack.org-blockstorage-v1-pdf">
<info>
<title>OpenStack Block Storage API v1 Reference</title>
<titleabbrev>API Reference</titleabbrev>

15
api-ref-guides/src/bk-api-ref-blockstorage-v2.xml
View File

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book[
<!-- 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>'>
]>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
@ -19,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-blockstorage-pdf">
xml:id="api.openstack.org-blockstorage-v2-pdf">
<info>
<title>OpenStack Block Storage API v2 Reference</title>
<titleabbrev>API Reference</titleabbrev>

2
api-ref-guides/src/bk-api-ref-compute-v2-ext.xml
View File

@ -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">
<info>
<title>OpenStack Compute API v2 Extensions Reference</title>
<titleabbrev>API Reference</titleabbrev>

37
api-ref-guides/src/bk-api-ref-compute-v2.1.xml Normal file
View File

@ -0,0 +1,37 @@
<?xml version="1.0" encoding="UTF-8"?>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-compute-v2-1-pdf">
<info>
<title>OpenStack Compute API v2.1 Reference</title>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>OpenStack Foundation</orgname>
</affiliation>
</author>
<copyright>
<year>2010-2015</year>
<holder>OpenStack Foundation</holder>
</copyright>
<productname>OpenStack Compute</productname>
<pubdate/>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the
template.</remark>
</annotation>
</legalnotice>
</info>
<!-- <xi:include href="preface.xml"/>-->
<xi:include href="../../api-ref/src/docbkx/ch_compute-v2.1.xml"/>
</book>

13
api-ref-guides/src/bk-api-ref-compute-v2.xml
View File

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book[
<!-- 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>'>
]>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"

36
api-ref-guides/src/bk-api-ref-data-processing-v1.1.xml Normal file
View File

@ -0,0 +1,36 @@
<?xml version="1.0" encoding="UTF-8"?>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-data-processing-v1-pdf">
<info>
<title>OpenStack Data Processing API v1.1 Reference</title>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>OpenStack Foundation</orgname>
</affiliation>
</author>
<copyright>
<year>2010-2015</year>
<holder>OpenStack Foundation</holder>
</copyright>
<productname>OpenStack Data Processing</productname>
<pubdate/>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the
template.</remark>
</annotation>
</legalnotice>
</info>
<xi:include href="../../api-ref/src/docbkx/ch_data-processing-v1.1.xml"/>
</book>

36
api-ref-guides/src/bk-api-ref-database-v1.xml Normal file
View File

@ -0,0 +1,36 @@
<?xml version="1.0" encoding="UTF-8"?>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-database">
<info>
<title>OpenStack Database Service API v1.0 Reference</title>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>OpenStack Foundation</orgname>
</affiliation>
</author>
<copyright>
<year>2010-2015</year>
<holder>OpenStack Foundation</holder>
</copyright>
<productname>OpenStack Database Service</productname>
<pubdate/>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the
template.</remark>
</annotation>
</legalnotice>
</info>
<xi:include href="../../api-ref/src/docbkx/ch_database-v1.xml"/>
</book>

23
api-ref-guides/src/bk-api-ref-databases-v1.xml
View File

@ -1,23 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-databases">
<info>
<title>OpenStack Database Service API v1.0</title>
<copyright>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the
template.</remark>
</annotation>
</legalnotice>
</info>
<xi:include href="../../api-ref/src/docbkx/ch_database-v1.xml"/>
</book>

15
api-ref-guides/src/bk-api-ref-identity-v2.xml
View File

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book[
<!-- 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>'>
]>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
@ -21,7 +8,7 @@
version="5.0-extension RackBook-2.0" xml:id="api.openstack.org-identity-v2-pdf">
<info>
<title>OpenStack Identity API v2.0 Reference</title>
<titleabbrev>Identity API Reference</titleabbrev>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>

15
api-ref-guides/src/bk-api-ref-identity-v3.xml
View File

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book[
<!-- 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>'>
]>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
@ -21,7 +8,7 @@
version="5.0-extension RackBook-2.0" xml:id="api.openstack.org-identity-v3-pdf">
<info>
<title>OpenStack Identity API v3 Reference</title>
<titleabbrev>Identity API Reference</titleabbrev>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>

2
api-ref-guides/src/bk-api-ref-networking-v2.xml
View File

@ -12,7 +12,7 @@
Reference</title>
<?rax title.font.size="32px"?>
<?rax subtitle.font.size="32px"?>
<titleabbrev>Networking (neutron) API Reference</titleabbrev>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>

2
api-ref-guides/src/bk-api-ref-orchestration-v1.xml
View File

@ -9,7 +9,7 @@
xml:id="api.openstack.org-orchestration-pdf">
<info>
<title>OpenStack Orchestration API v1 Reference</title>
<titleabbrev>Orchestration API Reference</titleabbrev>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>

2
api-ref-guides/src/bk-api-ref-telemetry-v2.xml
View File

@ -9,7 +9,7 @@
xml:id="api.openstack.org-telemetry-pdf">
<info>
<title>OpenStack Telemetry API v2 Reference</title>
<titleabbrev>Telemetry API Reference</titleabbrev>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>

1
api-ref-guides/src/bk-api-ref.xml
View File

@ -39,6 +39,7 @@
<xi:include href="../../api-ref/src/docbkx/ch_compute-v2.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_compute-v2-ext.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_database-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_data-processing-v1.1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_identity-v3.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_identity-v3-ext.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_identity-v2.xml"/>

33
api-ref/src/docbkx/api-ref-compute-v2.xml
View File

@ -1,23 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
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"
xmlns:xref="http://www.w3.org/1999/xref" version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-compute-v2" status="SUPPORTED">
<info>
<title>OpenStack Compute API v2 (SUPPORTED)</title>
<copyright>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_compute-v2.xml"/>
<info>
<title>OpenStack Compute API v2 (SUPPORTED)</title>
<copyright>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para />
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml" />
</annotation>
</info>
<xi:include href="ch_compute-v2.xml" />
</book>

33
api-ref/src/docbkx/api-ref-data-processing-v1.1.xml
View File

@ -1,23 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
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"
xmlns:xref="http://www.w3.org/1999/xref" version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-data-processing-v1.1" status="CURRENT">
<info>
<title>OpenStack Data Processing API v1.1 (CURRENT)</title>
<copyright>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_data-processing-v1.1.xml"/>
<info xreflabel="api-ref-data-processing-v1.1.html">
<title>OpenStack Data Processing API v1.1 (CURRENT)</title>
<copyright>
<year>2010-2015</year>
</copyright>
<legalnotice role="apache2">
<para />
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml" />
</annotation>
</info>
<xi:include href="ch_data-processing-v1.1.xml" />
</book>

115
api-ref/src/docbkx/ch_data-processing-v1.1.xml
View File

@ -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.
</para>
<wadl:resources
href="../wadls/dataprocessing-api/src/v1.1/wadl/plugins.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/plugins.wadl#plugins">
<wadl:method href="#pluginslist"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/plugins.wadl#pluginSimple">
<wadl:method href="#pluginsget"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/plugins.wadl#pluginDetailed">
<wadl:method href="#pluginsgetversion"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1imageregistry">
<title>Image registry</title>
@ -31,9 +39,22 @@
The image registry enables you to add tags to and remove tags from images
and define the OS user name.
</para>
<wadl:resources
href="../wadls/dataprocessing-api/src/v1.1/wadl/image-registry.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/image-registry.wadl#images">
<wadl:method href="#imageslist"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/image-registry.wadl#imageId">
<wadl:method href="#imageInfo"/>
<wadl:method href="#imageReg"/>
<wadl:method href="#imageUnreg"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/image-registry.wadl#imageTag">
<wadl:method href="#addTags"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/image-registry.wadl#imageUntag">
<wadl:method href="#removeTags"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1jobs">
<title>Jobs</title>
@ -44,11 +65,21 @@
<para>
You can run a job on an existing or new transient cluster.
</para>
<wadl:resources
href="../wadls/dataprocessing-api/src/v1.1/wadl/jobs.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/jobs.wadl#jobs">
<wadl:method href="#jobsList"/>
<wadl:method href="#jobCreate"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/jobs.wadl#jobId">
<wadl:method href="#jobInfo"/>
<wadl:method href="#jobDelete"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/jobs.wadl#execute">
<wadl:method href="#jobExecute"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1jobtypes">
<section xml:id="v1.1jobtypes">
<title>Job types</title>
<para>
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.
</para>
<wadl:resources
href="../wadls/dataprocessing-api/src/v1.1/wadl/job-types.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-types.wadl#job-types">
<wadl:method href="#jobTypesList"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1jobexecutions">
<title>Job executions</title>
@ -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.
</para>
<wadl:resources
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#job-executions">
<wadl:method href="#job-executions-list"/>
</wadl:resource>
</wadl:resources>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#job_execution_id">
<wadl:method href="#job-executions-show"/>
<wadl:method href="#job-executions-delete"/>
</wadl:resource>
</wadl:resources>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#refresh-status">
<wadl:method href="#job-executions-refresh"/>
</wadl:resource>
</wadl:resources>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#cancel">
<wadl:method href="#job-executions-cancel"/>
</wadl:resource>
@ -105,9 +130,16 @@
The Data Processing service does not validate data source
locations.
</para>
<wadl:resources
href="../wadls/dataprocessing-api/src/v1.1/wadl/data-sources.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/data-sources.wadl#data-sources">
<wadl:method href="#dataSourcesList"/>
<wadl:method href="#dataSourcesCreate"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/data-sources.wadl#dataSourceId">
<wadl:method href="#dataSourceInfo"/>
<wadl:method href="#dataSourceDelete"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1nodegrouptemplate">
<title>Node group templates</title>
@ -121,8 +153,6 @@
CPUs, and the amount of RAM. The template specifies the VM
characteristics through an OpenStack flavor.
</para>
<wadl:resources
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/node-group-template.wadl#node-group-templates">
<wadl:method href="#node-group-templates-list"/>
@ -186,8 +216,6 @@
can also define cluster-scoped configurations in a cluster
template.
</para>
<wadl:resources
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/cluster-templates.wadl#cluster-templates">
<wadl:method href="#cluster-templates-list"/>
@ -200,35 +228,4 @@
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1clusters">
<title>Clusters</title>
<para>
A cluster is a group of nodes with the same configuration.
</para>
<wadl:resources
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/clusters.wadl#clusters">
<wadl:method href="#clusters-list"/>
<wadl:method href="#clusters-create"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/clusters.wadl#cluster_id">
<wadl:method href="#clusters-get"/>
<wadl:method href="#clusters-delete"/>
<wadl:method href="#clusters-scale"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1eventlog">
<title>Event log</title>
<para>
The event log feature provides information about cluster provisioning.
In the event of errors, the event log shows the reason for the failure.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/event-log.wadl#cluster_id">
<wadl:method href="#cluster-show-progress"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

6
api-ref/src/wadls/common_project.ent
View File

@ -31,3 +31,9 @@
<!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>'>
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">

10
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/image-registry.wadl
View File

@ -24,12 +24,12 @@
</wadl:doc>
</param>
<method href="#imageInfo"/>
<method href="#imageReg"/>
<method href="#imageUnreg"/>
<method href="#imageReg"/>
<method href="#imageUnreg"/>
<resource id="imageTag" path="tag">
<method href="#addTags"/>
</resource>
<resource id="imageUntag" path="untag">
<resource id="imageUntag" path="untag">
<method href="#removeTags"/>
</resource>
</resource>
@ -46,7 +46,8 @@
<para role="shortdesc">Lists all images registered in the image registry.</para>
</wadl:doc>
<request>
<param name="tags" style="plain" type="xsd:string">
<representation mediaType="application/json">
<param name="tags" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Lists images only with specific tag. Can be used
@ -54,6 +55,7 @@
</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">

7
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-binaries.wadl
View File

@ -115,7 +115,7 @@
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Gets data for a specified job
binary.</para>
<para>The response body shows the job binary raw data and
<para>The response body shows the job binary raw data and
the response headers show the data length.</para>
<para>Example response:</para>
<para><programlisting>HTTP/1.1 200 OK
@ -129,7 +129,8 @@ B = foreach A generate com.hadoopbook.pig.Trim(fruit);
store B into '$OUTPUT' USING PigStorage();</programlisting></para>
</wadl:doc>
<response status="200">
<param name="Content-Length" style="header" type="xsd:string"
<representation mediaType="application/json">
<param name="Content-Length" style="header" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The length of the returned data in bytes.</para>
@ -137,7 +138,7 @@ store B into '$OUTPUT' USING PigStorage();</programlisting></para>
</param>
<!-- the following element is present to suppress the output
about this method not returning a body -->
<representation/>
</representation>
</response>
</method>
</application>

5
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-binary-internals.wadl
View File

@ -142,7 +142,8 @@ B = foreach A generate com.hadoopbook.pig.Trim(fruit);
store B into '$OUTPUT' USING PigStorage(); </programlisting></para>
</wadl:doc>
<response status="200">
<param name="Content-Length" style="header" type="xsd:string"
<representation mediaType="application/json">
<param name="Content-Length" style="header" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The length of the returned data in bytes.</para>
@ -150,7 +151,7 @@ store B into '$OUTPUT' USING PigStorage(); </programlisting></para>
</param>
<!-- the following element is present to suppress the output
about this method not returning a body -->
<representation/>
</representation>
</response>
</method>
</application>

44
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/job-types.wadl
View File

@ -16,26 +16,6 @@
</wadl:doc>
</param>
<resource id="job-types" path="job-types">
<param name="plugin" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Filter results by plugin name.</para>
</wadl:doc>
</param>
<param name="version" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Filter results by plugin version.</para>
</wadl:doc>
</param>
<param name="type" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Filter results by job type.</para>
</wadl:doc>
</param>
<param name="hints" style="template" type="xsd:bool">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Include configuration hints in results.</para>
</wadl:doc>
</param>
<method href="#jobTypesList"/>
</resource>
</resource>
@ -49,6 +29,30 @@
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists job types filtered by specified filter parameters.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<param name="plugin" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Filter results by plugin name.</para>
</wadl:doc>
</param>
<param name="version" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Filter results by plugin version.</para>
</wadl:doc>
</param>
<param name="type" style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Filter results by job type.</para>
</wadl:doc>
</param>
<param name="hints" style="template" type="xsd:bool">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Include configuration hints in results.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"

28
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/node-group-template.wadl
View File

@ -7,16 +7,12 @@
<!-- -->
<!-- xmllint -noent node-group-template.wadl -->
<!--*******************************************************-->
<!DOCTYPE application [
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:capi="http://docs.openstack.org/common/api/v1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
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">
<resources base="https://servers.api.openstack.com"
xml:id="node-group-templates-v1.1">
<resource id="v1.1" path="//v1.1">
@ -55,7 +51,8 @@
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/node-group-templates/node-group-templates-list.json"
/>
@ -70,7 +67,8 @@
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/node-group-templates/node-group-templates-get.json"
/>
@ -86,7 +84,7 @@
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Create node group template: JSON request">
xml:lang="EN">
<xsdxt:code
href="../samples/node-group-templates/node-group-templates-create-req.json"
/>
@ -95,7 +93,8 @@
</request>
<response status="202">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/node-group-templates/node-group-templates-create-resp.json"
/>
@ -118,7 +117,7 @@
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Update node group template: JSON request">
xml:lang="EN">
<xsdxt:code
href="../samples/node-group-templates/node-group-templates-update-req.json"
/>
@ -127,7 +126,8 @@
</request>
<response status="202">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="../samples/node-group-templates/node-group-templates-update-resp.json"
/>

193
www/index.html
View File

@ -836,104 +836,101 @@
</p>
<div class="span-24" id="api-docs">
<div class="span-8 last">
<dl>
<dt>
References
</dt>
<dd>
<a href="http://developer.openstack.org/api-ref-blockstorage-v2.html">
Block Storage API v2
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-blockstorage-v1.html">
Block Storage API v1
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-compute-v2.1.html">
Compute API v2.1
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-compute-v2.html">
Compute API v2
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-compute-v2-ext.html">
Compute API v2 extensions
</a>
</dd>
<dd><a href="http://developer.openstack.org/api-ref-data-processing-v1.1.html">
Data Processing API v1.1
</a>
<dd>
<a href="http://developer.openstack.org/api-ref-databases-v1.html">
Database Service API v1.0
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-identity-v3.html">
Identity Service API v3
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-identity-v3-ext.html">
Identity Service API v3 extensions
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-identity-v2.html">
Identity Service API v2.0
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-identity-admin-v2.html">
Identity Admin API v2.0
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-identity-v2-ext.html">
Identity Service API v2.0 extensions
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-image-v2.html">
Image Service API v2
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-image-v1.html">
Image Service API v1
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-networking-v2.html">
Networking API v2.0
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-networking-v2-ext.html">
Networking API v2.0 extensions
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-objectstorage-v1.html">
Object Storage API v1
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-orchestration-v1.html">
Orchestration API v1
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-telemetry-v2.html">
Telemetry API v2
</a>
</dd>
</dl>
<dl>
<dt>
References
</dt>
<dd>
<a href="http://developer.openstack.org/api-ref-blockstorage-v2.html">
Block Storage API v2 (CURRENT)
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-blockstorage-v1.html">
Block Storage API v1 (SUPPORTED)
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-compute-v2.1.html">
Compute API v2.1 (CURRENT)
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-compute-v2.html">
Compute API v2 (SUPPORTED)
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-compute-v2-ext.html">
Compute API v2 extensions (SUPPORTED)
</a>
</dd>
<dd><a href="http://developer.openstack.org/api-ref-data-processing-v1.1.html">
Data Processing API v1.1 (CURRENT)
</a>
<dd>
<a href="http://developer.openstack.org/api-ref-database-v1.html">
Database Service API v1.0 (CURRENT)
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-identity-v3.html">
Identity API v3 (CURRENT)
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-identity-v3-ext.html">
Identity API v3 extensions (CURRENT)
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-identity-v2.html">
Identity API v2.0 (SUPPORTED)
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-identity-admin-v2.html">
Identity Admin API v2.0 (SUPPORTED)
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-identity-v2-ext.html">
Identity API v2.0 extensions (SUPPORTED)
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-image-v2.html">
Image Service API v2 (CURRENT)
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-image-v1.html">
Image Service API v1 (SUPPORTED)
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-networking-v2.html">
Networking API v2.0 (CURRENT)
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-networking-v2-ext.html">
Networking API v2.0 extensions (CURRENT)
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-objectstorage-v1.html">
Object Storage API v1 (SUPPORTED)
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-orchestration-v1.html">
Orchestration API v1 (CURRENT)
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-telemetry-v2.html">
Telemetry API v2 (CURRENT)
</a>
</dd>
</dl>
</div>
</div>
</div>