Associate Floating IP with server - Improve description

Bug #1636185 reported by Vinicius G Ferreira
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Medium
Matt Riedemann

Bug Description

According to the docs on this link

http://developer.openstack.org/api-ref/compute/?expanded=add-associate-floating-ip-addfloatingip-action-detail#add-associate-floating-ip-addfloatingip-action

the "addFloatingIp" parameter in the request is a string. However, after some attempts we figured out the documentation is not correct. Turns out this parameter is an object, not a String as described. A working example to the request would look something like this:

body = {
    'addFloatingIp': {
        'address': '172.24.4.5',
        'fixed_address': '10.0.0.10'
    }
}

Please fix this parameter on the docs, and also add a working example.
Thanks!

Tags: api-ref
Revision history for this message
Anne Gentle (annegentle) wrote :

Source files for this document are in the openstack/nova/api-ref repo location.

no longer affects: openstack-api-site
Matt Riedemann (mriedem)
tags: added: api-ref
Changed in nova:
status: New → Confirmed
Matt Riedemann (mriedem)
Changed in nova:
assignee: nobody → Matt Riedemann (mriedem)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

Fix proposed to branch: master
Review: https://review.openstack.org/393951

Changed in nova:
status: Confirmed → In Progress
Matt Riedemann (mriedem)
Changed in nova:
importance: Undecided → Medium
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to nova (master)

Related fix proposed to branch: master
Review: https://review.openstack.org/394524

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to nova (master)

Reviewed: https://review.openstack.org/394524
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=1e4178b6a09fac00a560dcf7c5127c55c060c025
Submitter: Jenkins
Branch: master

commit 1e4178b6a09fac00a560dcf7c5127c55c060c025
Author: Matt Riedemann <email address hidden>
Date: Mon Nov 7 11:28:34 2016 -0500

    Add functional api_samples test for addFloatingIp action

    This is needed for filling the gap in the api-ref docs.

    Change-Id: Ib21e4ae25780c1780678074b4ccc5a86944ce992
    Related-Bug: #1636185

Changed in nova:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

Reviewed: https://review.openstack.org/393951
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=0f26e6872efee0ea0e5f565ffbd9909358f05f93
Submitter: Jenkins
Branch: master

commit 0f26e6872efee0ea0e5f565ffbd9909358f05f93
Author: Matt Riedemann <email address hidden>
Date: Fri Nov 4 19:06:32 2016 -0400

    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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/nova 15.0.0.0b1

This issue was fixed in the openstack/nova 15.0.0.0b1 development milestone.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.