609412fcd2
The parameters with name like example_1, example_2 ... etc. cause confusion while updating the api-ref docs like the examples below: https://review.openstack.org/#/c/609639/ https://review.openstack.org/#/c/609611/ This patch does the following changes : 1) Replace numbering in the parameter with relevant names 2) Clean up unused parameters Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
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 all back-end capabilities
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v3/{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_cap
|
|
- volume_backend_name: volume_backend_name
|
|
- namespace: namespace_storage
|
|
- 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
|