931e2f8161
The Cinder v3 API was marked CURRENT in Mitaka, but there no API ref was ever created. This is problematic for end users and would hinder the v3 API from being included in DefCore Interoperability Guidelines somewhere down the line (since one of DefCore's Criteria[1] is that a Capability be well documented). This patch creates an API ref for v3. It also adds a header to the v2 index to show that it is SUPPORTED, whereas v3 is CURRENT. [1] http://git.openstack.org/cgit/openstack/defcore/tree/doc/source/process/CoreCriteria.rst#n77 Change-Id: Ia3a8050cd04ad3a487a79d80acf9691feee6182e Closes-Bug: #1616072
47 lines
1.1 KiB
ReStructuredText
47 lines
1.1 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
===================================================
|
|
Volume image metadata extension (os-vol-image-meta)
|
|
===================================================
|
|
|
|
Shows image metadata that is associated with a volume.
|
|
|
|
|
|
Show image metadata for a volume
|
|
================================
|
|
|
|
.. rest_method:: GET /v3/{tenant_id}/os-vol-image-meta
|
|
|
|
Shows image metadata for a volume.
|
|
|
|
When the request is made, the caller must specify a reference to an
|
|
existing storage volume in the ``ref`` element. Each storage driver
|
|
may interpret the existing storage volume reference differently but
|
|
should accept a reference structure containing either a ``source-
|
|
volume-id`` or ``source-volume-name`` element, if possible.
|
|
|
|
Error response codes:202,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- description: description
|
|
- availability_zone: availability_zone
|
|
- bootable: bootable
|
|
- volume_type: volume_type
|
|
- name: name
|
|
- volume: volume
|
|
- host: host
|
|
- ref: ref
|
|
- metadata: metadata
|
|
- tenant_id: tenant_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ./samples/image-metadata-show-request.json
|
|
:language: javascript
|