openstack/api-site
Code Issues Proposed changes

Merge "Update description of automatically allocated floating IPs."

Browse Source
This commit is contained in:
Jenkins 2015-04-06 18:32:17 +00:00 committed by Gerrit Code Review
commit 69229b8710
6 changed files with 174 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -42,14 +42,14 @@
<title>Networks provider extended attributes (networks)</title>
<para>List, create, show information for, update, and delete networks.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/netconn-api/src/os-networks-provider-ext.wadl#Networks">
<wadl:method href="#listNetworks"/>
<wadl:method href="#createNetwork"/>
<wadl:resource href="../wadls/netconn-api/src/os-networks-provider-ext.wadl#ProviderNetworks">
<wadl:method href="#listProviderNetworks"/>
<wadl:method href="#createProviderNetwork"/>
</wadl:resource>
<wadl:resource href="../wadls/netconn-api/src/os-networks-provider-ext.wadl#network_id">
<wadl:method href="#showNetwork"/>
<wadl:method href="#updateNetwork"/>
<wadl:method href="#deleteNetwork"/>
<wadl:method href="#showProviderNetwork"/>
<wadl:method href="#updateProviderNetwork"/>
<wadl:method href="#deleteProviderNetwork"/>
</wadl:resource>
</wadl:resources>
</section>

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

@ -37,8 +37,19 @@
<para>List, show information for, create, update, and delete
networks.</para>
<wadl:resources
href="../wadls/netconn-api/src/os-networks.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/netconn-api/src/os-networks.wadl#Networks">
<wadl:method href="#createNetwork"/>
<wadl:method href="#bulkCreateNetwork"/>
</wadl:resource>
<wadl:resource
href="../wadls/netconn-api/src/os-networks.wadl#network_id">
<wadl:method href="#showNetwork"/>
<wadl:method href="#updateNetwork"/>
<wadl:method href="#deleteNetwork"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="subnets">
<title>Subnets</title>

186
api-ref/src/wadls/netconn-api/src/os-layer3-ext.wadl
View File

@ -109,10 +109,9 @@ Accept: application/json</programlisting>
control which fields are returned in the response
body. Additionally, you can filter results by using
query string parameters. For information, see <link
xlink:href="http://docs.openstack.org/api/openstack-network/2.0/content/filtering.html"
>Filtering and Column Selection</link> in the
<citetitle>OpenStack Networking API v2.0
Reference</citetitle>.</para>
xlink:href="http://specs.openstack.org/openstack/neutron-specs/specs/api/
networking_general_api_information.html#filtering-and-column-selection"
>Filtering and Column Selection</link>.</para>
</wadl:doc>
<response status="200"> &statusParameter;
&external-gateway-infoParameter; &nameParameter;
@ -190,10 +189,9 @@ Accept: application/json</programlisting>
<para>Use the <code>fields</code> query parameter to
control which fields are returned in the response
body. For information, see <link
xlink:href="http://docs.openstack.org/api/openstack-network/2.0/content/filtering.html"
>Filtering and Column Selection</link> in the
<citetitle>OpenStack Networking API v2.0
Reference</citetitle>.</para>
xlink:href="http://specs.openstack.org/openstack/neutron-specs/specs/api/
networking_general_api_information.html#filtering-and-column-selection"
>Filtering and Column Selection</link>.</para>
</wadl:doc>
<response status="200"> &routersParameter; &statusParameter;
&external-gateway-infoParameter; &nameParameter;
@ -406,25 +404,28 @@ Accept: application/json</programlisting>
<method name="GET" id="listFloatingIps">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List floating IPs">
<para role="shortdesc">Lists floating IPs that are
accessible to the tenant who submits the
request.</para>
<para>Default policy settings return only those floating
IPs that are owned by the tenant who submits the
request, unless an admin user submits the
request.</para>
<para role="shortdesc">
Lists floating IPs that are accessible to the tenant who
submits the request.
</para>
<para>
Default policy settings return only those floating IPs that
are owned by the tenant who submits the request, unless an
admin user submits the request.
</para>
<para>This example request lists floating IPs in JSON
format:</para>
<programlisting>GET /v2.0/floatingips
Accept: application/json</programlisting>
<para>Use the <code>fields</code> query parameter to
control which fields are returned in the response
body. Additionally, you can filter results by using
query string parameters. For information, see <link
xlink:href="http://docs.openstack.org/api/openstack-network/2.0/content/filtering.html"
>Filtering and Column Selection</link> in the
<citetitle>OpenStack Networking API v2.0
Reference</citetitle>.</para>
<para>
Use the <code>fields</code> query parameter to control which
fields are returned in the response body. Additionally, you
can filter results by using query string parameters. For
information, see <link
xlink:href="http://specs.openstack.org/openstack/neutron-specs/specs/api/
networking_general_api_information.html#filtering-and-column-selection"
>Filtering and Column Selection</link>.
</para>
</wadl:doc>
<response status="200"> &floating-ipsParameter;
&router-idParameter; &tenant-idParameter; &floating-network-idParameter;
@ -445,48 +446,96 @@ Accept: application/json</programlisting>
<method name="POST" id="createFloatingIp">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create floating IP">
<para role="shortdesc">Creates a floating IP, and, if you
specify port information, associates the floating IP
with an internal port.</para>
<para>If you do not specify port information in the
request, you can issue an &PUT; request.</para>
<para>You can create floating IPs on external networks
only. If you specify a network that is not external,
such as <code>router:external=False</code>, the
operation returns a <code>400</code> error.</para>
<para>If you do not specify a floating IP address in the
request, the operation automatically allocates an
address for the floating IP. If the requested floating
IP address does not fall in the subnet range for the
external network, the operation returns a
<code>400</code> error. If the requested floating
IP address is already in use, the operation returns a
<code>409</code> error code.</para>
<para>You can associate the floating IP with an internal
port by using the port ID attribute in the request
body. If you specify a port ID that is not valid, the
operation returns a <code>404</code> error
code.</para>
<para>You must configure an IP address with the internal
OpenStack Networking port associated with the floating
IP or the operation returns a <code>400</code> error
code. Because an OpenStack Networking port might be
associated with multiple IP addresses, you can use the
<code>fixed_ip_address</code> attribute in the
request body to associate a particular IP address with
the floating IP.</para>
<para>By default, this operation associates the floating
IP with a single IP address that is configured on a
port. Therefore, if a port has multiple IP addresses,
you must specify the <code>fixed_ip_address</code>
attribute.</para>
<para>If you specify an IP address that is not valid in
the <code>fixed_ip_address</code> attribute, the
operation returns a <code>400</code> error code. If
the internal OpenStack Networking port and specified
IP address are already associated with another
floating IP, the operation returns a <code>409</code>
error code.</para>
<para role="shortdesc">
Creates a floating IP, and, if you specify port information,
associates the floating IP with an internal port.
</para>
<para>
To associate the floating IP with an internal port, specify
the port ID attribute in the request body. If you do not
specify a port ID in the request, you can issue a &PUT;
request instead of a &POST; request.
</para>
<para>
Default policy settings enable only administrative users to
set floating IP addresses and some non-administrative users
might require a floating IP address. If you do not specify a
floating IP address in the request, the API automatically
allocates one.
</para>
<para>
By default, this operation associates the floating IP address
with a single fixed IP address that is configured on an
OpenStack Networking port. If a port has multiple IP
addresses, you must specify the <code>fixed_ip_address</code>
attribute in the request body to associate a specific fixed IP
address with the floating IP address.
</para>
<para>
You can create floating IPs on external networks only.
</para>
<para>
You must configure an IP address with the internal OpenStack
Networking port that is associated with the floating IP
address.
</para>
<para>Error codes:</para>
<itemizedlist>
<listitem>
<para>
<code>400</code> The operation returns this error code for
one of these reasons:
</para>
<itemizedlist>
<listitem>
<para>The specified network is not external, such as
<code>router:external=False</code>.
</para>
</listitem>
<listitem>
<para>The specified internal OpenStack
Networking port is not associated with the floating IP
address.
</para>
</listitem>
<listitem>
<para>
The requested floating IP address does not fall in the
subnet range for the external network.
</para>
</listitem>
<listitem>
<para>
The specified fixed IP address is not valid.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><code>404</code> The specified port ID is not valid.
</para>
</listitem>
<listitem>
<para>
<code>409</code> The operation returns this error code for
one of these reasons:
</para>
<itemizedlist>
<listitem>
<para>
The requested floating IP address is already in use.
</para>
</listitem>
<listitem>
<para>
The internal OpenStack Networking port and
specified fixed IP address are already associated
with another floating IP.
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</wadl:doc>
<request> &floating-ipParameter; &tenant-idParameter;
&floating-network-idParameter; &fixed-ip-addressParameter;
@ -528,10 +577,9 @@ Accept: application/json</programlisting>
<para>Use the <code>fields</code> query parameter to
control which fields are returned in the response
body. For information, see <link
xlink:href="http://docs.openstack.org/api/openstack-network/2.0/content/filtering.html"
>Filtering and Column Selection</link> in the
<citetitle>OpenStack Networking API v2.0
Reference</citetitle>.</para>
xlink:href="http://specs.openstack.org/openstack/neutron-specs/specs/api/
networking_general_api_information.html#filtering-and-column-selection"
>Filtering and Column Selection</link>.</para>
<para>This example request shows details for a floating IP
in JSON format. This example also filters the result
by the <code>fixed_ip_address</code> and

22
api-ref/src/wadls/netconn-api/src/os-networks-provider-ext.wadl
View File

@ -26,9 +26,9 @@
<resources base="https://neutron.example.com/"
xml:id="os-networks-provider-ext-v2.0">
<resource id="version" path="//v2.0">
<resource id="Networks" path="networks">
<method href="#listNetworks"/>
<method href="#createNetwork"/>
<resource id="ProviderNetworks" path="networks">
<method href="#listProviderNetworks"/>
<method href="#createProviderNetwork"/>
<resource path="{network_id}" id="network_id">
<param name="network_id" style="template"
type="csapi:UUID">
@ -38,9 +38,9 @@
network of interest to
you.</para></wadl:doc>
</param>
<method href="#showNetwork"/>
<method href="#updateNetwork"/>
<method href="#deleteNetwork"/>
<method href="#showProviderNetwork"/>
<method href="#updateProviderNetwork"/>
<method href="#deleteProviderNetwork"/>
</resource>
</resource>
</resource>
@ -48,7 +48,7 @@
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<method name="GET" id="listNetworks">
<method name="GET" id="listProviderNetworks">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List networks">
<para role="shortdesc">Lists networks that are accessible
@ -74,7 +74,7 @@
</representation>
</response>
</method>
<method name="POST" id="createNetwork">
<method name="POST" id="createProviderNetwork">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
title="Create network" xml:lang="EN">
<para role="shortdesc">Creates a network.</para>
@ -114,7 +114,7 @@
</representation>
</response>
</method>
<method name="GET" id="showNetwork">
<method name="GET" id="showProviderNetwork">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
title="Show network details">
<para role="shortdesc">Shows details for a specified
@ -140,7 +140,7 @@
</representation>
</response>
</method>
<method name="PUT" id="updateNetwork">
<method name="PUT" id="updateProviderNetwork">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
title="Update network">
<para role="shortdesc">Updates a specified network.</para>
@ -184,7 +184,7 @@
</representation>
</response>
</method>
<method name="DELETE" id="deleteNetwork">
<method name="DELETE" id="deleteProviderNetwork">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
title="Delete network">
<para role="shortdesc">Deletes a specified network.</para>

52
api-ref/src/wadls/netconn-api/src/os-networks.wadl
View File

@ -37,24 +37,24 @@
<method href="#getExtension"/>
</resource>
</resource>
<resource id="Networks" type="#NetworkList"
path="networks">
<method href="#createNetwork"/>
<method href="#bulkCreateNetwork"/>
<resource path="{network_id}" id="network_id">
<param name="network_id" style="template"
type="csapi:UUID">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Network ID">The
UUID for the network of interest to
you.</wadl:doc>
</param>
<method href="#showNetwork"/>
<method href="#updateNetwork"/>
<method href="#deleteNetwork"/>
</resource>
<resource id="Networks" type="#NetworkList"
path="networks">
<method href="#createNetwork"/>
<method href="#bulkCreateNetwork"/>
<resource path="{network_id}" id="network_id">
<param name="network_id" style="template"
type="csapi:UUID">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Network ID">The
UUID for the network of interest to
you.</wadl:doc>
</param>
<method href="#showNetwork"/>
<method href="#updateNetwork"/>
<method href="#deleteNetwork"/>
</resource>
</resource>
</resource>
</resources>
<resource_type id="NetworkList">
@ -210,13 +210,10 @@
<para role="shortdesc">Lists networks to which the
specified tenant has access.</para>
<para>You can control which attributes are returned by
using the fields query parameter. For information, see
<link
xlink:href="http://specs.openstack.org/openstack/neutron-specs/specs/
api/networking_general_api_information.html#filtering-and-column-selection"
>Filtering and Column Selection</link> in the
<citetitle>OpenStack Networking API v2.0
Reference</citetitle>.</para>
using the fields query parameter. For information, see <link
xlink:href="http://specs.openstack.org/openstack/neutron-specs/specs/api/
networking_general_api_information.html#filtering-and-column-selection"
>Filtering and Column Selection</link>.</para>
</wadl:doc>
<response status="200">
<param required="true" name="admin_state_up" style="plain"
@ -519,13 +516,10 @@
<para role="shortdesc">Shows information for a specified
network.</para>
<para>You can control which attributes are returned by
using the fields query parameter. For information, see
<link
using the fields query parameter. For information, see <link
xlink:href="http://specs.openstack.org/openstack/neutron-specs/specs/api/
networking_general_api_information.html#filtering-and-column-selection"
>Filtering and Column Selection</link> in the
<citetitle>OpenStack Networking API v2.0
Reference</citetitle>.</para>
>Filtering and Column Selection</link>.</para>
</wadl:doc>
<response status="200">
<param required="true" name="admin_state_up" style="plain"

10
api-ref/src/wadls/netconn-api/src/os-ports.wadl
View File

@ -61,12 +61,10 @@
administrative rights. Users can control which
attributes are returned by using the fields query
parameter. Additionally, you can filter results by
using query string parameters. For information, see
<link
xlink:href="http://docs.openstack.org/api/openstack-network/2.0/content/filtering.html"
>Filtering and Column Selection</link> in the
<citetitle>OpenStack Networking API v2.0
Reference</citetitle>.</para>
using query string parameters. For information, see <link
xlink:href="http://specs.openstack.org/openstack/neutron-specs/specs/api/
networking_general_api_information.html#filtering-and-column-selection"
>Filtering and Column Selection</link>.</para>
</wadl:doc>
<request> &portListQueryParameters; </request>
<response status="200"> &portListParameters;