Incorrect parameters for "Create floating IP"

Bug #1417076 reported by Takanori Miyagishi
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-api-site
Fix Released
Medium
Takanori Miyagishi

Bug Description

In http://developer.openstack.org/api-ref-networking-v2.html,
create floating ip has some misdescription in request/response parameters table.

[Request parameters table]
 1. "floating_network_id"
    This is required parameter, but it is described as "(Optional)" in the table.

 2. "floating_ip_address" and "ip"
    These parameter can not be specified in the request body.

[Response parameters table]
 1. "floating_network_id", "fixed_ip_address", "floating_ip_address"
    These parameters described as "(Optional)" in the table.
    But, all response parameters are not selectable whether to get information.

 2. "router_id" and "status"
    These parameters is included in response body, but the table don't described
    these parameters.

So, I'd like to fix these paramaters as follows.
[Request parameters table]
 1. "floating_ip"
    Delete "(Optional)" signage.

 2. "floating_ip_address" and "ip"
    Delete from the table.

[Response parameters table]
 1. Optional parameters
    Delete "(Optional)" signage.

 2. "router_id" and "status"
    Add these parameters to the table.

Tags: neutron
Changed in openstack-api-site:
assignee: nobody → Takanori Miyagishi (miyagishi-t)
Anne Gentle (annegentle)
Changed in openstack-api-site:
status: New → Confirmed
importance: Undecided → Medium
tags: added: neutron
Changed in openstack-api-site:
status: Confirmed → In Progress
Revision history for this message
Takanori Miyagishi (miyagishi-t) wrote :
Tom Fifield (fifieldt)
Changed in openstack-api-site:
milestone: none → kilo
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to api-site (master)

Reviewed: https://review.openstack.org/158599
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=e0d9ebf612d5975448172cf19b2bf1d4bc2ab4e7
Submitter: Jenkins
Branch: master

commit e0d9ebf612d5975448172cf19b2bf1d4bc2ab4e7
Author: Takanori Miyagishi <email address hidden>
Date: Tue Feb 24 16:49:26 2015 +0900

    Fix incorrect parameters for "create floatingip"

    Fix following parameters
     [Request parameter]
      (1)floating_network_id
        Remove "(Optional)" signage.
      (2)ip
        Remove from Request parameters table.

     [Response parameter]
      (1)floating_network_id, fixed_ip_address, floating_ip_address
        Remove "(Optional)" signage
      (2)router_id, status
        Add to Response parameters table.

    Change-Id: I0427648e20aac2364773e709be86c7f9de8acf7b
    Closes-Bug: #1417076

Changed in openstack-api-site:
status: In Progress → Fix Released
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.