Add 'list_volume' in Group show&list API Doc

Add API document for 'list_volume' in Group
show&list APIs.

Code patch: https://review.openstack.org/#/c/409694

Change-Id: Ib328b62c61ec8b8afed3de07020c7ae2bfb163be
This commit is contained in:
TommyLike 2018-01-30 16:00:13 +08:00
parent cf56cdd4da
commit 1a2a0d4996
4 changed files with 23 additions and 2 deletions

View File

@ -109,6 +109,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- group_id: group_id - group_id: group_id
- list_volume: list_volume
Response Parameters Response Parameters
------------------- -------------------
@ -124,6 +125,7 @@ Response Parameters
- volume_types: volume_types - volume_types: volume_types
- id: id - id: id
- name: group_name - name: group_name
- volumes: volume_ids
- replication_status: group_replication_status - replication_status: group_replication_status
Response Example Response Example
@ -217,6 +219,7 @@ Request
- limit: limit - limit: limit
- offset: offset - offset: offset
- marker: marker - marker: marker
- list_volume: list_volume
Response Parameters Response Parameters
@ -233,6 +236,7 @@ Response Parameters
- volume_types: volume_types - volume_types: volume_types
- id: group_id - id: group_id
- name: name - name: name
- volumes: volume_ids
Response Example Response Example
---------------- ----------------

View File

@ -121,6 +121,13 @@ key_5:
in: path in: path
required: true required: true
type: string type: string
list_volume:
description: |
Show volume ids in this group. Default is False.
in: path
required: false
type: string
min_version: 3.25
message_id: message_id:
description: | description: |
The UUID of the message. The UUID of the message.
@ -2829,6 +2836,13 @@ volume_id_7:
in: body in: body
required: true required: true
type: string type: string
volume_ids:
description: |
A list of ``volume`` ids, available only when ``list_volume`` set true.
in: body
required: false
type: array
min_version: 3.25
volume_image_metadata: volume_image_metadata:
description: | description: |
List of image metadata entries. Only included for volumes that were List of image metadata entries. Only included for volumes that were

View File

@ -10,6 +10,7 @@
"volume_types": [ "volume_types": [
"c4daaf47-c530-4901-b28e-f5f0a359c4e6" "c4daaf47-c530-4901-b28e-f5f0a359c4e6"
], ],
"volumes": ["a2cdf1ad-5497-4e57-bd7d-f573768f3d03"],
"group_snapshot_id": None, "group_snapshot_id": None,
"source_group_id": None "source_group_id": None
} }

View File

@ -11,7 +11,8 @@
"volume_types": [ "volume_types": [
"4e9e6d23-eed0-426d-b90a-28f87a94b6fe", "4e9e6d23-eed0-426d-b90a-28f87a94b6fe",
"a3d55d15-eeb1-4816-ada9-bf82decc09b3" "a3d55d15-eeb1-4816-ada9-bf82decc09b3"
] ],
"volumes": ["a2cdf1ad-5497-4e57-bd7d-f573768f3d03"]
}, },
{ {
"id": "aed36625-a6d7-4681-ba59-c7ba3d18c148", "id": "aed36625-a6d7-4681-ba59-c7ba3d18c148",
@ -23,7 +24,8 @@
"group_type": "f8645498-1323-47a2-9442-5c57724d2e3c", "group_type": "f8645498-1323-47a2-9442-5c57724d2e3c",
"volume_types": [ "volume_types": [
"c4daaf47-c530-4901-b28e-f5f0a359c4e6" "c4daaf47-c530-4901-b28e-f5f0a359c4e6"
] ],
"volumes": ["a2cdf1ad-5497-4e57-bd7d-f573768f3d03"]
} }
] ]
} }