From 1a2a0d4996af279ceb5ad742fd83b6429c4c0feb Mon Sep 17 00:00:00 2001
From: TommyLike <tommylikehu@gmail.com>
Date: Tue, 30 Jan 2018 16:00:13 +0800
Subject: [PATCH] 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
---
 api-ref/source/v3/groups.inc                       |  4 ++++
 api-ref/source/v3/parameters.yaml                  | 14 ++++++++++++++
 api-ref/source/v3/samples/group-show-response.json |  1 +
 .../v3/samples/groups-list-detailed-response.json  |  6 ++++--
 4 files changed, 23 insertions(+), 2 deletions(-)

diff --git a/api-ref/source/v3/groups.inc b/api-ref/source/v3/groups.inc
index 3d24a8f0d6d..654e8b9df3a 100644
--- a/api-ref/source/v3/groups.inc
+++ b/api-ref/source/v3/groups.inc
@@ -109,6 +109,7 @@ Request
 
    - project_id: project_id_path
    - group_id: group_id
+   - list_volume: list_volume
 
 Response Parameters
 -------------------
@@ -124,6 +125,7 @@ Response Parameters
    - volume_types: volume_types
    - id: id
    - name: group_name
+   - volumes: volume_ids
    - replication_status: group_replication_status
 
 Response Example
@@ -217,6 +219,7 @@ Request
    - limit: limit
    - offset: offset
    - marker: marker
+   - list_volume: list_volume
 
 
 Response Parameters
@@ -233,6 +236,7 @@ Response Parameters
    - volume_types: volume_types
    - id: group_id
    - name: name
+   - volumes: volume_ids
 
 Response Example
 ----------------
diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml
index 85186f17aaf..d6a48ee0ac2 100644
--- a/api-ref/source/v3/parameters.yaml
+++ b/api-ref/source/v3/parameters.yaml
@@ -121,6 +121,13 @@ key_5:
   in: path
   required: true
   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:
   description: |
     The UUID of the message.
@@ -2829,6 +2836,13 @@ volume_id_7:
   in: body
   required: true
   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:
   description: |
     List of image metadata entries.  Only included for volumes that were
diff --git a/api-ref/source/v3/samples/group-show-response.json b/api-ref/source/v3/samples/group-show-response.json
index 89ca220b4d0..af3c2eaf560 100644
--- a/api-ref/source/v3/samples/group-show-response.json
+++ b/api-ref/source/v3/samples/group-show-response.json
@@ -10,6 +10,7 @@
         "volume_types": [
             "c4daaf47-c530-4901-b28e-f5f0a359c4e6"
         ],
+        "volumes": ["a2cdf1ad-5497-4e57-bd7d-f573768f3d03"],
         "group_snapshot_id": None,
         "source_group_id": None
     }
diff --git a/api-ref/source/v3/samples/groups-list-detailed-response.json b/api-ref/source/v3/samples/groups-list-detailed-response.json
index 46795141328..65747a44c67 100644
--- a/api-ref/source/v3/samples/groups-list-detailed-response.json
+++ b/api-ref/source/v3/samples/groups-list-detailed-response.json
@@ -11,7 +11,8 @@
             "volume_types": [
                 "4e9e6d23-eed0-426d-b90a-28f87a94b6fe",
                 "a3d55d15-eeb1-4816-ada9-bf82decc09b3"
-            ]
+            ],
+            "volumes": ["a2cdf1ad-5497-4e57-bd7d-f573768f3d03"]
         },
         {
             "id": "aed36625-a6d7-4681-ba59-c7ba3d18c148",
@@ -23,7 +24,8 @@
             "group_type": "f8645498-1323-47a2-9442-5c57724d2e3c",
             "volume_types": [
                 "c4daaf47-c530-4901-b28e-f5f0a359c4e6"
-            ]
+            ],
+            "volumes": ["a2cdf1ad-5497-4e57-bd7d-f573768f3d03"]
         }
     ]
 }