openstack
/
api-site
Code Issues Proposed changes

Neutron: "List routers" doesn't show fully parameters 

This patch adds "availability_zone_hints" and "availability_zones"
attributes into response parameters of
list/create/update/show routers api

Change-Id: I8f8e61080687492e06699b4c346f4509904b2bf2
Co-Authored-By: Nguyen Phuong An <annp@vn.fujitsu.com>
Closes-Bug: #1529546
This commit is contained in:
Cao Xuan Hoang 2015-12-28 15:26:24 +07:00 committed by Diane Fleming
parent 396721f9d2
commit 3c391528e1
6 changed files with 153 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
api-ref/src/wadls/netconn-api/src/common.ent
View File

@ -1993,6 +1993,28 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY availability_zone_hintsResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="availability_zone_hints" style="plain" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The availability zone candidate for the router.
</para>
</wadl:doc>
</param>'>
<!ENTITY availability_zonesResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="availability_zones" style="plain" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The availability zone for the router.
</para>
</wadl:doc>
</param>'>
<!ENTITY routersParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="routers" style="plain" type="xsd:list">

4
api-ref/src/wadls/netconn-api/src/samples/routers/router-create-response.json
View File

@ -10,6 +10,10 @@
}
]
},
"availability_zone_hints": [],
"availability_zones": [
"nova"
],
"name": "another_router",
"admin_state_up": true,
"tenant_id": "6b96ff0cb17a4b859e1e575d221683d3",

4
api-ref/src/wadls/netconn-api/src/samples/routers/router-show-response.json
View File

@ -10,6 +10,10 @@
}
]
},
"availability_zone_hints": [],
"availability_zones": [
"nova"
],
"name": "router1",
"admin_state_up": true,
"tenant_id": "d6554fe62e2f41efbb6e026fad5c1542",

4
api-ref/src/wadls/netconn-api/src/samples/routers/router-update-response.json
View File

@ -10,6 +10,10 @@
}
]
},
"availability_zone_hints": [],
"availability_zones": [
"nova"
],
"name": "another_router",
"admin_state_up": true,
"tenant_id": "6b96ff0cb17a4b859e1e575d221683d3",

8
api-ref/src/wadls/netconn-api/src/samples/routers/routers-list-response.json
View File

@ -3,6 +3,10 @@
{
"status": "ACTIVE",
"external_gateway_info": null,
"availability_zone_hints": [],
"availability_zones": [
"nova"
],
"name": "second_routers",
"admin_state_up": true,
"tenant_id": "6b96ff0cb17a4b859e1e575d221683d3",
@ -20,6 +24,10 @@
}
]
},
"availability_zone_hints": [],
"availability_zones": [
"nova"
],
"name": "router1",
"admin_state_up": true,
"tenant_id": "33a40233088643acb66ff6eb0ebea679",

157
api-ref/src/wadls/netconn-api/src/wadl/layer3.wadl
View File

@ -96,11 +96,8 @@ Accept: application/json</programlisting>
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;
&admin-state-upParameter; &tenant-idParameter;
&distributedOptionalParameter; &routesParameter; &haOptionalParameter;
&idParameter; <representation mediaType="application/json"
<response status="200">
<representation mediaType="application/json"
element="csapi:router">
<wadl:doc
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -109,6 +106,17 @@ Accept: application/json</programlisting>
<xsdxt:code
href="../samples/routers/routers-list-response.json"/>
</wadl:doc>
&statusParameter;
&external-gateway-infoParameter;
&availability_zone_hintsResponseParameter;
&availability_zonesResponseParameter;
&nameParameter;
&admin-state-upParameter;
&tenant-idParameter;
&distributedOptionalParameter;
&routesParameter;
&haOptionalParameter;
&idParameter;
</representation>
</response> &fault401; </method>
<method name="POST" id="createRouter">
@ -135,9 +143,8 @@ Accept: application/json</programlisting>
}
}</programlisting>
</wadl:doc>
<request> &routerParameter; &external-gateway-infoOptionalParameter;
&nameOptionalParameter; &admin-state-upOptionalParameter;
<representation
<request>
<representation
mediaType="application/json" element="csapi:router">
<wadl:doc
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -146,12 +153,14 @@ Accept: application/json</programlisting>
<xsdxt:code
href="../samples/routers/router-create-request.json"/>
</wadl:doc>
&routerParameter;
&external-gateway-infoOptionalParameter;
&nameOptionalParameter;
&admin-state-upOptionalParameter;
</representation>
</request>
<response status="201"> &routerParameter; &statusParameter;
&external-gateway-infoParameter; &nameParameter;
&admin-state-upParameter; &tenant-idParameter; &routesParameter;
&idParameter; <representation mediaType="application/json"
<response status="201">
<representation mediaType="application/json"
element="csapi:router">
<wadl:doc
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -160,6 +169,16 @@ Accept: application/json</programlisting>
<xsdxt:code
href="../samples/routers/router-create-response.json"/>
</wadl:doc>
&routerParameter;
&statusParameter;
&external-gateway-infoParameter;
&availability_zone_hintsResponseParameter;
&availability_zonesResponseParameter;
&nameParameter;
&admin-state-upParameter;
&tenant-idParameter;
&routesParameter;
&idParameter;
</representation>
</response> &fault400; &fault401; </method>
<method name="GET" id="showRouter">
@ -176,11 +195,8 @@ Accept: application/json</programlisting>
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"> &routerParameter; &statusParameter;
&external-gateway-infoParameter; &nameParameter;
&admin-state-upParameter; &tenant-idParameter;
&distributedOptionalParameter; &routesParameter; &haOptionalParameter;
&idParameter; <representation mediaType="application/json"
<response status="200">
<representation mediaType="application/json"
element="csapi:router">
<wadl:doc
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -190,6 +206,18 @@ Accept: application/json</programlisting>
href="../samples/routers/router-show-response.json"
/>
</wadl:doc>
&routerParameter;
&statusParameter;
&external-gateway-infoParameter;
&availability_zone_hintsResponseParameter;
&availability_zonesResponseParameter;
&nameParameter;
&admin-state-upParameter;
&tenant-idParameter;
&distributedOptionalParameter;
&routesParameter;
&haOptionalParameter;
&idParameter;
</representation>
</response> &fault401; &fault403; &fault404; </method>
<method name="PUT" id="updateRouter">
@ -208,8 +236,7 @@ Accept: application/json</programlisting>
<programlisting>PUT /v2.0/routers/{router_id}
Accept: application/json</programlisting>
</wadl:doc>
<request> &routerParameter; &external-gateway-infoOptionalParameter;
&nameOptionalParameter; &admin-state-upOptionalParameter;
<request>
<representation mediaType="application/json"
element="csapi:router">
<wadl:doc
@ -220,12 +247,14 @@ Accept: application/json</programlisting>
href="../samples/routers/router-update-request.json"
/>
</wadl:doc>
&routerParameter;
&external-gateway-infoOptionalParameter;
&nameOptionalParameter;
&admin-state-upOptionalParameter;
</representation>
</request>
<response status="200"> &routerParameter; &statusParameter;
&external-gateway-infoParameter; &nameParameter;
&admin-state-upParameter; &tenant-idParameter; &routesParameter;
&idParameter; <representation mediaType="application/json"
<response status="200">
<representation mediaType="application/json"
element="csapi:router">
<wadl:doc
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -235,6 +264,16 @@ Accept: application/json</programlisting>
href="../samples/routers/router-update-response.json"
/>
</wadl:doc>
&routerParameter;
&statusParameter;
&external-gateway-infoParameter;
&availability_zone_hintsResponseParameter;
&availability_zonesResponseParameter;
&nameParameter;
&admin-state-upParameter;
&tenant-idParameter;
&routesParameter;
&idParameter;
</representation>
</response> &fault400; &fault401; &fault404; </method>
<method name="DELETE" id="deleteRouter">
@ -359,7 +398,8 @@ Accept: application/json</programlisting></wadl:doc>
href="../samples/routers/router-add-interface-request.json"
/>
</wadl:doc>
&subnet-idParameter; &port-idParameter;
&subnet-idParameter;
&port-idParameter;
</representation>
</request>
<response status="200">
@ -415,8 +455,8 @@ Accept: application/json</programlisting></wadl:doc>
<programlisting>PUT /v2.0/routers/{router_id}/remove_router_interface
Accept: application/json</programlisting>
</wadl:doc>
<request> &subnet-idParameter; &port-idParameter;
<representation mediaType="application/json"
<request>
<representation mediaType="application/json"
element="csapi:router">
<wadl:doc
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -426,10 +466,12 @@ Accept: application/json</programlisting>
href="../samples/routers/router-remove-interface-request.json"
/>
</wadl:doc>
&subnet-idParameter;
&port-idParameter;
</representation>
</request>
<response status="200"> &idParameter; &tenant-idParameter;
&port-idParameter; &subnet-idParameter; <representation
<response status="200">
<representation
mediaType="application/json" element="csapi:router">
<wadl:doc
xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -439,6 +481,10 @@ Accept: application/json</programlisting>
href="../samples/routers/router-remove-interface-response.json"
/>
</wadl:doc>
&idParameter;
&tenant-idParameter;
&port-idParameter;
&subnet-idParameter;
</representation>
</response> &fault400; &fault401; &fault404; &fault409; </method>
<method name="GET" id="listFloatingIps">
@ -466,10 +512,8 @@ Accept: application/json</programlisting>
>Filtering and Column Selection</link>.
</para>
</wadl:doc>
<response status="200"> &floating-ipsParameter;
&router-idParameter; &tenant-idParameter; &floating-network-idParameter;
&fixed-ip-addressResponseParameter; &floating-ip-addressResponseParameter;
&port-idParameter; &floatingip-idParameter; &floatingip-statusParameter; <representation
<response status="200">
<representation
mediaType="application/json"
element="csapi:floatingip">
<wadl:doc
@ -480,6 +524,15 @@ Accept: application/json</programlisting>
href="../samples/routers/floating-ips-list-response.json"
/>
</wadl:doc>
&floating-ipsParameter;
&router-idParameter;
&tenant-idParameter;
&floating-network-idParameter;
&fixed-ip-addressResponseParameter;
&floating-ip-addressResponseParameter;
&port-idParameter;
&floatingip-idParameter;
&floatingip-statusParameter;
</representation>
</response> &fault401; </method>
<method name="POST" id="createFloatingIp">
@ -584,7 +637,7 @@ Accept: application/json</programlisting>
</listitem>
</itemizedlist>
</wadl:doc>
<request> &floatingipCreateRequestParams;
<request>
<representation mediaType="application/json"
element="csapi:floatingip">
<wadl:doc
@ -594,6 +647,7 @@ Accept: application/json</programlisting>
<xsdxt:code
href="../samples/routers/floatingip-create-request.json"/>
</wadl:doc>
&floatingipCreateRequestParams;
</representation>
</request>
<response status="201"> &floating-ipParameter;
@ -631,12 +685,7 @@ Accept: application/json</programlisting>
<programlisting>GET /v2.0/floatingips/{floatingip_id}?fields=fixed_ip_address&amp;fields=floating_ip_address
Accept: application/json</programlisting>
</wadl:doc>
<response status="200"> &floating-ipParameter;
&floating-network-idParameter; &router-idParameter;
&fixed-ip-addressResponseParameter;
&floating-ip-addressResponseParameter;
&tenant-idParameter; &floatingip-statusParameter;
&port-idParameter; &floatingip-idParameter;
<response status="200">
<representation
mediaType="application/json"
element="csapi:floatingip">
@ -648,6 +697,15 @@ Accept: application/json</programlisting>
href="../samples/routers/floatingip-show-response.json"
/>
</wadl:doc>
&floating-ipParameter;
&floating-network-idParameter;
&router-idParameter;
&fixed-ip-addressResponseParameter;
&floating-ip-addressResponseParameter;
&tenant-idParameter;
&floatingip-statusParameter;
&port-idParameter;
&floatingip-idParameter;
</representation>
</response> &fault401; &fault403; &fault404; </method>
<method name="PUT" id="updateFloatingIp">
@ -667,7 +725,8 @@ Accept: application/json</programlisting>
request associates a port with or disassociates a port
from a floating IP.</para>
</wadl:doc>
<request> &port-idParameter; <representation
<request>
<representation
mediaType="application/json"
element="csapi:floatingip">
<wadl:doc
@ -679,6 +738,7 @@ Accept: application/json</programlisting>
href="../samples/routers/floatingip-update-request.json"
/>
</wadl:doc>
&port-idParameter;
</representation>
<representation mediaType="application/json"
element="csapi:floatingip">
@ -693,12 +753,8 @@ Accept: application/json</programlisting>
</wadl:doc>
</representation>
</request>
<response status="200"> &floating-ipParameter;
&floating-network-idParameter; &router-idParameter;
&fixed-ip-addressResponseParameter;
&floating-ip-addressResponseParameter;
&tenant-idParameter; &floatingip-statusParameter;
&port-idParameter; &floatingip-idParameter; <representation
<response status="200">
<representation
mediaType="application/json"
element="csapi:floatingip">
<wadl:doc
@ -710,6 +766,15 @@ Accept: application/json</programlisting>
href="../samples/routers/floatingip-update-response.json"
/>
</wadl:doc>
&floating-ipParameter;
&floating-network-idParameter;
&router-idParameter;
&fixed-ip-addressResponseParameter;
&floating-ip-addressResponseParameter;
&tenant-idParameter;
&floatingip-statusParameter;
&port-idParameter;
&floatingip-idParameter;
</representation>
<representation mediaType="application/json"
element="csapi:floatingip">