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
This commit is contained in:
@@ -1,7 +1,4 @@
|
|||||||
.. -*- rst -*-
|
.. -*- rst -*-
|
||||||
.. needs:parameter_verification
|
|
||||||
.. needs:example_verification
|
|
||||||
.. needs:body_verification
|
|
||||||
|
|
||||||
======================================================
|
======================================================
|
||||||
Floating IPs bulk (os-floating-ips-bulk) (DEPRECATED)
|
Floating IPs bulk (os-floating-ips-bulk) (DEPRECATED)
|
||||||
@@ -25,6 +22,7 @@ List Floating Ips
|
|||||||
|
|
||||||
.. rest_method:: GET /os-floating-ips-bulk
|
.. rest_method:: GET /os-floating-ips-bulk
|
||||||
|
|
||||||
|
|
||||||
Lists all floating IPs.
|
Lists all floating IPs.
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
@@ -34,6 +32,16 @@ Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
|
|||||||
Response
|
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**
|
**Example List Floating Ips: JSON response**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-resp.json
|
.. 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
|
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
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. 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**
|
**Example Create Floating Ips: JSON request**
|
||||||
|
|
||||||
@@ -65,6 +78,13 @@ Request
|
|||||||
Response
|
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**
|
**Example Create Floating Ips: JSON response**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-resp.json
|
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-resp.json
|
||||||
@@ -86,7 +106,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- ip_range: ip_range
|
- ip_range: ip_range_delete
|
||||||
|
|
||||||
**Example Bulk-Delete Floating Ips: JSON request**
|
**Example Bulk-Delete Floating Ips: JSON request**
|
||||||
|
|
||||||
@@ -96,6 +116,10 @@ Request
|
|||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- floating_ips_bulk_delete : ip_range_delete
|
||||||
|
|
||||||
**Example Bulk-Delete Floating Ips: JSON response**
|
**Example Bulk-Delete Floating Ips: JSON response**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-resp.json
|
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-resp.json
|
||||||
@@ -122,6 +146,17 @@ Request
|
|||||||
Response
|
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**
|
**Example List Floating Ips By Host: JSON response**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-by-host-resp.json
|
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-by-host-resp.json
|
||||||
|
@@ -1336,6 +1336,12 @@ fixed_ip:
|
|||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
fixed_ip_address:
|
||||||
|
description: |
|
||||||
|
Fixed IP associated with floating IP network.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
fixed_ip_host:
|
fixed_ip_host:
|
||||||
description: |
|
description: |
|
||||||
The hostname of the host that manages the server that is associated with
|
The hostname of the host that manages the server that is associated with
|
||||||
@@ -1516,12 +1522,30 @@ flavors:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: array
|
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:
|
floating_ip_pool_name:
|
||||||
description: |
|
description: |
|
||||||
The name of the floating ip pool.
|
The name of the floating ip pool.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
floating_ip_pool_name_optional:
|
||||||
|
description: |
|
||||||
|
The name of the floating ip pool
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
floating_ip_pools:
|
floating_ip_pools:
|
||||||
description: |
|
description: |
|
||||||
The ``floating_ip_pools`` object.
|
The ``floating_ip_pools`` object.
|
||||||
@@ -1534,6 +1558,12 @@ floating_ips:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: integer
|
type: integer
|
||||||
|
floating_ips_list:
|
||||||
|
description: |
|
||||||
|
An array of floating ip objects.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: array
|
||||||
floating_ips_quota_details:
|
floating_ips_quota_details:
|
||||||
description: |
|
description: |
|
||||||
The object of detailed floating ips quota, including in_use, limit and
|
The object of detailed floating ips quota, including in_use, limit and
|
||||||
@@ -2106,8 +2136,7 @@ ip_range:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
# TODO(mriedem): this needs to be renamed and used in os-floating-ips-bulk.inc
|
ip_range_delete:
|
||||||
ip_range_3:
|
|
||||||
description: |
|
description: |
|
||||||
The range of IP addresses from which to bulk-delete floating IPs.
|
The range of IP addresses from which to bulk-delete floating IPs.
|
||||||
in: body
|
in: body
|
||||||
@@ -2867,6 +2896,12 @@ project_id_server_group:
|
|||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: string
|
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:
|
quota_set:
|
||||||
description: |
|
description: |
|
||||||
A ``quota_set`` object.
|
A ``quota_set`` object.
|
||||||
@@ -3532,12 +3567,24 @@ versions:
|
|||||||
required: true
|
required: true
|
||||||
description: >
|
description: >
|
||||||
A list of version objects that describe the API versions available.
|
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:
|
virtual_interface_id:
|
||||||
description: |
|
description: |
|
||||||
The UUID of the virtual interface.
|
The UUID of the virtual interface.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
virtual_interface_id_optional:
|
||||||
|
description: |
|
||||||
|
Virtual interface for the floating ip address
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
virtual_interfaces:
|
virtual_interfaces:
|
||||||
description: |
|
description: |
|
||||||
A ``virtual_interfaces`` object.
|
A ``virtual_interfaces`` object.
|
||||||
|
Reference in New Issue
Block a user