← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1675536] [NEW] api-ref: attach volume volumeAttachment description is wrong

 

Public bug reported:

https://developer.openstack.org/api-ref/compute/?expanded=attach-a
-volume-to-an-instance-detail#attach-a-volume-to-an-instance

That says:

volumeAttachment        body    object  A dictionary representation of a
volume attachment containing the fields, device, id, serverId, volumeId.

But there are only two possible fields for that dictionary, volumeId
(required) and device (optional):

https://github.com/openstack/nova/blob/b2b366aa4aa2b5199ddbd8cd51019f3d8b7bccc3/nova/api/openstack/compute/schemas/volumes.py#L70

So the volumeAttachment in the request parameters here are probably
actually for a response which has those other details like id and
serverId.

** Affects: nova
     Importance: Medium
     Assignee: Matt Riedemann (mriedem)
         Status: Triaged


** Tags: api-ref volumes

** Changed in: nova
     Assignee: (unassigned) => Matt Riedemann (mriedem)

-- 
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/1675536

Title:
  api-ref: attach volume volumeAttachment description is wrong

Status in OpenStack Compute (nova):
  Triaged

Bug description:
  https://developer.openstack.org/api-ref/compute/?expanded=attach-a
  -volume-to-an-instance-detail#attach-a-volume-to-an-instance

  That says:

  volumeAttachment        body    object  A dictionary representation of
  a volume attachment containing the fields, device, id, serverId,
  volumeId.

  But there are only two possible fields for that dictionary, volumeId
  (required) and device (optional):

  https://github.com/openstack/nova/blob/b2b366aa4aa2b5199ddbd8cd51019f3d8b7bccc3/nova/api/openstack/compute/schemas/volumes.py#L70

  So the volumeAttachment in the request parameters here are probably
  actually for a response which has those other details like id and
  serverId.

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


Follow ups