← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1352950] [NEW] os-interface create API docs are wrong

 

Public bug reported:

Was looking at bug 1338551 and the API docs for the attach_interface
create method:

http://docs.openstack.org/api/openstack-compute/2/content/POST_os-
interface-
v2_createAttachInterface__v2__tenant_id__servers__server_id__os-
interface_ext-os-interface.html

The API docs say that port_id is required in the request but it's
actually optional:

http://git.openstack.org/cgit/openstack/nova/tree/nova/api/openstack/compute/contrib/attach_interfaces.py#n80

You can send in port_id/net_id/fixed_ips, net_id and port_id are
mutually exclusive, and requesting a specific fixed_ip without a net_id
is a 400 BadRequest also.

If the port_id isn't provided, the network API will allocate one on the
given network.  If net_id isn't provided, the network associated with
the instance in the network info cache will be used.

The API docs also don't list any error codes, of which there are 400,
404, 409, 500, and 501 (because nova-network doesn't implement this
API).

** Affects: nova
     Importance: Undecided
         Status: New

** Affects: openstack-api-site
     Importance: Undecided
         Status: New


** Tags: api documentation network

** Also affects: openstack-api-site
   Importance: Undecided
       Status: New

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1352950

Title:
  os-interface create API docs are wrong

Status in OpenStack Compute (Nova):
  New
Status in OpenStack API documentation site:
  New

Bug description:
  Was looking at bug 1338551 and the API docs for the attach_interface
  create method:

  http://docs.openstack.org/api/openstack-compute/2/content/POST_os-
  interface-
  v2_createAttachInterface__v2__tenant_id__servers__server_id__os-
  interface_ext-os-interface.html

  The API docs say that port_id is required in the request but it's
  actually optional:

  http://git.openstack.org/cgit/openstack/nova/tree/nova/api/openstack/compute/contrib/attach_interfaces.py#n80

  You can send in port_id/net_id/fixed_ips, net_id and port_id are
  mutually exclusive, and requesting a specific fixed_ip without a
  net_id is a 400 BadRequest also.

  If the port_id isn't provided, the network API will allocate one on
  the given network.  If net_id isn't provided, the network associated
  with the instance in the network info cache will be used.

  The API docs also don't list any error codes, of which there are 400,
  404, 409, 500, and 501 (because nova-network doesn't implement this
  API).

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1352950/+subscriptions


Follow ups

References