/v2/{tenant_id}/volumes/{volume_id}/metadata has wrong parameter description

Bug #1646889 reported by Matt Riedemann
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Cinder
Fix Released
Undecided
wangxiyuan

Bug Description

Looking at these docs:

http://developer.openstack.org/api-ref/block-storage/v2/?expanded=create-volume-metadata-detail,update-volume-metadata-detail#create-volume-metadata

This is for POSTing (creating) volume metadata, but the metadata parameter description is for snapshot metadata, and is probably re-used from the snapshot create description, i.e. 'one or more, if any' doesn't make sense here really. Unless 'if any' means you can POST {} for volume metadata and overwrite any existing vol metadata, would have to dig into the code to see how it works.

But this is wrong:

"metadata body object One or more metadata key and value pairs for the snapshot, if any."

Matt Riedemann (mriedem)
tags: added: docs low-hanging-fruit
wangxiyuan (wangxiyuan)
Changed in cinder:
assignee: nobody → wangxiyuan (wangxiyuan)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to cinder (master)

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

Changed in cinder:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to cinder (master)

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

commit b54828799d0878ad25cf650922dbee4d98cd3334
Author: wangxiyuan <email address hidden>
Date: Tue Dec 13 16:41:34 2016 +0800

    [api-ref]Fix the volume metadata description error

    The volume metadata's description is wrong and should not be
    related to snapshot in the api-ref.

    Change-Id: I5cca636c42a7b5735f6c6bd60901cbc77ce9d14f
    Closes-bug: #1646889

Changed in cinder:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/cinder 10.0.0.0rc1

This issue was fixed in the openstack/cinder 10.0.0.0rc1 release candidate.

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.