Describe volume in OpenStack Block Storage API v1 Reference - API v1 and extensions

[Sam Harwell]

This page does not describe the contents of the JSON response. In particular, the following need to be addressed before the affected properties are of any use to developers.

1. The "status" property is shown in the XML response, but not the JSON response. If this is intentional, it should be explicitly stated. Otherwise, the examples should be updated to show the correct responses.
2. What is the purpose of the "snapshot_id" property? Is the value ever not null? If so, what form can the value take when it's not null?
3. What is the "attachments" property? Is the value ever anything other than an empty array? If so, what form(s) can the value take when it's not an empty array? What is the form of the elements of the array?

-----------------------------------
Built: 2014-05-27T13:54:26 00:00
git SHA: 9c172cf523eb26ec74e6ee82df912de0bca1bfc5
URL: http://docs.openstack.org/api/openstack-block-storage/1.0/content/GET_getVolume__v1__tenant_id__volumes__volume_id__Volumes.html
source File: file:/home/jenkins/workspace/volume-api-tox-doc-publishdocs/v1/bk_blockstorage_api_ref_v1.xml
xml:id: GET_getVolume__v1__tenant_id__volumes__volume_id__Volumes

[Anne Gentle (annegentle)]

This repo is frozen and moving to the openstack-attic. So this exact page won't be updated. But double-checking the API reference:

1. The "status" property is shown in the XML response, but not the JSON response. If this is intentional, it should be explicitly stated. Otherwise, the examples should be updated to show the correct responses.
This should be fixed in http://developer.openstack.org/api-ref-blockstorage-v1.html#volumes-v1 by removing status in the XML example.

2. What is the purpose of the "snapshot_id" property? Is the value ever not null? If so, what form can the value take when it's not null?
Not sure.

3. What is the "attachments" property? Is the value ever anything other than an empty array? If so, what form(s) can the value take when it's not an empty array? What is the form of the elements of the array?
Not sure.

Seems this bug can be partially fixed, but needs answers about snapshot_id and attachments from a cinder developer.

[lizheming (lizheming-li)]

thanks Anne!

[Atsushi SAKAI (sakaia)]

As for #1's 1
JSON sample should be updated.

JSON/XML switching is Request "Attach:"
  http://specs.openstack.org/openstack/cinder-specs/specs/api/v2/request_and_response_types.html
Server treats in attach flag in wsgi
  https://github.com/openstack/cinder/blob/stable/kilo/cinder/api/openstack/wsgi.py#L981
So response item list must be equal.

[Atsushi SAKAI (sakaia)]

As for #1's 3
From discussion context, it should described as multi-attach status (may be 2-items?) not non-attach status (null).

Ref.
 Cinder/blueprints/multi-attach-volume
  https://wiki.openstack.org/wiki/Cinder/blueprints/multi-attach-volume
 Add volume multi attach support
  https://github.com/openstack/cinder/commit/10d54216871fde27172fbcb1a3c9bfec59b824c2

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/221649
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=85481b20124f1e83c0346fcd06bd7b4318c59371
Submitter: Jenkins
Branch: master

commit 85481b20124f1e83c0346fcd06bd7b4318c59371
Author: Atsushi SAKAI <email address hidden>
Date: Wed Sep 9 16:05:40 2015 +0900

    Add volume attributes description for Block Storage API

    For v1
      #1: Add status attribute for JSON sample
      #2: Fix snapshot_id, source_volid description for response side.
      #3: Add attachments non-null sample

    For v2
      Add volume info response attributes

    Change-Id: Iebe1eb2f12550d0e66bb594468ce6b28c9d3c756
    Closes-Bug: #1331246