openstack
/
api-site
Code Issues Proposed changes

Update /v2.0/network-ip-availabilities methods 

This patch changes /v2.0/nework-ip-availabilities to
/v2.0/nework-ip-availabilities/{network_id} for showing network IP
availability of all networks in Networking API v2.0 extensions,
updates some wrong parameters in Response tables and JSON samples
for all network-ip-availabilities methods.

Change-Id: Icfa73402687e49e1f6d439da4b7c0118bc253284
Closes-bug: #1566563
This commit is contained in:
Nguyen Tuong Thanh 2016-04-20 09:16:37 +07:00
parent e6e209a907
commit 8b8f8147f5
5 changed files with 83 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-ref/src/docbkx/ch_networking-v2-ext.xml
View File

@ -534,7 +534,7 @@
<wadl:resource href="../wadls/networking-api/src/wadl/network-ip-availability.wadl#network-ip-availability">
<wadl:method href="#ListNetworkIpAvailability"/>
</wadl:resource>
<wadl:resource href="../wadls/networking-api/src/wadl/network-ip-availability.wadl#network-ip-availability">
<wadl:resource href="../wadls/networking-api/src/wadl/network-ip-availability.wadl#network_id">
<wadl:method href="#ShowNetworkIpAvailability"/>
</wadl:resource>
</wadl:resources>

24
api-ref/src/wadls/networking-api/src/common.ent
View File

@ -10292,20 +10292,32 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY net-ip-availabilityResponseParameters '
<!ENTITY net-ip-availability-listResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
required="true"
name="network_ip_availabilities" style="plain" type="xsd:list">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The <code>network_ip_availabilities</code> object.
A list of <code>network_ip_availability</code> objects.
</para>
</wadl:doc>
</param>
</param>'>
<!ENTITY net-ip-availability-showResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
required="true"
name="id" style="plain" type="csapi:UUID">
name="network_ip_availability" style="plain" type="xsd:dict">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
A <code>network_ip_availability</code> object.
</para>
</wadl:doc>
</param>'>
<!ENTITY net-ip-availability-commonResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
required="true"
name="network_id" style="plain" type="csapi:UUID">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
@ -10315,7 +10327,7 @@
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
required="true"
name="name" style="plain" type="xsd:string">
name="network_name" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
@ -10354,7 +10366,7 @@
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="name" style="plain" type="xsd:string">
name="subnet_name" style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>

54
api-ref/src/wadls/networking-api/src/samples/network-ip-availability/network-ip-availability-list.json
View File

@ -1,46 +1,54 @@
{
"network_ip_availabilities": [
{
"id": "6ed07354-852f-41f8-8555-511d995cd17e",
"name": "net3",
"network_id": "4cf895c9-c3d1-489e-b02e-59b5c8976809",
"network_name": "public",
"subnet_ip_availability": [
{
"cidr": "40.0.0.0/24",
"cidr": "2001:db8::/64",
"ip_version": 6,
"subnet_id": "ca3f46c4-c6ff-4272-9be4-0466f84c6077",
"subnet_name": "ipv6-public-subnet",
"total_ips": 18446744073709552000,
"used_ips": 1
},
{
"cidr": "172.24.4.0/24",
"ip_version": 4,
"name": "",
"subnet_id": "6df63baf-7c98-4cf6-a9a3-f0b5cbceeaa0",
"subnet_id": "cc02efc1-9d47-46bd-bab6-760919c836b5",
"subnet_name": "public-subnet",
"total_ips": 253,
"used_ips": 2
"used_ips": 1
}
],
"tenant_id": "test-tenant",
"tenant_id": "1a02cc95f1734fcc9d3c753818f03002",
"total_ips": 253,
"used_ips": 2
},
{
"id": "aba3b29b-c119-4b45-afbd-88e500acd970",
"name": "net1",
"network_id": "6801d9c8-20e6-4b27-945d-62499f00002e",
"network_name": "private",
"subnet_ip_availability": [
{
"cidr": "10.0.0.0/24",
"ip_version": 4,
"name": "",
"subnet_id": "df3f70c7-8096-47b6-95ae-b3a7d62b937f",
"subnet_id": "44e70d00-80a2-4fb1-ab59-6190595ceb61",
"subnet_name": "private-subnet",
"total_ips": 253,
"used_ips": 3
"used_ips": 2
},
{
"ip_version": 6,
"cidr": "fdbf:ac66:9be8::/64",
"subnet_id": "a90623df-00e1-4902-a675-40674385d74c",
"subnet_name": "ipv6-private-subnet",
"total_ips": 18446744073709552000,
"used_ips": 2
}
],
"tenant_id": "test-tenant",
"total_ips": 253,
"used_ips": 3
},
{
"id": "cf98f2d0-67db-4ed8-a9d5-06033338dc1b",
"name": "net2",
"subnet_ip_availability": [],
"tenant_id": "test-tenant",
"total_ips": 0,
"used_ips": 0
"tenant_id": "d56d3b8dd6894a508cf41b96b522328c",
"total_ips": 18446744073709552000,
"used_ips": 4
}
]
}

28
api-ref/src/wadls/networking-api/src/samples/network-ip-availability/network-ip-availability-show.json
View File

@ -1,19 +1,27 @@
{
"network_ip_availability": {
"id": "aba3b29b-c119-4b45-afbd-88e500acd970",
"name": "net1",
"used_ips": 4,
"subnet_ip_availability": [
{
"cidr": "10.0.0.0/24",
"used_ips": 2,
"subnet_id": "44e70d00-80a2-4fb1-ab59-6190595ceb61",
"subnet_name": "private-subnet",
"ip_version": 4,
"name": "",
"subnet_id": "df3f70c7-8096-47b6-95ae-b3a7d62b937f",
"total_ips": 253,
"used_ips": 3
"cidr": "10.0.0.0/24",
"total_ips": 253
},
{
"used_ips": 2,
"subnet_id": "a90623df-00e1-4902-a675-40674385d74c",
"subnet_name": "ipv6-private-subnet",
"ip_version": 6,
"cidr": "fdbf:ac66:9be8::/64",
"total_ips": 18446744073709552000
}
],
"tenant_id": "test-tenant",
"total_ips": 253,
"used_ips": 3
"network_id": "6801d9c8-20e6-4b27-945d-62499f00002e",
"tenant_id": "d56d3b8dd6894a508cf41b96b522328c",
"total_ips": 18446744073709552000,
"network_name": "private"
}
}

28
api-ref/src/wadls/networking-api/src/wadl/network-ip-availability.wadl
View File

@ -5,7 +5,7 @@
<!-- -->
<!-- You can resolve the entities with xmllint -->
<!-- -->
<!-- xmllint -noent routers.wadl -->
<!-- xmllint -noent network-ip-availability.wadl -->
<!--*******************************************************-->
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
@ -24,14 +24,14 @@
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://neutron.example.com/" xml:id="os-routers-v2">
<resources base="https://neutron.example.com/" xml:id="network-ip-availabilities-v2">
<resource id="version" path="//v2.0">
<resource id="network-ip-availability" path="network-ip-availabilities">
<method href="#ListNetworkIpAvailability" />
<method href="#ShowNetworkIpAvailability" />
<resource path="{network_id}" id="network_id">
&network_idTemplateParameter;
</resource>
<method href="#ListNetworkIpAvailability" />
<resource path="{network_id}" id="network_id">
&network_idTemplateParameter;
<method href="#ShowNetworkIpAvailability" />
</resource>
</resource>
</resource>
</resources>
@ -39,8 +39,8 @@
<!-- All Methods -->
<!--*******************************************************-->
<method name="GET" id="ListNetworkIpAvailability">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Network IP Availability">
<para role="shortdesc">List network IP availability of all networks.</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List Network IP Availability">
<para role="shortdesc">Lists network IP availability of all networks.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
@ -49,7 +49,8 @@
<xsdxt:code
href="../samples/network-ip-availability/network-ip-availability-list.json"/>
</wadl:doc>
&net-ip-availabilityResponseParameters;
&net-ip-availability-listResponseParameter;
&net-ip-availability-commonResponseParameters;
</representation>
</response>
<response status="401"
@ -66,8 +67,8 @@
</response>
</method>
<method name="GET" id="ShowNetworkIpAvailability">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Network IP Availability">
<para role="shortdesc">Show network IP availability of all networks.</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show Network IP Availability">
<para role="shortdesc">Shows network IP availability details for a network.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
@ -76,7 +77,8 @@
<xsdxt:code
href="../samples/network-ip-availability/network-ip-availability-show.json"/>
</wadl:doc>
&net-ip-availabilityResponseParameters;
&net-ip-availability-showResponseParameter;
&net-ip-availability-commonResponseParameters;
</representation>
</response>
<response status="401"