openstack/openstack-manuals
Code Issues Proposed changes

Adding floating ip pools to api docs

Browse Source 
Change-Id: I8298eb7f3bd0202b13731ed7d48951e730aebc48
This commit is contained in:
jakedahn
2012-04-04 15:10:07 -07:00
committed by Brian Waldon
parent eb108f9638
commit a11eef155f
3 changed files with 62 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/src/docbkx/openstack-api-site/src/docbkx/index.xml
View File

@@ -70,8 +70,13 @@
<para></para><wadl:resources
href="ext/os-console-output.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/></section>
<section xml:id="ext-floating-ip-pools"><title>Floating IP Pools</title>
<para></para></section>
<section xml:id="ext-floating-ip-pools">
<title>Floating IP Pools</title>
<para></para>
<wadl:resources
href="ext/os-floating-ip-pools.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-cloudpipe"><title>Cloudpipe</title>
<para></para></section>
<section xml:id="ext-floating-ip-addresses">
@@ -132,4 +137,5 @@
href="os-volume-1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</chapter>
</book>

44
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/os-floating-ip-pools.wadl Normal file
View File

@@ -0,0 +1,44 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012 OpenStack LLC., All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<resources base="https://floatingippools.example.com/">
<resource id="version" path="v1.1">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the tenant or account.
</p>
</doc>
</param>
<resource id="floating-ip-pools" path="os-floating-ip-pools">
<method href="#listFloatingIpPools" />
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="listFloatingIpPools">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="List Floating IP Pools">
<p xmlns="http://www.w3.org/1999/xhtml">
View a list of Floating IP Pools.
</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_pools_list.json" />
</doc>
</representation>
</response>
</method>
</application>

10
doc/src/docbkx/openstack-api-site/src/wadls/compute-api/src/ext/samples/floating_ip_pools_list.json Normal file
View File

@@ -0,0 +1,10 @@
{
"floating_ip_pools": [
{
"name": "nova"
},
{
"name": "default"
}
]
}