cinder/api-ref/source/v2/capabilities-v2.inc
Lujin 8efbf756a3 Add 'replication_targets' and 'display_name' in API docs
'replication_targets' is always returned in Response of GET/v2/
{tenant_id}/capabilities/{hostname} API, but it is not written
in either Response parameters table or JSON example.

'display_name' is listed in JSON example but not described in
Response parameter table.

This patch adds the above two missing information.

Change-Id: Ib3bf54df7c5c400cfec64dd9c7df136c87cd6376
Closes-Bug: #1603306
2016-09-28 18:05:33 +09:00

51 lines
1.1 KiB
ReStructuredText

.. -*- rst -*-
=================================================
Capabilities for storage back ends (capabilities)
=================================================
Shows capabilities for a storage back end.
Show back-end capabilities
==========================
.. rest_method:: GET /v2/{tenant_id}/capabilities/{hostname}
Shows capabilities for a storage back end.
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
- replication_targets: replication_targets
- display_name: display_name
Response Example
----------------
.. literalinclude:: ./samples/backend-capabilities-response.json
:language: javascript