openstack/cinder
Code Issues Proposed changes

[api-ref] Show more specific parameter of capabilities

Browse Source 
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
This commit is contained in:
Mitsuhiro Tanino 2016-12-13 17:49:51 -05:00
parent 0e47f3ce3a
commit 7fa8165180
4 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
api-ref/source/v2/capabilities-v2.inc
View File

@ -10,9 +10,10 @@ Shows capabilities for a storage back end.
Show back-end capabilities Show back-end capabilities
========================== ==========================
.. rest_method:: GET /v2/{tenant_id}/capabilities/{hostname} .. rest_method:: GET /v2/{tenant_id}/capabilities/{host}
Shows capabilities for a storage back end. Shows capabilities for a storage back end on the host.
The ``host`` takes the form of ``hostname@volume_backend_name``.
Normal response codes: 200 Normal response codes: 200

2
api-ref/source/v2/samples/backend-capabilities-response.json
View File

@ -1,7 +1,7 @@
{ {
"namespace": "OS::Storage::Capabilities::fake", "namespace": "OS::Storage::Capabilities::fake",
"vendor_name": "OpenStack", "vendor_name": "OpenStack",
"volume_backend_name": "lvm", "volume_backend_name": "lvmdriver-1",
"pool_name": "pool", "pool_name": "pool",
"driver_version": "2.0.0", "driver_version": "2.0.0",
"storage_protocol": "iSCSI", "storage_protocol": "iSCSI",

6
api-ref/source/v3/capabilities-v3.inc
View File

@ -10,10 +10,10 @@ Shows capabilities for a storage back end.
Show all back-end capabilities Show all back-end capabilities
============================== ==============================
.. rest_method:: GET /v3/{tenant_id}/capabilities/{hostname} .. rest_method:: GET /v3/{tenant_id}/capabilities/{host}
Shows capabilities for a storage back end.
Shows capabilities for a storage back end on the host.
The ``host`` takes the form of ``hostname@volume_backend_name``.
Normal response codes: 200 Normal response codes: 200
Error response codes: Error response codes:

2
api-ref/source/v3/samples/backend-capabilities-response.json
View File

@ -1,7 +1,7 @@
{ {
"namespace": "OS::Storage::Capabilities::fake", "namespace": "OS::Storage::Capabilities::fake",
"vendor_name": "OpenStack", "vendor_name": "OpenStack",
"volume_backend_name": "lvm", "volume_backend_name": "lvmdriver-1",
"pool_name": "pool", "pool_name": "pool",
"driver_version": "2.0.0", "driver_version": "2.0.0",
"storage_protocol": "iSCSI", "storage_protocol": "iSCSI",