API ref/sample for GET on /v3/{project_id}/volumes/{volume_id} is missing volume_image_metadata

[Chris Friesen]

Looking at the API ref at https://developer.openstack.org/api-ref/block-storage/v3/#volumes-volumes or at volume-show-response.json in the cinder code, the "volume_image_metadata" field is missing.

Based on discussion on IRC it appears that it's still present in the code.

For people just trying to use the API, this is less than ideal. (It tripped up both myself and a nova core.)

[Chris Friesen (cbf123)]

Based on mriedem's comments, it looks like volume-show-response.json is not a bootable volume. Would this explain why it doesn't have the "volume_image_metadata" field?

[OpenStack Infra (hudson-openstack)]

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

[Chris Friesen (cbf123)]

Looks like the field is present if the volume was created from an image.

[Matt Riedemann (mriedem)]

Here is a real-world example: http://paste.openstack.org/show/626551/

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/520686
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=8cb4aedda6b44c6cacb37cf525e02e5f299af41d
Submitter: Zuul
Branch: master

commit 8cb4aedda6b44c6cacb37cf525e02e5f299af41d
Author: Chris Friesen <email address hidden>
Date: Thu Nov 16 13:01:53 2017 -0600

    Update api-ref to include volume_image_metadata

    The detailed information for a volume can include "volume_image_metadata"
    in the case where the volume was created from an image, or in the case
    where the volume was created from a snapshot of such a volume.

    Update the API ref to include the field so we accurately represent
    the code.

    Change-Id: If5fcdefaa10bfb00e60aa4559d3282d3c6a53752
    Closes-Bug: #1732763

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/cinder 12.0.0.0b2 development milestone.