openstack/cinder
Code Issues Proposed changes
b15e84f594
cinder/api-ref/source/v3/capabilities-v3.inc

49 lines
1.1 KiB
PHP
Raw Normal View History

Create v3 API Reference 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
2016-09-17 01:12:40 -04:00
.. -*- rst -*-
=================================================
Capabilities for storage back ends (capabilities)
=================================================
Shows capabilities for a storage back end.
Show all back-end capabilities
==============================
[api-ref] Show more specific parameter of capabilities Current capabilities api-ref explains that the API takes {hostname}, but this is not accurate. Actually this api takes hostname@volume_backend_name format. To avoid confusion, this explanation should be updated. Change-Id: I0d9e9925a1b011f49cefc9867f617e8b51ec7437
2016-12-13 17:49:51 -05:00
.. rest_method:: GET /v3/{tenant_id}/capabilities/{host}
Create v3 API Reference 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
2016-09-17 01:12:40 -04:00
[api-ref] Show more specific parameter of capabilities Current capabilities api-ref explains that the API takes {hostname}, but this is not accurate. Actually this api takes hostname@volume_backend_name format. To avoid confusion, this explanation should be updated. Change-Id: I0d9e9925a1b011f49cefc9867f617e8b51ec7437
2016-12-13 17:49:51 -05:00
Shows capabilities for a storage back end on the host.
The ``host`` takes the form of ``hostname@volume_backend_name``.
Create v3 API Reference 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
2016-09-17 01:12:40 -04:00
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- hostname: hostname
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- pool_name: pool_name
- description: description
- volume_backend_name: volume_backend_name
- namespace: namespace
- visibility: visibility
- driver_version: driver_version
- vendor_name: vendor_name
- properties: properties
- storage_protocol: storage_protocol
Response Example
----------------
.. literalinclude:: ./samples/backend-capabilities-response.json
:language: javascript
Copy Permalink