From bc6c3434d92dd994c53be6838d7ff3eeb55ef26d Mon Sep 17 00:00:00 2001 From: stewie925 Date: Wed, 22 Jun 2016 18:19:35 -0700 Subject: [PATCH] Complete verification for os-floating-ips-bulk This includes parameter, example, and body verifications for api-ref os-floating-ips-bulk. part of bp:api-ref-in-rst Change-Id: I507958b4361b65da1cc510b0d81fe55466dd41c3 --- api-ref/source/os-floating-ips-bulk.inc | 47 ++++++++++++++++++++--- api-ref/source/parameters.yaml | 51 ++++++++++++++++++++++++- 2 files changed, 90 insertions(+), 8 deletions(-) diff --git a/api-ref/source/os-floating-ips-bulk.inc b/api-ref/source/os-floating-ips-bulk.inc index a95f80cbfafb..f9974bf6831b 100644 --- a/api-ref/source/os-floating-ips-bulk.inc +++ b/api-ref/source/os-floating-ips-bulk.inc @@ -1,7 +1,4 @@ .. -*- rst -*- -.. needs:parameter_verification -.. needs:example_verification -.. needs:body_verification ====================================================== Floating IPs bulk (os-floating-ips-bulk) (DEPRECATED) @@ -25,6 +22,7 @@ List Floating Ips .. rest_method:: GET /os-floating-ips-bulk + Lists all floating IPs. Normal response codes: 200 @@ -34,6 +32,16 @@ Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) Response -------- +.. rest_parameters:: parameters.yaml + + - floating_ip_info : floating_ips_list + - address : floating_ip + - fixed_ip : fixed_ip_address + - instance_uuid : server_id + - interface : virtual_interface + - pool: floating_ip_pool_name + - project_id : project_id_value + **Example List Floating Ips: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-resp.json @@ -48,14 +56,19 @@ Bulk-creates floating IPs. Normal response codes: 200 -Error response codes: badRequest(400), unauthorized(401), forbidden(403), conflict(409) +Error response codes: badRequest(400), unauthorized(401), forbidden(403), +conflict(409) Request ------- .. rest_parameters:: parameters.yaml - - ip_range: ip_range + - floating_ips_bulk_create : floating_ip_bulk_object + - ip_range : ip_range + - interface : virtual_interface_id_optional + - pool: floating_ip_pool_name_optional + **Example Create Floating Ips: JSON request** @@ -65,6 +78,13 @@ Request Response -------- +.. rest_parameters:: parameters.yaml + + - floating_ips_bulk_create : floating_ip_bulk_object + - interface : virtual_interface + - ip_range : ip_range + - pool: floating_ip_pool_name + **Example Create Floating Ips: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-resp.json @@ -86,7 +106,7 @@ Request .. rest_parameters:: parameters.yaml - - ip_range: ip_range + - ip_range: ip_range_delete **Example Bulk-Delete Floating Ips: JSON request** @@ -96,6 +116,10 @@ Request Response -------- +.. rest_parameters:: parameters.yaml + + - floating_ips_bulk_delete : ip_range_delete + **Example Bulk-Delete Floating Ips: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-resp.json @@ -122,6 +146,17 @@ Request Response -------- +.. rest_parameters:: parameters.yaml + + - floating_ip_info : floating_ips_list + - address : floating_ip + - fixed_ip : fixed_ip_address + - instance_uuid : server_id + - interface : virtual_interface + - pool: floating_ip_pool_name + - project_id : project_id_value + + **Example List Floating Ips By Host: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-by-host-resp.json diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 67b26f57ac41..18374c030499 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -1336,6 +1336,12 @@ fixed_ip: in: body required: false type: string +fixed_ip_address: + description: | + Fixed IP associated with floating IP network. + in: body + required: true + type: string fixed_ip_host: description: | The hostname of the host that manages the server that is associated with @@ -1516,12 +1522,30 @@ flavors: in: body required: true type: array +floating_ip: + description: | + The floating ip address. + in: body + required: true + type: string +floating_ip_bulk_object: + description: | + The floating ip bulk address object. + in: body + required: true + type: object floating_ip_pool_name: description: | The name of the floating ip pool. in: body required: true type: string +floating_ip_pool_name_optional: + description: | + The name of the floating ip pool + in: body + required: false + type: string floating_ip_pools: description: | The ``floating_ip_pools`` object. @@ -1534,6 +1558,12 @@ floating_ips: in: body required: true type: integer +floating_ips_list: + description: | + An array of floating ip objects. + in: body + required: true + type: array floating_ips_quota_details: description: | The object of detailed floating ips quota, including in_use, limit and @@ -2106,8 +2136,7 @@ ip_range: in: body required: true type: string -# TODO(mriedem): this needs to be renamed and used in os-floating-ips-bulk.inc -ip_range_3: +ip_range_delete: description: | The range of IP addresses from which to bulk-delete floating IPs. in: body @@ -2867,6 +2896,12 @@ project_id_server_group: in: body required: false type: string +project_id_value: + description: | + The project id under which the bulk ip addresses are created + in: body + required: true + type: string quota_set: description: | A ``quota_set`` object. @@ -3532,12 +3567,24 @@ versions: required: true description: > A list of version objects that describe the API versions available. +virtual_interface: + description: | + Virtual interface for the floating ip address. + in: body + required: true + type: string virtual_interface_id: description: | The UUID of the virtual interface. in: body required: true type: string +virtual_interface_id_optional: + description: | + Virtual interface for the floating ip address + in: body + required: false + type: string virtual_interfaces: description: | A ``virtual_interfaces`` object.