openstack/nova
Code Issues Proposed changes

api-ref: fix addFloatingIp action docs

Browse Source 
As described in the bug, the addFloatingIp parameter
in the request body is an object, not a string. And we
didn't actually have an example request, so one is added
here to further clarify the API.

Change-Id: I366ba880cf13558291da286e6524327cafcccf1f
Closes-Bug: #1636185
This commit is contained in:
Matt Riedemann 2016-11-04 19:06:32 -04:00
parent 1e4178b6a0
commit 0f26e6872e
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
api-ref/source/parameters.yaml
View File

@ -806,10 +806,11 @@ addFixedIp:
type: string type: string
addFloatingIp: addFloatingIp:
description: | description: |
The action. The action. Contains required floating IP ``address`` and optional
``fixed_address``.
in: body in: body
required: true required: true
type: string type: object
address: address:
description: | description: |
The floating IP address. The floating IP address.

3
api-ref/source/servers-actions.inc
View File

@ -67,10 +67,9 @@ Request
- address: address - address: address
- fixed_address: fixed_address - fixed_address: fixed_address
.. TODO(gmann) Need to create the sample file for this action.
**Example Add (Associate) Floating Ip (addFloatingIp Action): JSON request** **Example Add (Associate) Floating Ip (addFloatingIp Action): JSON request**
.. literalinclude:: ../../doc/api_samples/os-floating-ips/floating-ips-create-resp.json .. literalinclude:: ../../doc/api_samples/servers/server-action-addfloatingip.json
:language: javascript :language: javascript
Response Response