Skip to content

Commit

Permalink
nova-net: Update API reference guide
Browse files Browse the repository at this point in the history
As highlighted in I77b1cfeab3c00c6c3d7743ba51e12414806b71d2, filtering
either floating IPs or floating IP pools by floating IP name will
actually fallback to filtering by ID. Update the API ref to reflect
this.

Change-Id: I00443ae111cbd1e1ec4d2c2ae1828ddaa095fd1a
Signed-off-by: Stephen Finucane <[email protected]>
  • Loading branch information
stephenfin committed Jan 22, 2020
1 parent 8e5adb2 commit 0b1a33e
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
2 changes: 1 addition & 1 deletion api-ref/source/os-floating-ip-pools.inc
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Response
.. rest_parameters:: parameters.yaml

- floating_ip_pools: floating_ip_pools
- name: floating_ip_pool_name
- name: floating_ip_pool_name_or_id

**Example List Floating Ip Pools: JSON response**

Expand Down
8 changes: 4 additions & 4 deletions api-ref/source/os-floating-ips.inc
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Response
- id: floating_ip_id_value
- instance_id: server_id
- ip: floating_ip
- pool: floating_ip_pool_name
- pool: floating_ip_pool_name_or_id

**Example List Floating Ip Addresses**

Expand Down Expand Up @@ -94,7 +94,7 @@ Request

.. rest_parameters:: parameters.yaml

- pool: floating_ip_pool_name
- pool: floating_ip_pool_name_or_id

**Example Create (Allocate) Floating Ip Address**

Expand All @@ -111,7 +111,7 @@ Response
- id: floating_ip_id_value
- instance_id: server_id
- ip: floating_ip
- pool: floating_ip_pool_name
- pool: floating_ip_pool_name_or_id

**Example Create (Allocate) Floating Ip Address: JSON response**

Expand Down Expand Up @@ -151,7 +151,7 @@ Response
- id: floating_ip_id_value
- instance_id: server_id
- ip: floating_ip
- pool: floating_ip_pool_name
- pool: floating_ip_pool_name_or_id

**Example Show Floating Ip Address Details: JSON response**

Expand Down
10 changes: 8 additions & 2 deletions api-ref/source/parameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3213,16 +3213,22 @@ floating_ip_obj:
type: object
floating_ip_pool_name:
description: |
The name of the floating ip pool.
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
The name of the floating IP pool
in: body
required: false
type: string
floating_ip_pool_name_or_id:
description: |
The name or ID of the floating IP pool.
in: body
required: true
type: string
floating_ip_pools:
description: |
The ``floating_ip_pools`` object.
Expand Down

0 comments on commit 0b1a33e

Please sign in to comment.