openstack/api-site
Code Issues Proposed changes

Fix weirdness on first page of API ref

Browse Source 
Requires at least one WADL to work

Change-Id: I62258f54a88d453eabef756ba0af352993ed313e
author: diane fleming
This commit is contained in:
Diane Fleming 2014-04-04 11:08:56 -05:00
parent 9d406d4d46
commit 31018a6f99
9 changed files with 125 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -83,14 +83,25 @@
</configuration>
</execution>
<execution>
<id>os-api-ref-identity</id>
<id>os-api-ref-identity-v2</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-identity.xml </includes>
<pdfFilenameBase>api-ref-identity</pdfFilenameBase>
<includes> bk-api-ref-identity-v2.xml </includes>
<pdfFilenameBase>api-ref-identity-v2</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-identity-v3</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-identity-v3.xml </includes>
<pdfFilenameBase>api-ref-identity-v3</pdfFilenameBase>
</configuration>
</execution>
<execution>

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

@ -18,9 +18,9 @@
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-identity-pdf">
version="5.0-extension RackBook-2.0" xml:id="api.openstack.org-identity-v2-pdf">
<info>
<title>OpenStack Identity API Reference</title>
<title>OpenStack Identity API v2.0 Reference</title>
<titleabbrev>Identity API Reference</titleabbrev>
<author>
<personname>
@ -44,9 +44,7 @@
</annotation>
</legalnotice>
</info>
<!-- <xi:include href="preface.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="preface.xml"/>-->
<xi:include href="../../api-ref/src/docbkx/ch_identity-v2.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_identity-admin-v2.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_identity-v2-ext.xml"/>

49
api-ref-guides/src/bk-api-ref-identity-v3.xml Normal file
View File

@ -0,0 +1,49 @@
<?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"
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-identity-v3-pdf">
<info>
<title>OpenStack Identity API v3 Reference</title>
<titleabbrev>Identity API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>OpenStack Foundation</orgname>
</affiliation>
</author>
<copyright>
<year>2010-2014</year>
<holder>OpenStack Foundation</holder>
</copyright>
<productname>OpenStack Identity</productname>
<pubdate/>
<legalnotice role="cc-by">
<annotation>
<remark>Copyright details are filled in by the
template.</remark>
</annotation>
</legalnotice>
</info>
<xi:include href="../../api-ref/src/docbkx/ch_identity-v3.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_identity-v3-ext.xml"/>
</book>

17
api-ref/pom.xml
View File

@ -37,14 +37,25 @@
</configuration>
</execution>
<execution>
<id>os-api-ref-identity</id>
<id>os-api-ref-identity-v2</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-identity.xml</includes>
<pdfFilename>bk-api-ref-identity</pdfFilename>
<includes>api-ref-identity-v2.xml</includes>
<pdfFilename>bk-api-ref-identity-v2</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-identity-v3</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-identity-v3.xml</includes>
<pdfFilename>bk-api-ref-identity-v3</pdfFilename>
</configuration>
</execution>
<execution>

5
api-ref/src/docbkx/api-ref-identity.xml → api-ref/src/docbkx/api-ref-identity-v2.xml
View File

@ -8,7 +8,7 @@
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-identity-v2">
<info xreflabel="api-ref-identity.html">
<title>OpenStack Identity APIs and extensions</title>
<title>OpenStack Identity API v2.0 and extensions</title>
<copyright>
<year>2010-2014</year>
</copyright>
@ -19,9 +19,6 @@
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_identity-v3.xml"/>
<xi:include href="ch_identity-v3-ext.xml"/>
<xi:include href="ch_identity-v2.xml"/>
<xi:include href="ch_identity-admin-v2.xml"/>
<xi:include href="ch_identity-v2-ext.xml"/>
</book>

24
api-ref/src/docbkx/api-ref-identity-v3.xml Normal file
View File

@ -0,0 +1,24 @@
<?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-identity-v3">
<info xreflabel="api-ref-identity.html">
<title>OpenStack Identity API v3 and extensions</title>
<copyright>
<year>2010-2014</year>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_identity-v3.xml"/>
<xi:include href="ch_identity-v3-ext.xml"/>
</book>

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

@ -5,32 +5,20 @@
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"
xml:id="api.openstack.org">
<!-- version="5.0-extension RackBook-2.0" -->
<info>
<title>OpenStack API Reference</title>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>OpenStack Foundation</orgname>
</affiliation>
</author>
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org">
<info xreflabel="api-ref.html">
<title>OpenStack API Complete Reference</title>
<copyright>
<year>2010-2014</year>
<holder>OpenStack Foundation</holder>
</copyright>
<productname>OpenStack</productname>
<pubdate/>
<legalnotice role="cc-by">
<annotation>
<remark>Copyright details are filled in by the
template.</remark>
</annotation>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="preface.xml"/>
<xi:include href="ch_identity-v2.xml"/>
</book>

12
api-ref/src/docbkx/itemizedlist-service-list.xml
View File

@ -12,18 +12,22 @@
</listitem>
<listitem>
<para><link xlink:href="api-ref-compute-v2.html">Compute
API</link></para>
API v2</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-compute-v2-ext.html">Compute API
<para><link xlink:href="api-ref-compute-v2-ext.html">Compute API v2
extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-compute-v3.html">Compute API v3 (EXPERIMENTAL)</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-identity.html">Identity
API and extensions</link></para>
<para><link xlink:href="api-ref-identity-v2.html">Identity
API v2.0 and extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-identity-v3.html">Identity
API v3 and extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-image.html">Image Service

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

@ -13,8 +13,8 @@
<title>OpenStack API Complete Reference</title>
<para>Use the OpenStack APIs and extensions in your OpenStack
cloud.</para>
<xi:include
href="itemizedlist-service-list.xml"/>
<!-- <xi:include
href="itemizedlist-service-list.xml"/>-->
<para>You must install the packages for each API separately. After
you authenticate through the <link
xlink:href="api-ref-identity.html">Identity API</link>,