openstack/api-site
Code Issues Proposed changes

Change to allow read of service names from doc file

Browse Source 
- 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
This commit is contained in:
Diane Fleming 2014-02-09 19:05:24 -06:00
parent 9097e3a1ec
commit 7837131f36
23 changed files with 46 additions and 249 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
api-ref/pom.xml
View File

@ -32,8 +32,8 @@
</goals> </goals>
<phase>generate-sources</phase> <phase>generate-sources</phase>
<configuration> <configuration>
<includes> api-ref.xml, api-ref-identity.xml, <includes> api-ref.xml, api-ref-compute-core.xml, api-ref-compute-ext.xml,
api-ref-compute.xml, api-ref-compute-ext.xml, api-ref-image.xml, api-ref-identity.xml, api-ref-image.xml,
api-ref-networking.xml, api-ref-objectstorage.xml, api-ref-networking.xml, api-ref-objectstorage.xml,
api-ref-blockstorage.xml, api-ref-orchestration.xml, api-ref-blockstorage.xml, api-ref-orchestration.xml,
api-ref-telemetry.xml </includes> api-ref-telemetry.xml </includes>
@ -157,7 +157,8 @@
</executions> </executions>
<configuration> <configuration>
<!-- These parameters apply to pdf and webhelp --> <!-- These parameters apply to pdf and webhelp -->
<generateToc> appendix toc,title <generateToc>
appendix toc,title
article/appendix nop article/appendix nop
article toc,title article toc,title
book toc,title book toc,title

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

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?> <?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" <book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
@ -23,11 +10,12 @@
<info> <info>
<title>OpenStack Block Storage APIs</title> <title>OpenStack Block Storage APIs</title>
<copyright> <copyright>
<year>2010-2013</year> <year>2010-2014</year>
</copyright> </copyright>
<legalnotice role="apache2"> <legalnotice role="apache2">
<para/> <para/>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/>
<xi:include href="ch_blockstorage-api.xml"/> <xi:include href="ch_blockstorage-api.xml"/>
</book> </book>

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

@ -16,5 +16,6 @@
<para/> <para/>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/>
<xi:include href="ch_compute-ext.xml"/> <xi:include href="ch_compute-ext.xml"/>
</book> </book>

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

@ -16,5 +16,6 @@
<para/> <para/>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/>
<xi:include href="ch_compute-core.xml"/> <xi:include href="ch_compute-core.xml"/>
</book> </book>

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

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?> <?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" <book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
@ -23,12 +10,13 @@
<info> <info>
<title>OpenStack Identity Service APIs and extensions</title> <title>OpenStack Identity Service APIs and extensions</title>
<copyright> <copyright>
<year>2010-2013</year> <year>2010-2014</year>
</copyright> </copyright>
<legalnotice role="apache2"> <legalnotice role="apache2">
<para/> <para/>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/>
<xi:include href="ch_identity-v3.xml"/> <xi:include href="ch_identity-v3.xml"/>
<xi:include href="ch_identity-v3-ext.xml"/> <xi:include href="ch_identity-v3-ext.xml"/>
<xi:include href="ch_identity-v2.xml"/> <xi:include href="ch_identity-v2.xml"/>

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

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?> <?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" <book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
@ -23,12 +10,13 @@
<info> <info>
<title>OpenStack Image Service APIs</title> <title>OpenStack Image Service APIs</title>
<copyright> <copyright>
<year>2010-2013</year> <year>2010-2014</year>
</copyright> </copyright>
<legalnotice role="apache2"> <legalnotice role="apache2">
<para/> <para/>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/>
<xi:include href="ch_images-v2.xml"/> <xi:include href="ch_images-v2.xml"/>
<xi:include href="ch_images-v1.xml"/> <xi:include href="ch_images-v1.xml"/>
</book> </book>

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

@ -16,6 +16,7 @@
<para/> <para/>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/>
<xi:include href="ch_netconn-v2.xml"/> <xi:include href="ch_netconn-v2.xml"/>
<xi:include href="ch_netconn-ext-v2.xml"/> <xi:include href="ch_netconn-ext-v2.xml"/>
</book> </book>

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

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?> <?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" <book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
@ -23,11 +10,12 @@
<info> <info>
<title>OpenStack Object Storage API</title> <title>OpenStack Object Storage API</title>
<copyright> <copyright>
<year>2010-2013</year> <year>2010-2014</year>
</copyright> </copyright>
<legalnotice role="apache2"> <legalnotice role="apache2">
<para/> <para/>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/>
<xi:include href="ch_objectstorage-v1.xml"/> <xi:include href="ch_objectstorage-v1.xml"/>
</book> </book>

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

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?> <?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" <book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
@ -23,11 +10,12 @@
<info> <info>
<title>OpenStack Orchestration API</title> <title>OpenStack Orchestration API</title>
<copyright> <copyright>
<year>2010-2013</year> <year>2010-2014</year>
</copyright> </copyright>
<legalnotice role="apache2"> <legalnotice role="apache2">
<para/> <para/>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/>
<xi:include href="ch_orchestration-v1.xml"/> <xi:include href="ch_orchestration-v1.xml"/>
</book> </book>

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

@ -10,11 +10,12 @@
<info> <info>
<title>OpenStack Telemetry API</title> <title>OpenStack Telemetry API</title>
<copyright> <copyright>
<year>2010-2013</year> <year>2010-2014</year>
</copyright> </copyright>
<legalnotice role="apache2"> <legalnotice role="apache2">
<para/> <para/>
</legalnotice> </legalnotice>
</info> </info>
<xi:include href="preface.xml"/>
<xi:include href="ch_telemetry-v2.xml"/> <xi:include href="ch_telemetry-v2.xml"/>
</book> </book>

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

@ -20,7 +20,7 @@ xml:id="api.openstack.org">
</affiliation> </affiliation>
</author> </author>
<copyright> <copyright>
<year>2010-2013</year> <year>2010-2014</year>
<holder>OpenStack Foundation</holder> <holder>OpenStack Foundation</holder>
</copyright> </copyright>
<productname>OpenStack</productname> <productname>OpenStack</productname>

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

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
]>
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"

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

@ -1,16 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter[ <!DOCTYPE chapter[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'> <!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
]> ]>
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"

10
api-ref/src/docbkx/ch_identity-v2-ext.xml
View File

@ -1,16 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter[ <!DOCTYPE chapter[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'> <!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
]> ]>
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"

13
api-ref/src/docbkx/ch_identity-v2.xml
View File

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
]>
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"

10
api-ref/src/docbkx/ch_identity-v3-ext.xml
View File

@ -1,16 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter [ <!DOCTYPE chapter [
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'> <!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
]> ]>
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"

13
api-ref/src/docbkx/ch_identity-v3.xml
View File

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter [
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
]>
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"

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

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
]>
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"

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

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
]>
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"

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

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
]>
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"

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

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
]>
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"

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

@ -1,17 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
]>
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"

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

@ -5,11 +5,6 @@
<!ENTITY hellip "&#x2026;"> <!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;"> <!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;"> <!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>'>
]> ]>
<preface xmlns="http://docbook.org/ns/docbook" <preface xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
@ -18,38 +13,32 @@
xmlns:xref="http://www.w3.org/1999/xref" xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="Overview"> version="5.0-extension RackBook-2.0" xml:id="Overview">
<title>Preface</title> <title>OpenStack API Complete Reference</title>
<para>Use these OpenStack APIs and extensions in your OpenStack <para>Use the OpenStack APIs and extensions in your OpenStack
cloud:</para> cloud.</para>
<itemizedlist role="compact"> <itemizedlist xml:id="service-list">
<listitem> <listitem>
<para><link <para><link xlink:href="api-ref-blockstorage.html">Block
xlink:href="http://api.openstack.org/api-ref-blockstorage.html" Storage Service API</link></para>
>Block Storage Service API</link></para>
</listitem> </listitem>
<listitem> <listitem>
<para><link <para><link xlink:href="api-ref-compute.html">Compute
xlink:href="http://api.openstack.org/api-ref-compute.html" API</link></para>
>Compute API</link></para>
</listitem> </listitem>
<listitem> <listitem>
<para><link <para><link xlink:href="api-ref-compute-ext.html">Compute
xlink:href="http://api.openstack.org/api-ref-compute-ext.html" API extensions</link></para>
>Compute API extensions</link></para>
</listitem> </listitem>
<listitem> <listitem>
<para><link <para><link xlink:href="api-ref-identity.html">Identity
xlink:href="http://api.openstack.org/api-ref-identity.html" Service API and extensions</link></para>
>Identity Service API and extensions</link></para>
</listitem> </listitem>
<listitem> <listitem>
<para><link <para><link xlink:href="api-ref-image.html">Image Service
xlink:href="http://api.openstack.org/api-ref-image.html" API</link></para>
>Image Service API</link></para>
</listitem> </listitem>
<listitem> <listitem>
<para><link <para><link xlink:href="api-ref-networking.html"
xlink:href="http://api.openstack.org/api-ref-networking.html"
>Networking API and extensions</link></para> >Networking API and extensions</link></para>
</listitem> </listitem>
<listitem> <listitem>
@ -57,25 +46,22 @@
Storage API</link></para> Storage API</link></para>
</listitem> </listitem>
<listitem> <listitem>
<para><link <para><link xlink:href="api-ref-orchestration.html"
xlink:href="http://api.openstack.org/api-ref-orchestration.html"
>Orchestration API</link></para> >Orchestration API</link></para>
</listitem> </listitem>
<listitem> <listitem>
<para><link <para><link xlink:href="api-ref-telemetry.html">Telemetry
xlink:href="http://api.openstack.org/api-ref-telemetry.html" API</link></para>
>Telemetry API</link></para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>You must install the packages for each API separately. After <para>You must install the packages for each API separately. After
you authenticate through the <link you authenticate through the <link
xlink:href="http://api.openstack.org/api-ref-identity.html" xlink:href="api-ref-identity.html">Identity Service
>Identity Service API</link>, you can use the other APIs API</link>, you can use the other APIs and extensions to
and extensions to launch server instances, create images, launch server instances, create images, assign metadata to
assign metadata to instances and images, create containers and instances and images, create containers and objects, and
objects, and complete other actions in your OpenStack complete other actions in your OpenStack cloud. To get started
cloud.</para> with the APIs, see the <link
<para>To get started with the APIs, see the <link
xlink:href="http://docs.openstack.org/api/quick-start/content/" xlink:href="http://docs.openstack.org/api/quick-start/content/"
>OpenStack API Quick Start</link>.</para> >OpenStack API Quick Start</link>.</para>
<para>&nbsp;</para> <para>&nbsp;</para>