From 0f26e6872efee0ea0e5f565ffbd9909358f05f93 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Fri, 4 Nov 2016 19:06:32 -0400 Subject: [PATCH] api-ref: fix addFloatingIp action docs 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 --- api-ref/source/parameters.yaml | 5 +++-- api-ref/source/servers-actions.inc | 7 +++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 437f475246f..144596c2038 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -806,10 +806,11 @@ addFixedIp: type: string addFloatingIp: description: | - The action. + The action. Contains required floating IP ``address`` and optional + ``fixed_address``. in: body required: true - type: string + type: object address: description: | The floating IP address. diff --git a/api-ref/source/servers-actions.inc b/api-ref/source/servers-actions.inc index 588f4c972f9..e5db3bab02f 100644 --- a/api-ref/source/servers-actions.inc +++ b/api-ref/source/servers-actions.inc @@ -67,11 +67,10 @@ Request - address: 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 - :language: javascript +.. literalinclude:: ../../doc/api_samples/servers/server-action-addfloatingip.json + :language: javascript Response --------