From 0b1a33ec9ce903e2261dd5ae7b0db8e2968135dc Mon Sep 17 00:00:00 2001
From: Stephen Finucane <sfinucan@redhat.com>
Date: Wed, 22 Jan 2020 13:50:30 +0000
Subject: [PATCH] nova-net: Update API reference guide

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 <sfinucan@redhat.com>
---
 api-ref/source/os-floating-ip-pools.inc |  2 +-
 api-ref/source/os-floating-ips.inc      |  8 ++++----
 api-ref/source/parameters.yaml          | 10 ++++++++--
 3 files changed, 13 insertions(+), 7 deletions(-)

diff --git a/api-ref/source/os-floating-ip-pools.inc b/api-ref/source/os-floating-ip-pools.inc
index 4054daf41a07..7860560269c0 100644
--- a/api-ref/source/os-floating-ip-pools.inc
+++ b/api-ref/source/os-floating-ip-pools.inc
@@ -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**
 
diff --git a/api-ref/source/os-floating-ips.inc b/api-ref/source/os-floating-ips.inc
index 797b317e943c..a4911dec2179 100644
--- a/api-ref/source/os-floating-ips.inc
+++ b/api-ref/source/os-floating-ips.inc
@@ -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**
 
@@ -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**
 
@@ -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**
 
@@ -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**
 
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 1cb8c4b8d5b4..e0a8eeba40cf 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -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.