From 250551d938566b270489cf6323175d804b9b2a5b Mon Sep 17 00:00:00 2001 From: ZhaoBo Date: Tue, 13 Dec 2016 22:46:17 +0800 Subject: [PATCH] Fix the status parameters in api-ref This patch fixes the "status" in all inc files. Subsequent patchsets will improve the description of other parameters in the api-ref. Change-Id: I5f07550bf923c1b7c6defd2e8b2b39c9cd397544 Partial-Bug: #1649557 --- api-ref/source/v2/fwaas.inc | 10 +- api-ref/source/v2/lbaas-v1.inc | 24 +-- api-ref/source/v2/lbaas-v2.inc | 10 +- api-ref/source/v2/network-provider.inc | 8 +- .../source/v2/networks-multi-provider-ext.inc | 6 +- .../v2/networks-vlan-transparency-ext.inc | 6 +- api-ref/source/v2/networks.inc | 10 +- api-ref/source/v2/parameters.yaml | 179 ++++++++---------- api-ref/source/v2/ports.inc | 10 +- api-ref/source/v2/routers.inc | 8 +- api-ref/source/v2/trunk.inc | 12 +- api-ref/source/v2/vpnaas.inc | 17 +- 12 files changed, 140 insertions(+), 160 deletions(-) diff --git a/api-ref/source/v2/fwaas.inc b/api-ref/source/v2/fwaas.inc index 9613117..9e75e86 100644 --- a/api-ref/source/v2/fwaas.inc +++ b/api-ref/source/v2/fwaas.inc @@ -625,7 +625,7 @@ Response Parameters - firewall_policy_id: firewall_policy_id-body - id: firewall_id-body - name: name - - status: status + - status: firewall-status Response Example ---------------- @@ -680,7 +680,7 @@ Response Parameters - firewall_policy_id: firewall_policy_id-body - id: firewall_id-body - name: name - - status: status + - status: firewall-status - router_ids: router_ids-response Response Example @@ -721,11 +721,10 @@ Response Parameters - project_id: project_id-body - admin_state_up: admin_state_up - description: description - - status: status + - status: firewall-status - firewall_policy_id: firewall_policy_id - id: firewall_rule_id-body - name: name - - status: status - router_ids: router_ids-response Response Example @@ -777,11 +776,10 @@ Response Parameters - project_id: project_id-body - admin_state_up: admin_state_up - description: description - - status: status + - status: firewall-status - firewall_policy_id: firewall_policy_id-body - id: firewall_id-body - name: name - - status: status - router_ids: router_ids-response Response Example diff --git a/api-ref/source/v2/lbaas-v1.inc b/api-ref/source/v2/lbaas-v1.inc index 5718794..3b1756f 100644 --- a/api-ref/source/v2/lbaas-v1.inc +++ b/api-ref/source/v2/lbaas-v1.inc @@ -64,7 +64,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - lb_algorithm: lb_algorithm - - status: status + - status: pool-status - protocol: protocol - description: description - health_monitors: health_monitors @@ -123,7 +123,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - lb_algorithm: lb_algorithm - - status: status + - status: pool-status - protocol: protocol - description: description - health_monitors: health_monitors @@ -163,7 +163,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - lb_algorithm: lb_algorithm - - status: status + - status: pool-status - protocol: protocol - description: description - health_monitors: health_monitors @@ -220,7 +220,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - lb_algorithm: lb_algorithm - - status: status + - status: pool-status - protocol: protocol - description: description - health_monitors: health_monitors @@ -281,7 +281,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: vip-status - status_description: status_description - protocol: protocol - description: description @@ -344,7 +344,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: vip-status - status_description: status_description - protocol: protocol - description: description @@ -384,7 +384,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: vip-status - status_description: status_description - protocol: protocol - description: description @@ -443,7 +443,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: vip-status - status_description: status_description - protocol: protocol - description: description @@ -503,7 +503,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: member-status - status_description: status_description - weight: weight - admin_state_up: admin_state_up @@ -555,7 +555,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: member-status - status_description: status_description - weight: weight - admin_state_up: admin_state_up @@ -589,7 +589,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: member-status - status_description: status_description - weight: weight - admin_state_up: admin_state_up @@ -639,7 +639,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: member-status - status_description: status_description - weight: weight - admin_state_up: admin_state_up diff --git a/api-ref/source/v2/lbaas-v2.inc b/api-ref/source/v2/lbaas-v2.inc index 79ad9b4..7b01e94 100644 --- a/api-ref/source/v2/lbaas-v2.inc +++ b/api-ref/source/v2/lbaas-v2.inc @@ -384,7 +384,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - statuses: statuses-response + - statuses: loadbalancer-statuses - loadbalancer: loadbalancer - listeners: listeners - pools: pools @@ -781,7 +781,7 @@ Response Parameters - project_id: project_id - protocol: protocol-response - provider: loadbalancer-provider - - status: status + - status: pool-status - status_description: status_description - subnet_id: pool-subnet_id - tenant_id: project_id @@ -891,7 +891,7 @@ Response Parameters - project_id: project_id - protocol: protocol-response - provider: loadbalancer-provider - - status: status + - status: pool-status - status_description: status_description - subnet_id: pool-subnet_id - tenant_id: project_id @@ -944,7 +944,7 @@ Response Parameters - members: members - id: pool-id-response - name: name - - status: status + - status: pool-status - status_description: status_description - project_id: project_id - protocol: protocol-response @@ -1015,7 +1015,7 @@ Response Parameters - lb_algorithm: lb_algorithm - members: members - name: name - - status: status + - status: pool-status - status_description: status_description - project_id: project_id - protocol: protocol-response diff --git a/api-ref/source/v2/network-provider.inc b/api-ref/source/v2/network-provider.inc index 4c58176..07683d2 100644 --- a/api-ref/source/v2/network-provider.inc +++ b/api-ref/source/v2/network-provider.inc @@ -43,7 +43,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: network-status - router:external: router:external - availability_zone_hints: availability_zone_hints - availability_zones: availability_zones @@ -109,7 +109,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: network-status - router:external: router:external - subnets: subnets - network: network @@ -166,7 +166,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: network-status - router:external: router:external - availability_zone_hints: availability_zone_hints - availability_zones: availability_zones @@ -227,7 +227,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: network-status - router:external: router:external - availability_zone_hints: availability_zone_hints - network: network diff --git a/api-ref/source/v2/networks-multi-provider-ext.inc b/api-ref/source/v2/networks-multi-provider-ext.inc index 526ac79..0e60e16 100644 --- a/api-ref/source/v2/networks-multi-provider-ext.inc +++ b/api-ref/source/v2/networks-multi-provider-ext.inc @@ -56,7 +56,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: network-status - router:external: router:external - subnets: subnets - network: network @@ -100,7 +100,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: network-status - router:external: router:external - subnets: subnets - name: name @@ -161,7 +161,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: network-status - router:external: router:external - subnets: subnets - network: network diff --git a/api-ref/source/v2/networks-vlan-transparency-ext.inc b/api-ref/source/v2/networks-vlan-transparency-ext.inc index 5b60d78..b9d4bec 100644 --- a/api-ref/source/v2/networks-vlan-transparency-ext.inc +++ b/api-ref/source/v2/networks-vlan-transparency-ext.inc @@ -47,7 +47,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: network-status - router:external: router:external - subnets: subnets - network: network @@ -86,7 +86,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: network-status - router:external: router:external - subnets: subnets - name: name @@ -141,7 +141,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: network-status - router:external: router:external - subnets: subnets - network: network diff --git a/api-ref/source/v2/networks.inc b/api-ref/source/v2/networks.inc index 01c7eec..fbcccd9 100644 --- a/api-ref/source/v2/networks.inc +++ b/api-ref/source/v2/networks.inc @@ -44,7 +44,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: network-status - router:external: router:external - availability_zone_hints: availability_zone_hints - availability_zones: availability_zones @@ -102,7 +102,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: network-status - router:external: router:external - availability_zone_hints: availability_zone_hints - availability_zones: availability_zones @@ -169,7 +169,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: network-status - router:external: router:external - availability_zone_hints: availability_zone_hints - availability_zones: availability_zones @@ -217,7 +217,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: network-status - router:external: router:external - availability_zone_hints: availability_zone_hints - availability_zones: availability_zones @@ -271,7 +271,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - - status: status + - status: network-status - router:external: router:external - subnets: subnets - name: name diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml index 2240664..5583cec 100644 --- a/api-ref/source/v2/parameters.yaml +++ b/api-ref/source/v2/parameters.yaml @@ -1437,6 +1437,14 @@ firewall: in: body required: true type: object +firewall-status: + description: | + The status of the firewall service. Values are + ``ACTIVE``, ``INACTIVE``, ``ERROR``, ``DOWN``, + ``PENDING_CREATE``, ``PENDING_UPDATE``, or ``PENDING_DELETE``. + in: body + required: true + type: string firewall_id-body: description: | The ID of the firewall. @@ -1718,7 +1726,8 @@ floatingip-router_id: type: string floatingip-status: description: | - The status of the floating IP. + The status of the floating IP. Values are + ``ACTIVE``, ``DOWN`` and ``ERROR``. in: body required: true type: string @@ -2065,6 +2074,15 @@ ipsec_site_connection: in: body required: true type: object +ipsec_site_connection-status: + description: | + Indicates whether the IPSec connection is + currently operational. Values are ``ACTIVE``, ``DOWN``, ``BUILD``, + ``ERROR``, ``PENDING_CREATE``, ``PENDING_UPDATE``, or + ``PENDING_DELETE``. + in: body + required: true + type: string ipsecpolicies: description: | A list of IPSec policy objects. @@ -2190,6 +2208,13 @@ loadbalancer-provider-request: in: body required: false type: string +loadbalancer-statuses: + description: | + The status tree of a load balancer object contains all + provisioning and operating statuses for its children. + in: body + required: true + type: object loadbalancers: description: | A list of load balancer objects. @@ -2305,6 +2330,13 @@ member-id-response: in: body required: true type: string +member-status: + description: | + The status of the member. Indicates whether the + member is operational. + in: body + required: true + type: string member-weight: description: | The weight of a member determines the portion of @@ -2726,6 +2758,12 @@ network: in: body required: true type: object +network-status: + description: | + The network status. + in: body + required: true + type: string network_3: description: | A ``network`` object. @@ -2934,6 +2972,13 @@ pool-id-response: in: body required: true type: string +pool-status: + description: | + The status of the pool. Indicates whether the + pool is operational. + in: body + required: true + type: string pool-subnet_id: description: | The subnet on which the members of the pool will be located. @@ -2972,6 +3017,13 @@ port: in: body required: true type: object +port-status: + description: | + The port status. Values are ``ACTIVE``, ``DOWN``, + ``BUILD`` and ``ERROR``. + in: body + required: true + type: string port_id_1: description: | The UUID of the port. @@ -3606,6 +3658,12 @@ router-routes-request: in: body required: false type: array +router-status: + description: | + The router status. + in: body + required: true + type: string router-subnet_id: description: | The ID of the subnet which the router interface belongs to. @@ -3679,12 +3737,6 @@ router_ids-response: in: body required: true type: array -router_status: - description: | - The router status. - in: body - required: true - type: string routers: description: | A list of ``router`` objects. @@ -4061,96 +4113,12 @@ source_port_1: in: body required: true type: string -status: - description: | - The network status. - in: body - required: true - type: string -status_1: - description: | - The port status. Value is ``ACTIVE`` or ``DOWN``. - in: body - required: true - type: string -status_10: - description: | - The status of the floating IP address. - in: body - required: true - type: string -status_2: - description: | - The operational status of the IPSec connection. - Value is ``ACTIVE``, ``DOWN``, ``BUILD``, ``ERROR``, - ``PENDING_CREATE``, ``PENDING_UPDATE``, or ``PENDING_DELETE``. - in: body - required: false - type: string -status_3: - description: | - The status of the member. Indicates whether the - member is operational. - in: body - required: true - type: string -status_4: - description: | - The network status. - in: body - required: true - type: string -status_5: - description: | - The status of the pool. Indicates whether the - pool is operational. - in: body - required: true - type: string -status_6: - description: | - The status of the VIP. Indicates whether the VIP - is operational. - in: body - required: true - type: string -status_7: - description: | - Indicates whether IPSec VPN service is currently - operational. Value is ``ACTIVE``, ``DOWN``, ``BUILD``, ``ERROR``, - ``PENDING_CREATE``, ``PENDING_UPDATE``, or ``PENDING_DELETE``. - in: body - required: true - type: string -status_8: - description: | - Indicates whether the IPSec connection is - currently operational. Value is ``ACTIVE``, ``DOWN``, ``BUILD``, - ``ERROR``, ``PENDING_CREATE``, ``PENDING_UPDATE``, or - ``PENDING_DELETE``. - in: body - required: true - type: string -status_9: - description: | - The status of the firewall service. Value is - ``ACTIVE``, ``INACTIVE``, ``ERROR``, ``PENDING_CREATE``, - ``PENDING_UPDATE``, or ``PENDING_DELETE``. - in: body - required: true - type: string status_description: description: | Human-readable description of the status. in: body required: true type: string -statuses-response: - description: | - List of load balancer statuses. - in: body - required: true - type: string sub_ports: description: | A list of ports associated with the trunk. @@ -4782,6 +4750,13 @@ transform_protocol_1: in: body required: true type: string +trunk-status: + description: | + The status for the trunk. Possible values are ``ACTIVE``, + ``DOWN``, ``BUILD``, ``DEGRADED``, and ``ERROR``. + in: body + required: true + type: string trunk_details: description: | The details about the trunk. @@ -4794,13 +4769,6 @@ trunk_port_id: in: body required: true type: string -trunk_status: - description: | - The status for the trunk. Possible values are ``ACTIVE``, - ``DOWN``, ``BUILD``, ``DEGRADED``, and ``ERROR``. - in: body - required: true - type: string type: description: | The type of probe sent by the load balancer to @@ -4963,6 +4931,13 @@ vip: in: body required: true type: object +vip-status: + description: | + The status of the VIP. Indicates whether the VIP + is operational. + in: body + required: true + type: string vip_address: description: | The IP address of the VIP . @@ -5018,6 +4993,14 @@ vpnservice: in: body required: true type: object +vpnservice-status: + description: | + Indicates whether IPSec VPN service is currently + operational. Values are ``ACTIVE``, ``DOWN``, ``BUILD``, ``ERROR``, + ``PENDING_CREATE``, ``PENDING_UPDATE``, or ``PENDING_DELETE``. + in: body + required: true + type: string vpnservice_id: description: | The UUID of the VPN service. diff --git a/api-ref/source/v2/ports.inc b/api-ref/source/v2/ports.inc index 157678e..8e23e19 100644 --- a/api-ref/source/v2/ports.inc +++ b/api-ref/source/v2/ports.inc @@ -34,7 +34,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - opt_value: opt_value - - status: status + - status: port-status - name: name - allowed_address_pairs: allowed_address_pairs - admin_state_up: admin_state_up @@ -125,7 +125,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - opt_value: opt_value - - status: status + - status: port-status - name: name - allowed_address_pairs: allowed_address_pairs - admin_state_up: admin_state_up @@ -200,7 +200,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - opt_value: opt_value - - status: status + - status: port-status - name: name - allowed_address_pairs: allowed_address_pairs - admin_state_up: admin_state_up @@ -274,7 +274,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - opt_value: opt_value - - status: status + - status: port-status - name: name - allowed_address_pairs: allowed_address_pairs - admin_state_up: admin_state_up @@ -341,7 +341,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - opt_value: opt_value - - status: status + - status: port-status - name: name - allowed_address_pairs: allowed_address_pairs - admin_state_up: admin_state_up diff --git a/api-ref/source/v2/routers.inc b/api-ref/source/v2/routers.inc index e021932..213c384 100644 --- a/api-ref/source/v2/routers.inc +++ b/api-ref/source/v2/routers.inc @@ -50,7 +50,7 @@ Response Parameters - name: name - description: description - admin_state_up: admin_state_up - - status: router_status + - status: router-status - external_gateway_info: router-external_gateway_info - network_id: router-network_id - enable_snat: router-enable_snat @@ -127,7 +127,7 @@ Response Parameters - name: name - description: description - admin_state_up: admin_state_up - - status: router_status + - status: router-status - external_gateway_info: router-external_gateway_info - network_id: router-network_id - enable_snat: router-enable_snat @@ -183,7 +183,7 @@ Response Parameters - name: name - description: description - admin_state_up: admin_state_up - - status: router_status + - status: router-status - external_gateway_info: router-external_gateway_info - network_id: router-network_id - enable_snat: router-enable_snat @@ -248,7 +248,7 @@ Response Parameters - name: name - description: description - admin_state_up: admin_state_up - - status: router_status + - status: router-status - external_gateway_info: router-external_gateway_info - network_id: router-network_id - enable_snat: router-enable_snat diff --git a/api-ref/source/v2/trunk.inc b/api-ref/source/v2/trunk.inc index 63bee06..c9868fe 100644 --- a/api-ref/source/v2/trunk.inc +++ b/api-ref/source/v2/trunk.inc @@ -54,7 +54,7 @@ Response Parameters - name: name_resource - port_id: trunk_port_id - revision_number: revision_number - - status: trunk_status + - status: trunk-status - tenant_id: project_id-request - project_id: project_id-request - sub_ports: sub_ports @@ -127,7 +127,7 @@ Response Parameters - name: name_resource - port_id: trunk_port_id - revision_number: revision_number - - status: trunk_status + - status: trunk-status - tenant_id: project_id - project_id: project_id - sub_ports: sub_ports @@ -171,7 +171,7 @@ Response Parameters - name: name_resource - port_id: trunk_port_id - revision_number: revision_number - - status: trunk_status + - status: trunk-status - tenant_id: project_id - project_id: project_id - sub_ports: sub_ports @@ -219,7 +219,7 @@ Response Parameters - name: name_resource - port_id: trunk_port_id - revision_number: revision_number - - status: trunk_status + - status: trunk-status - tenant_id: project_id - project_id: project_id - sub_ports: sub_ports @@ -305,7 +305,7 @@ Response Parameters - name: name_resource - port_id: trunk_port_id - revision_number: revision_number - - status: trunk_status + - status: trunk-status - tenant_id: project_id - project_id: project_id - sub_ports: sub_ports @@ -354,7 +354,7 @@ Response Parameters - name: name_resource - port_id: trunk_port_id - revision_number: revision_number - - status: trunk_status + - status: trunk-status - tenant_id: project_id - project_id: project_id - sub_ports: sub_ports diff --git a/api-ref/source/v2/vpnaas.inc b/api-ref/source/v2/vpnaas.inc index 02342fd..9756e7c 100644 --- a/api-ref/source/v2/vpnaas.inc +++ b/api-ref/source/v2/vpnaas.inc @@ -167,7 +167,6 @@ Request - route_mode: route_mode - ipsecpolicy_id: ipsecpolicy_id - peer_id: peer_id - - status: status - psk: psk - description: description - initiator: initiator @@ -205,7 +204,7 @@ Response Parameters - route_mode: route_mode - ipsecpolicy_id: ipsecpolicy_id - peer_id: peer_id - - status: status + - status: ipsec_site_connection-status - psk: psk - description: description - initiator: initiator @@ -250,7 +249,7 @@ Response Parameters - route_mode: route_mode - ipsecpolicy_id: ipsecpolicy_id - peer_id: peer_id - - status: status + - status: ipsec_site_connection-status - psk: psk - description: description - initiator: initiator @@ -306,7 +305,7 @@ Response Parameters - route_mode: route_mode - ipsecpolicy_id: ipsecpolicy_id - peer_id: peer_id - - status: status + - status: ipsec_site_connection-status - psk: psk - description: description - initiator: initiator @@ -385,7 +384,7 @@ Response Parameters - route_mode: route_mode - ipsecpolicy_id: ipsecpolicy_id - peer_id: peer_id - - status: status + - status: ipsec_site_connection-status - psk: psk - description: description - initiator: initiator @@ -522,7 +521,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - router_id: router_id - - status: status + - status: vpnservice-status - name: name - external_v6_ip: external_v6_ip - admin_state_up: admin_state_up @@ -578,7 +577,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - router_id: router_id - - status: status + - status: vpnservice-status - name: name - external_v6_ip: external_v6_ip - admin_state_up: admin_state_up @@ -618,7 +617,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - router_id: router_id - - status: status + - status: vpnservice-status - name: name - external_v6_ip: external_v6_ip - admin_state_up: admin_state_up @@ -673,7 +672,7 @@ Response Parameters .. rest_parameters:: parameters.yaml - router_id: router_id - - status: status + - status: vpnservice-status - name: name - external_v6_ip: external_v6_ip - admin_state_up: admin_state_up