Inconsistent naming for image reference in create volume API

[Shaunak Kashyap]

The request for the Create Volume API can take a property named "imageRef" that specifies the ID of the image to be used when creating the volume. The name of this property ("imageRef") is inconsistent in two ways:

1. All the other multi-word request properties to this API use snake case (e.g. "volume_type", "snapshot_id", "source_volid", "availability_name", "display_name", and "display_description").

2. The corresponding property in the same API's response is named "image_id".

This affects v1 and v2 of the Cinder API.

[Mike Perez (thingee)]

At this point it's too late to change it. Not sure how others feel with adding image_id as an alternative key for this now to v2.

[Duncan Thomas (duncan-thomas)]

Accepting either (changing the documentation to suggest using the snake-case version?) but accepting the old version seems reasonable. Need to make sure any json schema we produce lists both as supported.

[John Griffith (john-griffith)]

FWIW, if someone looks at changing this, I've always thought it would be great if we changed this from "image_id" to just "image" which would also align with Nova.

This would of course require maintaining backward compatibility which should be trivial.

[Pascal Wehrle (p-wehrle)]

Will have a shot at the OpenStack Upstream Training (https://wiki.openstack.org/wiki/OpenStack_Upstream_Training/Info).

[OpenStack Infra (hudson-openstack)]

Change abandoned by Pascal Wehrle (<email address hidden>) on branch: master
Review: https://review.openstack.org/133340
Reason: link to bug report not working

[OpenStack Infra (hudson-openstack)]

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

[Pascal Wehrle (p-wehrle)]

@john-griffith The above fix does not include accepting "image" instead of "imageRef". It could be added using the same method but that would still leave the response property at "image_id" and add another set of unit tests. I'd be open to contribute a separate patch for that.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/133383
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=b65d678f4d475a62f9a83f96bddbeb6f694d1e5b
Submitter: Jenkins
Branch: master

commit b65d678f4d475a62f9a83f96bddbeb6f694d1e5b
Author: Pascal Wehrle <email address hidden>
Date: Mon Nov 17 23:20:17 2014 +0100

    allow image_id for imageRef in create volume API v2

    The create volume request for the V2 API has a property named
    "imageRef" with the ID of the image to be used when creating the
    volume.
    The name of this property is inconsistent as all multi word
    properties use snake case and the property in the reponse is named
    "image_id".

    This adds support for aliasing the imageRef key with image_id when
    creating a volume in v2 of the Cinder API in a backward-compatible
    way.

    Change-Id: I85a5c6734ba05a8a7ea9eff3f849d12fb3d167fb
    Closes-Bug: 1375867