From 2308d33577427994ddd5f0aed6c04a3cd0bbb78c Mon Sep 17 00:00:00 2001 From: BaoLiang Cui Date: Tue, 22 Sep 2015 06:52:36 -0400 Subject: [PATCH] Correct description of response parameters Some description of response parameters are incorrect for calls of "health monitors"(getlist,show,create,update). "The unique ID for the VIP." should be as below: "The unique ID for the Health Monitor" "The ID of the tenant who owns the VIP..." should be as below: "The ID of the tenant who owns the Health Monitor..." So I correct this in /api-ref/src/wadls/netconn-api/src/common.ent. Closes-Bug: #1493702 Change-Id: Iab34fefe3e65eb2c56bd686724feb6f08857cd51 --- api-ref/src/wadls/netconn-api/src/common.ent | 270 +++++++++++-------- 1 file changed, 152 insertions(+), 118 deletions(-) diff --git a/api-ref/src/wadls/netconn-api/src/common.ent b/api-ref/src/wadls/netconn-api/src/common.ent index 7f4ce4568..4a39a6393 100644 --- a/api-ref/src/wadls/netconn-api/src/common.ent +++ b/api-ref/src/wadls/netconn-api/src/common.ent @@ -173,25 +173,37 @@ name="id" style="plain" type="csapi:uuid"> - The network ID. + + The network ID. + + - The network name. + + The network name. + + - Indicates whether this network is shared across all tenants. + + Indicates whether this network is shared across all tenants. + + - The network status. + + The network status. + + @@ -215,7 +227,7 @@ name="mtu" style="plain" type="xsd:integer"> - MTU of a network resource. + The MTU of a network resource. @@ -382,8 +394,11 @@ name="vlan_transparent" style="plain" type="xsd:bool"> - The state of the network, which is VLAN transparent (true) - or not VLAN transparent (false). + + The state of the network, which is VLAN transparent + (true) or not VLAN transparent (false). + + '> - IP addresses for the port. Includes the IP address and subnet - ID. + The IP addresses for the port. Includes the IP address and + subnet ID. @@ -701,7 +716,7 @@ - Subnet ID of the subnet to which the port is attached. + The ID of the subnet to which the port is attached. @@ -710,7 +725,7 @@ - IP address. + The IP address. @@ -763,7 +778,7 @@ - The port status. Value is ACTIVE or DOWN. + The port status. Value is ACTIVE or DOWN. @@ -852,28 +867,22 @@ virtual server. - -'> + '> + &portCommonRequestParams;'> + &portCommonResponseParams;'> + &portCommonResponseParams;'> + &portCommonRequestParams;'> + &portCommonResponseParams;'> @@ -907,8 +916,7 @@ direct, or macvtap. - -'> + '> @@ -1005,8 +1013,7 @@ attribute is visible to only port owners and administrative users. - -'> + '> - The ID of the tenant who owns the network. Only - administrative users can specify a tenant ID other than their - own. - + + The ID of the tenant who owns the network. Only administrative + users can specify a tenant ID other than their own. + + @@ -1074,19 +1082,24 @@ name="enable_dhcp" style="plain" type="xsd:boolean"> - Set to true if DHCP is enabled and false if DHCP is disabled. + + Set to true if DHCP is enabled and + false if DHCP is disabled. + + - DNS server. + The DNS server. - A list of host route dictionaries for the subnet. - For example: - "host_routes":[ + + A list of host route dictionaries for the subnet. For example: + +"host_routes":[ { "destination":"0.0.0.0/0", "nexthop":"123.456.78.9" @@ -1095,12 +1108,13 @@ "destination":"192.168.0.0/24", "nexthop":"192.168.0.1" } -] +] + - Destination for static route. + The destination for static route. @@ -1124,12 +1138,12 @@ dhcpv6-stateless, or slaac. - - '> -'> + - Name of the network. + The name of the network. @@ -1160,19 +1174,34 @@ - If true, DHCP is enabled and If false, DHCP is disabled. + + If true, DHCP is enabled. If false, DHCP + is disabled. + + - Choose from (constants.IPV6_SLAAC,constants.DHCPV6_STATEFUL,constants.DHCPV6_STATELESS,name='ipv6_address_modes,null). + + Choose from constants.IPV6_SLAAC, + constants.DHCPV6_STATEFUL, constants.DHCPV6_STATELESS, + name='ipv6_address_modes, or null. + + - Choose from (constants.IPV6_SLAAC,constants.DHCPV6_STATEFUL,constants.DHCPV6_STATELESS,name='ipv6_address_modes,null). + + Choose from constants.IPV6_SLAAC, + constants.DHCPV6_STATEFUL, + constants.DHCPV6_STATELESS, + name='ipv6_address_modes, or null. + + '> - + @@ -1190,7 +1219,7 @@ The start and end addresses for the allocation pools. + name="start" style="plain" type="xsd:string"> The start address for the allocation pools. @@ -1217,7 +1246,7 @@ - Set to true if DHCP is enabled and false if DHCP is disabled. + Set to true if DHCP is enabled and false if DHCP is disabled. @@ -1242,7 +1271,7 @@ - Destination for static route + The destination for static route @@ -1287,12 +1316,16 @@ - Set to true if DHCP is enabled and false if DHCP is disabled. + + Set to true if DHCP is enabled and false + if DHCP is disabled. + + - DNS server + The DNS server @@ -1312,7 +1345,7 @@ - Destination for static route + The destination for static route @@ -1917,7 +1950,7 @@ router. - Description for the pool. + The description for the pool. - Description for the pool. + The description for the pool. - Description for the metering label. + The description for the metering label. '> @@ -2612,7 +2645,7 @@ router. - The unique ID for the VIP. + The unique ID for the health monitor. xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> - The ID of the tenant who owns the VIP. Only administrative users can - specify a tenant ID other than their own. + The ID of the tenant who owns the health monitor. Only + administrative users can specify a tenant ID other than their own. @@ -2662,8 +2695,11 @@ router. - Number of allowed connection failures before changing - the status of the member to INACTIVE. A valid value is from 1 to 10. + + The number of allowed connection failures before changing the status + of the member to INACTIVE. A valid value is from 1 to + 10. + - The HTTP path of the request sent by the monitor to test the health of a member. Must be a string beginning with a forward slash (/). + + The HTTP path of the request sent by the monitor to test the health + of a member. Must be a string beginning with a forward slash (/). + - Path portion of URI that will be probed if type is HTTP(S). + + The path portion of URI that is probed if the type is HTTP or HTTPS. + - Expected HTTP codes for a passing HTTP(S) monitor. + + The expected HTTP codes for a passing HTTP(S) monitor. + ' > name="admin_state_up" style="plain" type="xsd:boolean"> - The administrative state of the VIP. A valid value is true (UP) or false (DOWN). + + The administrative state of the VIP. A valid value is true (UP) or + false (DOWN). + ' > - Session persistence parameters for the VIP. Omit the - session_persistence parameter to prevent session - persistence. When no session persistence is used, the - session_persistence parameter does not appear in the - API response. To clear session persistence for the VIP, set the - session_persistence parameter to null in a - VIP update request. + Session persistence parameters for the VIP. Omit the + session_persistence parameter to prevent session + persistence. When no session persistence is used, the + session_persistence parameter does not appear in the + API response. + + + To clear session persistence for the VIP, set the + session_persistence parameter to null in a + VIP update request. @@ -3587,7 +3636,10 @@ router. - The HTTP path of the request sent by the monitor to test the health of a member. Must be a string beginning with a forward slash (/). + + The HTTP path of the request sent by the monitor to test the health + of a member. Must be a string beginning with a forward slash (/). + name="status" style="plain" type="xsd:string"> - The status of the health monitor. Indicates whether the health monitor is operational. + + The status of the health monitor. Indicates whether the health + monitor is operational. + ' > xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> The administrative state of the member. A valid value is true (UP) or false (DOWN). - -' > +'> @@ -3917,8 +3971,7 @@ router. xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> The administrative state of the member. A valid value is true (UP) or false (DOWN). - -' > +'> @@ -4039,8 +4092,7 @@ router. A security_group_rule object. - -'> + '> @@ -4050,8 +4102,7 @@ router. A security_group_rules object. - -'> + '> @@ -4267,8 +4318,7 @@ router. xml:lang="EN"> VPN service objects. - -' > +'> @@ -4384,8 +4434,7 @@ router. Router ID to which the VPN service is inserted. - -' > +'> @@ -4423,8 +4472,7 @@ router. connections on service are not active. - -' > +'> @@ -4436,8 +4484,7 @@ router. tenant ID other than their own. - -' > +'> @@ -4544,8 +4591,7 @@ router. Lifetime value, as a positive integer. Default is 3600 seconds. - -' > +'> @@ -4554,8 +4600,7 @@ router. xml:lang="EN"> IKE policy objects. - -' > +'> @@ -4682,8 +4727,7 @@ router. Lifetime value, as a positive integer. Default is 3600 seconds. - -' > +'> @@ -4695,8 +4739,7 @@ router. tenant ID other than their own. - -' > +'> @@ -4805,8 +4848,7 @@ router. Lifetime value, as a positive integer. Default is 3600 seconds. - -' > +'> @@ -4815,8 +4857,7 @@ router. xml:lang="EN"> IPSec policy objects. - -' > +'> @@ -4938,8 +4979,7 @@ router. xml:lang="EN"> Lifetime value, as a positive integer. Default is 3600 seconds. - -' > +'> @@ -5008,8 +5048,7 @@ router. xml:lang="EN"> Unique identifier of VPN service. - -' > +'> @@ -5101,7 +5140,7 @@ router. - Dictionary with dead peer detection (DPD) protocol controls. + A dictionary with dead peer detection (DPD) protocol controls. is greater than the DPD interval value. Default is 120. - -' > +'> @@ -5147,8 +5185,7 @@ router. xml:lang="EN"> IPSec site-to-site connection objects. - -' > +'> @@ -5319,7 +5356,7 @@ router. - Dictionary with Dead Peer Detection protocol controls. + A dictionary with Dead Peer Detection protocol controls. Default is 120. - -' > +'> @@ -5493,9 +5529,8 @@ router. merges adjacent prefixes and treats them as a single prefix. - Ensure that each subnet prefix is unique among all subnet prefixes - in all subnet pools that are associated with the specified address - scope. + Each subnet prefix must be unique among all subnet prefixes in all + subnet pools that are associated with the specified address scope. @@ -5880,4 +5915,3 @@ router. '> -