a60fd0a61c
This patch set corrects the namespace parameter for capabilities
api-ref from namespace [0] to namespace_1 which is the correct
one as it is both required and matches the following format
in the view code [2]:
The storage namespace, such as
``OS::Storage::Capabilities::foo``.
[0] 7f7716d584/api-ref/source/v3/parameters.yaml (L1945)
[1] 7f7716d584/api-ref/source/v3/parameters.yaml (L1951)
[2] af41c04d0f/cinder/api/views/capabilities.py (L31)
Change-Id: I0557b32e7e3752e8fcde5dadd621c82fded1e755
54 lines
1.2 KiB
ReStructuredText
54 lines
1.2 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Capabilities for storage back ends (capabilities)
|
|
=================================================
|
|
|
|
Shows capabilities for a storage back end.
|
|
|
|
|
|
Show back-end capabilities
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v2/{project_id}/capabilities/{hostname}
|
|
|
|
Shows capabilities for a storage back end on the host.
|
|
The ``hostname`` takes the form of ``hostname@volume_backend_name``.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- hostname: hostname
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- pool_name: pool_name
|
|
- description: description
|
|
- volume_backend_name: volume_backend_name
|
|
- namespace: namespace_1
|
|
- visibility: visibility
|
|
- driver_version: driver_version
|
|
- vendor_name: vendor_name
|
|
- properties: properties
|
|
- storage_protocol: storage_protocol
|
|
- replication_targets: replication_targets
|
|
- display_name: display_name
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/backend-capabilities-response.json
|
|
:language: javascript
|