Merge "api-ref: parameter verification os-fixed-ips"

api-ref/source/os-fixed-ips.inc

@@ -1,7 +1,5 @@
 .. -*- rst -*-
-.. needs:parameter_verification
 .. needs:example_verification
-.. needs:body_verification
 
 ==========================
  Fixed IPs (os-fixed-ips)
@@ -26,12 +24,20 @@ Request
 
 .. rest_parameters:: parameters.yaml
 
-
-  - fixed_ip: fixed_ip
+  - fixed_ip: fixed_ip_path
 
 Response
 --------
 
+.. rest_parameters:: parameters.yaml
+
+  - fixed_ip: fixed_ip_obj
+  - address: ip_address
+  - cidr: cidr
+  - host: fixed_ip_host
+  - hostname: fixed_ip_hostname
+
+
 **Example Show Fixed Ip Details: JSON response**
 
 .. literalinclude:: ../../doc/api_samples/os-fixed-ips/fixedips-get-resp.json
@@ -44,7 +50,8 @@ Reserve Or Release A Fixed Ip
 
 Reserves or releases a fixed IP.
 
-To reserve a fixed IP address, specify ``reserve`` in the request body. To release a fixed IP address, specify ``unreserve`` in the request body.
+To reserve a fixed IP address, specify ``reserve`` in the request body.
+To release a fixed IP address, specify ``unreserve`` in the request body.
 
 Normal response codes: 202
 
@@ -55,8 +62,10 @@ Request
 
 .. rest_parameters:: parameters.yaml
 
+  - fixed_ip: fixed_ip_path
+  - reserve: action_reserve
+  - unreserve: action_unreserve
 
-  - fixed_ip: fixed_ip
 
 **Example Reserve Or Release A Fixed Ip: JSON request**
 
@@ -66,3 +75,4 @@ Request
 Response
 --------
 
+There is no body content for the response of a successful POST query

api-ref/source/parameters.yaml

@@ -96,7 +96,7 @@ domain:
   in: path
   required: true
   type: string
-fixed_ip_1:
+fixed_ip_path:
   description: |
     The fixed IP of interest to you.
   in: path
@@ -643,6 +643,18 @@ accessIPv6_in:
   type: string
   description: |
     IPv6 address that should be used to access this server.
+action_reserve:
+  description: |
+    The attribute to reserve an IP with a value of ``null``.
+  in: body
+  required: false
+  type: string
+action_unreserve:
+  description: |
+    The attribute to release an IP with a value of ``null``.
+  in: body
+  required: false
+  type: string
 addFixedIp:
   description: |
     The action.
@@ -1320,6 +1332,25 @@ fixed_ip:
   in: body
   required: false
   type: string
+fixed_ip_host:
+  description: |
+    The hostname of the host that manages the server that is associated with
+    this fixed IP address.
+  in: body
+  required: true
+  type: string
+fixed_ip_hostname:
+  description: |
+    The hostname of the server that is associated with this fixed IP address.
+  in: body
+  required: true
+  type: string
+fixed_ip_obj:
+  description: |
+    A fixed IP address object.
+  in: body
+  required: true
+  type: object
 fixed_ips:
   description: |
     Fixed IP addresses.  If you request a specific fixed IP address without
@@ -2053,6 +2084,12 @@ ip_address_req:
   in: body
   required: true
   type: string
+ip_host:
+  description: |
+    The name or ID of the host associated to the IP.
+  in: body
+  required: true
+  type: string
 ip_protocol:
   description: |
     The IP protocol. A valid value is ICMP, TCP, or UDP.