Merge "Correcting Floating IPs"

2016-12-22 01:01:57 +00:00
parent 1152f9d4c3 189b98e0ab
commit 5cfa0ed982
2 changed files with 93 additions and 59 deletions
--- a/api-ref/source/v2/floatingips.inc
+++ b/api-ref/source/v2/floatingips.inc
@@ -42,16 +42,16 @@ Response Parameters

 .. rest_parameters:: parameters.yaml

-   - router_id: router_id
-   - status: status
+   - floatingips: floatingips
+   - id: floatingip-id
+   - router_id: floatingip-router_id
+   - status: floatingip-status
   - tenant_id: project_id
   - project_id: project_id
   - floating_network_id: floating_network_id
-   - fixed_ip_address: fixed_ip_address
+   - fixed_ip_address: floatingip-fixed_ip_address
   - floating_ip_address: floating_ip_address
-   - port_id: port_id
-   - id: id
-   - floatingips: floatingips
+   - port_id: floatingip-port_id

 Response Example
 ----------------
@@ -129,9 +129,9 @@ Request
   - tenant_id: project_id
   - project_id: project_id
   - floating_network_id: floating_network_id
-   - fixed_ip_address: fixed_ip_address
-   - floating_ip_address: floating_ip_address
-   - port_id: port_id
+   - fixed_ip_address: floatingip-fixed_ip_address-request
+   - floating_ip_address: floating_ip_address-request
+   - port_id: floatingip-port_id-post-request

 Request Example
 ---------------
@@ -144,16 +144,16 @@ Response Parameters

 .. rest_parameters:: parameters.yaml

-   - router_id: router_id
-   - status: status
   - floatingip: floatingip
+   - router_id: floatingip-router_id
+   - status: floatingip-status
   - tenant_id: project_id
   - project_id: project_id
   - floating_network_id: floating_network_id
-   - fixed_ip_address: fixed_ip_address
+   - fixed_ip_address: floatingip-fixed_ip_address
   - floating_ip_address: floating_ip_address
-   - port_id: port_id
-   - id: id
+   - port_id: floatingip-port_id
+   - id: floatingip-id

 Show floating IP details
 ========================
@@ -187,23 +187,23 @@ Request

 .. rest_parameters:: parameters.yaml

-   - floatingip_id: floatingip_id
+   - floatingip_id: floatingip-id-path

 Response Parameters
 -------------------

 .. rest_parameters:: parameters.yaml

-   - router_id: router_id
-   - status: status
+   - router_id: floatingip-router_id
+   - status: floatingip-status
   - floatingip: floatingip
   - tenant_id: project_id
   - project_id: project_id
   - floating_network_id: floating_network_id
-   - fixed_ip_address: fixed_ip_address
+   - fixed_ip_address: floatingip-fixed_ip_address
   - floating_ip_address: floating_ip_address
-   - port_id: port_id
-   - id: id
+   - port_id: floatingip-port_id
+   - id: floatingip-id

 Response Example
 ----------------
@@ -241,9 +241,10 @@ Request

 .. rest_parameters:: parameters.yaml

-   - port_id: port_id
+   - floatingip_id: floatingip-id-path
   - floatingip: floatingip
-   - floatingip_id: floatingip_id
+   - port_id: floatingip-port_id-put-request
+   - fixed_ip_address: floatingip-fixed_ip_address-request

 Request Example
 ---------------
@@ -256,16 +257,16 @@ Response Parameters

 .. rest_parameters:: parameters.yaml

-   - router_id: router_id
-   - status: status
   - floatingip: floatingip
+   - router_id: floatingip-router_id
+   - status: floatingip-status
   - tenant_id: project_id
   - project_id: project_id
   - floating_network_id: floating_network_id
-   - fixed_ip_address: fixed_ip_address
+   - fixed_ip_address: floatingip-fixed_ip_address
   - floating_ip_address: floating_ip_address
-   - port_id: port_id
-   - id: id
+   - port_id: floatingip-port_id
+   - id: floatingip-id

 Response Example
 ----------------
@@ -293,4 +294,4 @@ Request

 .. rest_parameters:: parameters.yaml

-   - floatingip_id: floatingip_id
+   - floatingip_id: floatingip-id-path
--- a/api-ref/source/v2/parameters.yaml
+++ b/api-ref/source/v2/parameters.yaml
@@ -43,11 +43,11 @@ flavor_id:
  in: path
  required: true
  type: string
-floatingip_id:
+floatingip-id-path:
  description: |
-    The UUID of the floating IP address.
+    The ID of the floating IP address.
  in: path
-  required: false
+  required: true
  type: string
 health_monitor_id:
  description: |
@@ -1525,24 +1525,6 @@ firewalls_1:
  in: body
  required: true
  type: array
-fixed_ip_address:
-  description: |
-    The fixed IP address that is associated with the
-    floating IP. To associate the floating IP with a fixed IP at
-    creation time, you must specify the identifier of the internal
-    port. If an internal port has multiple associated IP addresses,
-    the service chooses the first IP address unless you explicitly
-    define a fixed IP address in the ``fixed_ip_address`` parameter.
-  in: body
-  required: false
-  type: string
-fixed_ip_address_1:
-  description: |
-    The fixed IP address that is associated with the
-    floating IP address.
-  in: body
-  required: true
-  type: string
 fixed_ips:
  description: |
    If you specify only a subnet UUID, OpenStack
@@ -1659,17 +1641,17 @@ floating_ip_address:
  description: |
    The floating IP address.
  in: body
-  required: false
+  required: true
  type: string
-floating_ip_address_1:
+floating_ip_address-request:
  description: |
    The floating IP address.
  in: body
-  required: true
+  required: false
  type: string
 floating_network_id:
  description: |
-    The UUID of the network associated with the
+    The ID of the network associated with the
    floating IP.
  in: body
  required: true
@@ -1683,6 +1665,63 @@ floatingip:
  in: body
  required: true
  type: object
+floatingip-fixed_ip_address:
+  description: |
+    The fixed IP address that is associated with the
+    floating IP address.
+  in: body
+  required: true
+  type: string
+floatingip-fixed_ip_address-request:
+  description: |
+    The fixed IP address that is associated with the floating IP.
+    If an internal port has multiple associated IP addresses,
+    the service chooses the first IP address unless you explicitly
+    define a fixed IP address in the ``fixed_ip_address`` parameter.
+  in: body
+  required: false
+  type: string
+floatingip-id:
+  description: |
+    The ID of the floating IP address.
+  in: body
+  required: true
+  type: string
+floatingip-port_id:
+  description: |
+    The ID of a port associated with the floating IP.
+  in: body
+  required: true
+  type: string
+floatingip-port_id-post-request:
+  description: |
+    The ID of a port associated with the floating IP.
+    To associate the floating IP with a fixed IP at creation time,
+    you must specify the identifier of the internal port.
+  in: body
+  required: false
+  type: string
+floatingip-port_id-put-request:
+  description: |
+    The ID of a port associated with the floating IP.
+    To associate the floating IP with a fixed IP,
+    you must specify the ID of the internal port.
+    To disassociate the floating IP, ``null`` should be specified.
+  in: body
+  required: false
+  type: string
+floatingip-router_id:
+  description: |
+    The ID of the router for the floating IP.
+  in: body
+  required: true
+  type: string
+floatingip-status:
+  description: |
+    The status of the floating IP.
+  in: body
+  required: true
+  type: string
 floatingips:
  description: |
    A list of ``floatingip`` objects.
@@ -1891,12 +1930,6 @@ id_7:
  in: body
  required: true
  type: string
-id_8:
-  description: |
-    The UUID of the floating IP address.
-  in: body
-  required: true
-  type: string
 id_9:
  description: |
    The UUID for the IKE policy.