openstack/api-site
Code Issues Proposed changes

Network v2.0 API network-show response confusing

Browse Source 
The network-show API doc lists all non-extension response parameters,
but features an example response that includes extension parameters.
This is confusing.
Proposed solution: Remove extension parameters from the example and add a
pointer to the Network API extension page.

Change-Id: I9a7b47969f8f05f7ddac2339eceb1084418bf965
Closes-Bug: 1454302
This commit is contained in:
Bernd Bausch 2015-06-28 13:01:01 +09:00 committed by Diane Fleming
parent 24fe19e79f
commit 8f68b6215a
3 changed files with 17 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api-ref/src/wadls/netconn-api/src/api_samples/networks-get-detail-resp.json
View File

@ -5,13 +5,9 @@
"54d6f61d-db07-451c-9ab3-b9609b6b6f0b" "54d6f61d-db07-451c-9ab3-b9609b6b6f0b"
], ],
"name": "private-network", "name": "private-network",
"provider:physical_network": null,
"admin_state_up": true, "admin_state_up": true,
"tenant_id": "4fd44f30292945e481c7b8a0c8908869", "tenant_id": "4fd44f30292945e481c7b8a0c8908869",
"provider:network_type": "local",
"router:external": true,
"shared": true, "shared": true,
"id": "d32019d3-bc6e-4319-9c1d-6722fc136a22", "id": "d32019d3-bc6e-4319-9c1d-6722fc136a22"
"provider:segmentation_id": null
} }
} }

4
api-ref/src/wadls/netconn-api/src/api_samples/networks-get-detail-resp.xml
View File

@ -9,12 +9,8 @@
<subnet>54d6f61d-db07-451c-9ab3-b9609b6b6f0b</subnet> <subnet>54d6f61d-db07-451c-9ab3-b9609b6b6f0b</subnet>
</subnets> </subnets>
<name>private-network</name> <name>private-network</name>
<provider:physical_network xsi:nil="true"/>
<admin_state_up quantum:type="bool">True</admin_state_up> <admin_state_up quantum:type="bool">True</admin_state_up>
<tenant_id>4fd44f30292945e481c7b8a0c8908869</tenant_id> <tenant_id>4fd44f30292945e481c7b8a0c8908869</tenant_id>
<provider:network_type>local</provider:network_type>
<router:external quantum:type="bool">True</router:external>
<shared quantum:type="bool">True</shared> <shared quantum:type="bool">True</shared>
<id>d32019d3-bc6e-4319-9c1d-6722fc136a22</id> <id>d32019d3-bc6e-4319-9c1d-6722fc136a22</id>
<provider:segmentation_id xsi:nil="true"/>
</network> </network>

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

@ -209,10 +209,10 @@
title="List networks"> title="List networks">
<para role="shortdesc">Lists networks to which the <para role="shortdesc">Lists networks to which the
specified tenant has access.</para> specified tenant has access.</para>
<para>You can control which attributes are returned by <para>You can control which response parameters 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" 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> >Filtering and column selection</link>.</para>
</wadl:doc> </wadl:doc>
<response status="200"> <response status="200">
<param required="true" name="admin_state_up" style="plain" <param required="true" name="admin_state_up" style="plain"
@ -514,19 +514,26 @@
title="Show network"> title="Show network">
<para role="shortdesc">Shows information for a specified <para role="shortdesc">Shows information for a specified
network.</para> network.</para>
<para>You can control which attributes are returned by <para>You can control which response parameters 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" 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> >Filtering and column selection</link>.</para>
<para>
In addition to the following response parameters, the response
might show extension response parameters. For information, see <link
xlink:href="http://developer.openstack.org/api-ref-networking-v2-ext.html#showProviderNetwork">Networks multiple provider extension (networks)</link>.
</para>
</wadl:doc> </wadl:doc>
<response status="200"> <response status="200">
<param required="true" name="admin_state_up" style="plain" <param required="true" name="admin_state_up" style="plain"
type="xsd:bool"> type="xsd:bool">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The administrative state of xml:lang="EN">
the network, which is up (<code>true</code>) <para>
or down The administrative state of the network, which is up
(<code>false</code>).</para></wadl:doc> (<code>true</code>) or down (<code>false</code>).
</para>
</wadl:doc>
</param> </param>
<param required="true" name="id" style="plain" <param required="true" name="id" style="plain"
type="csapi:uuid"> type="csapi:uuid">