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
This commit is contained in:
Lujin 2016-09-28 11:15:05 +09:00 committed by Lujin Luo
parent d53f37db2b
commit 8efbf756a3
3 changed files with 16 additions and 0 deletions

View File

@ -40,6 +40,8 @@ Response Parameters
- vendor_name: vendor_name - vendor_name: vendor_name
- properties: properties - properties: properties
- storage_protocol: storage_protocol - storage_protocol: storage_protocol
- replication_targets: replication_targets
- display_name: display_name
Response Example Response Example
---------------- ----------------

View File

@ -471,6 +471,12 @@ description_9:
in: body in: body
required: true required: true
type: string type: string
display_name:
description: |
The name of volume backend capabilities.
in: body
required: true
type: string
driver_version: driver_version:
description: | description: |
The driver version. The driver version.
@ -1216,6 +1222,13 @@ replication_status:
in: body in: body
required: true required: true
type: string type: string
replication_targets:
description: |
A list of volume backends used to replicate volumes
on this backend.
in: body
required: true
type: list
reserved: reserved:
description: | description: |
Reserved volume size. Visible only if you set the Reserved volume size. Visible only if you set the

View File

@ -8,6 +8,7 @@
"display_name": "Capabilities of Cinder LVM driver", "display_name": "Capabilities of Cinder LVM driver",
"description": "These are volume type options provided by Cinder LVM driver, blah, blah.", "description": "These are volume type options provided by Cinder LVM driver, blah, blah.",
"visibility": "public", "visibility": "public",
"replication_targets": [],
"properties": { "properties": {
"compression": { "compression": {
"title": "Compression", "title": "Compression",