From 4f4804259f8bbf26c9b700dac43c7fc0cb47fa57 Mon Sep 17 00:00:00 2001 From: Adam Harwell Date: Tue, 31 Mar 2020 09:19:53 -0700 Subject: [PATCH] Add availability-zone to loadbalancer object docs Change-Id: I8626c0338d4ad7d11bf5d56b022136cb4513d37e --- api-ref/source/parameters.yaml | 24 ++++++++++++++----- api-ref/source/v2/availabilityzone.inc | 10 ++++---- .../v2/examples/loadbalancer-create-curl | 2 +- .../examples/loadbalancer-create-request.json | 1 + .../loadbalancer-create-response.json | 1 + .../loadbalancer-full-create-request.json | 1 + .../loadbalancer-full-create-response.json | 1 + .../examples/loadbalancer-show-response.json | 1 + .../examples/loadbalancers-list-response.json | 1 + api-ref/source/v2/loadbalancer.inc | 4 ++++ 10 files changed, 34 insertions(+), 12 deletions(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index f4ba4f71b0..87559ea072 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -232,12 +232,6 @@ api_version_status: in: body required: true type: string -availability-zone: - description: | - An availability zone object. - in: body - required: true - type: object availability-zone-capabilities: description: | The provider availability zone capabilities dictonary object. @@ -268,6 +262,18 @@ availability-zone-data-optional: in: body required: false type: string +availability-zone-name: + description: | + An availability zone name. + in: body + required: true + type: object +availability-zone-name-optional: + description: | + An availability zone name. + in: body + required: false + type: object availability-zone-profile: description: | An ``availability zone profile`` object. @@ -292,6 +298,12 @@ availability-zones: in: body required: true type: array +availability_zone: + description: | + An availability zone object. + in: body + required: true + type: object backup: description: | Is the member a backup? Backup members only receive traffic when all diff --git a/api-ref/source/v2/availabilityzone.inc b/api-ref/source/v2/availabilityzone.inc index 1f80746b70..9bdf2d1894 100644 --- a/api-ref/source/v2/availabilityzone.inc +++ b/api-ref/source/v2/availabilityzone.inc @@ -91,7 +91,7 @@ Request - description: description-optional - enabled: enabled-optional - - availability_zone: availability-zone + - availability_zone: availability_zone - availability_zone_profile_id: availability-zone-profile-id - name: name @@ -115,7 +115,7 @@ Response Parameters - description: description - enabled: enabled - availability_zone_profile_id: availability-zone-profile-id - - availability_zone: availability-zone + - availability_zone: availability_zone - name: name Response Example @@ -172,7 +172,7 @@ Response Parameters - description: description - enabled: enabled - availability_zone_profile_id: availability-zone-profile-id - - availability_zone: availability-zone + - availability_zone: availability_zone - name: name Response Example @@ -212,7 +212,7 @@ Request - description: description-optional - enabled: enabled-optional - - availability_zone: availability-zone + - availability_zone: availability_zone - availability_zone_name: path-availability-zone-name Request Example @@ -235,7 +235,7 @@ Response Parameters - description: description - enabled: enabled - availability_zone_profile_id: availability-zone-profile-id - - availability_zone: availability-zone + - availability_zone: availability_zone - name: name Response Example diff --git a/api-ref/source/v2/examples/loadbalancer-create-curl b/api-ref/source/v2/examples/loadbalancer-create-curl index f266d3f280..0f1597065c 100644 --- a/api-ref/source/v2/examples/loadbalancer-create-curl +++ b/api-ref/source/v2/examples/loadbalancer-create-curl @@ -1 +1 @@ -curl -X POST -H "Content-Type: application/json" -H "X-Auth-Token: " -d '{"loadbalancer": {"description": "My favorite load balancer", "admin_state_up": true, "project_id": "e3cd678b11784734bc366148aa37580e", "flavor_id": "a7ae5d5a-d855-4f9a-b187-af66b53f4d04", "vip_subnet_id": "d4af86e1-0051-488c-b7a0-527f97490c9a", "vip_address": "203.0.113.50", "provider": "octavia", "name": "best_load_balancer", "vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3", "tags": ["test_tag"]}}' http://198.51.100.10:9876/v2/lbaas/loadbalancers +curl -X POST -H "Content-Type: application/json" -H "X-Auth-Token: " -d '{"loadbalancer": {"description": "My favorite load balancer", "admin_state_up": true, "project_id": "e3cd678b11784734bc366148aa37580e", "flavor_id": "a7ae5d5a-d855-4f9a-b187-af66b53f4d04", "vip_subnet_id": "d4af86e1-0051-488c-b7a0-527f97490c9a", "vip_address": "203.0.113.50", "provider": "octavia", "name": "best_load_balancer", "vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3", "availability_zone": "my_az", "tags": ["test_tag"]}}' http://198.51.100.10:9876/v2/lbaas/loadbalancers diff --git a/api-ref/source/v2/examples/loadbalancer-create-request.json b/api-ref/source/v2/examples/loadbalancer-create-request.json index 3e61649423..e78494f704 100644 --- a/api-ref/source/v2/examples/loadbalancer-create-request.json +++ b/api-ref/source/v2/examples/loadbalancer-create-request.json @@ -8,6 +8,7 @@ "provider": "octavia", "name": "best_load_balancer", "vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3", + "availability_zone": "my_az", "tags": ["test_tag"] } } diff --git a/api-ref/source/v2/examples/loadbalancer-create-response.json b/api-ref/source/v2/examples/loadbalancer-create-response.json index ac436d897f..de8824083b 100644 --- a/api-ref/source/v2/examples/loadbalancer-create-response.json +++ b/api-ref/source/v2/examples/loadbalancer-create-response.json @@ -16,6 +16,7 @@ "operating_status": "OFFLINE", "name": "best_load_balancer", "vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3", + "availability_zone": "my_az", "tags": ["test_tag"] } } diff --git a/api-ref/source/v2/examples/loadbalancer-full-create-request.json b/api-ref/source/v2/examples/loadbalancer-full-create-request.json index 8c2b398b96..3ff6961078 100644 --- a/api-ref/source/v2/examples/loadbalancer-full-create-request.json +++ b/api-ref/source/v2/examples/loadbalancer-full-create-request.json @@ -85,6 +85,7 @@ "provider": "octavia", "name": "best_load_balancer", "vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3", + "availability_zone": "my_az", "tags": ["test_tag"] } } diff --git a/api-ref/source/v2/examples/loadbalancer-full-create-response.json b/api-ref/source/v2/examples/loadbalancer-full-create-response.json index 64e630da0f..399ce4bdc8 100644 --- a/api-ref/source/v2/examples/loadbalancer-full-create-response.json +++ b/api-ref/source/v2/examples/loadbalancer-full-create-response.json @@ -175,6 +175,7 @@ "operating_status": "ONLINE", "name": "best_load_balancer", "vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3", + "availability_zone": "my_az", "tags": ["test_tag"] } } diff --git a/api-ref/source/v2/examples/loadbalancer-show-response.json b/api-ref/source/v2/examples/loadbalancer-show-response.json index c963a41047..091268e86e 100644 --- a/api-ref/source/v2/examples/loadbalancer-show-response.json +++ b/api-ref/source/v2/examples/loadbalancer-show-response.json @@ -16,6 +16,7 @@ "operating_status": "ONLINE", "name": "best_load_balancer", "vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3", + "availability_zone": "my_az", "tags": [] } } diff --git a/api-ref/source/v2/examples/loadbalancers-list-response.json b/api-ref/source/v2/examples/loadbalancers-list-response.json index f1d6e7fa42..d3fa5519c9 100644 --- a/api-ref/source/v2/examples/loadbalancers-list-response.json +++ b/api-ref/source/v2/examples/loadbalancers-list-response.json @@ -27,6 +27,7 @@ "operating_status": "ONLINE", "name": "best_load_balancer", "vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3", + "availability_zone": "my_az", "tags": [] } ] diff --git a/api-ref/source/v2/loadbalancer.inc b/api-ref/source/v2/loadbalancer.inc index 0795652480..29bca87582 100644 --- a/api-ref/source/v2/loadbalancer.inc +++ b/api-ref/source/v2/loadbalancer.inc @@ -46,6 +46,7 @@ Response Parameters .. rest_parameters:: ../parameters.yaml - admin_state_up: admin_state_up + - availability_zone: availability-zone-name - created_at: created_at - description: description - flavor_id: flavor-id @@ -162,6 +163,7 @@ Request .. rest_parameters:: ../parameters.yaml - admin_state_up: admin_state_up-default-optional + - availability_zone: availability-zone-name-optional - description: description-optional - flavor_id: flavor-id-optional - listeners: listeners-optional @@ -194,6 +196,7 @@ Response Parameters .. rest_parameters:: ../parameters.yaml - admin_state_up: admin_state_up + - availability_zone: availability-zone-name - created_at: created_at - description: description - flavor_id: flavor-id @@ -287,6 +290,7 @@ Response Parameters .. rest_parameters:: ../parameters.yaml - admin_state_up: admin_state_up + - availability_zone: availability-zone-name - created_at: created_at - description: description - flavor_id: flavor-id