From ab9a8a2a6e300d29e9814523541b0e582508c9b4 Mon Sep 17 00:00:00 2001
From: "jeremy.zhang" <zhangjun_inspur@163.com>
Date: Tue, 31 Oct 2017 15:25:22 +0800
Subject: [PATCH] Fix api-ref for group snapshots API

This patch mainly fixes the response parameters and examples for
the show/list/create group snapshots APIs.

Change-Id: If160ffdd7301337eac9353faffb72a9f069882c4
---
 api-ref/source/v3/group-snapshots.inc         | 19 +++++++++----------
 api-ref/source/v3/parameters.yaml             | 12 ++++++++++++
 .../group-snapshots-create-response.json      |  6 +-----
 ...roup-snapshots-list-detailed-response.json |  6 ++++--
 .../group-snapshots-show-response.json        |  3 ++-
 5 files changed, 28 insertions(+), 18 deletions(-)

diff --git a/api-ref/source/v3/group-snapshots.inc b/api-ref/source/v3/group-snapshots.inc
index e26a041383b..2e7c8e0a9af 100644
--- a/api-ref/source/v3/group-snapshots.inc
+++ b/api-ref/source/v3/group-snapshots.inc
@@ -59,9 +59,10 @@ Response Parameters
    - created_at: created_at
    - group_id: source_group_id
    - id: group_snapshot_id_1
-   - name: name_18
+   - name: name_19
    - status: status_7
-   - description: description_14
+   - description: description_16
+   - group_type_id: group_type_id_2
 
 Response Example
 ----------------
@@ -103,11 +104,12 @@ Response Parameters
 
    - group_snapshots: group_snapshots
    - id: group_snapshot_id_1
-   - name: name_18
+   - name: name_19
    - status: status_7
-   - description: description_14
+   - description: description_16
    - created_at: created_at
    - group_id: group_id_1
+   - group_type_id: group_type_id_2
 
 Response Example
 ----------------
@@ -149,7 +151,7 @@ Response Parameters
 
    - group_snapshots: group_snapshots
    - id: group_snapshot_id_1
-   - name: name_18
+   - name: name_19
 
 
 Response Example
@@ -195,11 +197,8 @@ Response Parameters
 
    - group_snapshot: group_snapshot
    - id: group_snapshot_id_1
-   - name: name_18
-   - status: status_7
-   - description: description_14
-   - created_at: created_at
-   - group_id: group_id_1
+   - name: name_19
+   - group_type_id: group_type_id_2
 
 Response Example
 ----------------
diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml
index 5314ee25dbc..e96297b0b82 100644
--- a/api-ref/source/v3/parameters.yaml
+++ b/api-ref/source/v3/parameters.yaml
@@ -881,6 +881,12 @@ description_15:
   in: body
   required: false
   type: string
+description_16:
+  description: |
+    The group snapshot description.
+  in: body
+  required: true
+  type: string
 description_2:
   description: |
     The description of the consistency group.
@@ -1753,6 +1759,12 @@ name_18:
   in: body
   required: false
   type: string
+name_19:
+  description: |
+    The group snapshot name.
+  in: body
+  required: true
+  type: string
 name_2:
   description: |
     The consistency group snapshot name.
diff --git a/api-ref/source/v3/samples/group-snapshots-create-response.json b/api-ref/source/v3/samples/group-snapshots-create-response.json
index f25d1fb6425..f02859b34f1 100644
--- a/api-ref/source/v3/samples/group-snapshots-create-response.json
+++ b/api-ref/source/v3/samples/group-snapshots-create-response.json
@@ -2,10 +2,6 @@
     "group_snapshot": {
         "id": "6f519a48-3183-46cf-a32f-41815f816666",
         "name": "first_group_snapshot",
-        "status": "creating",
-        "group_type_id": "58737af7-786b-48b7-ab7c-2447e74b0ef4",
-        "created_at": "2017-06-20T07:44:47.000000",
-        "group_id": "d5577983-23be-47e3-b98b-bf604e5af421",
-        "description": null
+        "group_type_id": "58737af7-786b-48b7-ab7c-2447e74b0ef4"
     }
 }
diff --git a/api-ref/source/v3/samples/group-snapshots-list-detailed-response.json b/api-ref/source/v3/samples/group-snapshots-list-detailed-response.json
index a5af0289998..7cfc7da995b 100644
--- a/api-ref/source/v3/samples/group-snapshots-list-detailed-response.json
+++ b/api-ref/source/v3/samples/group-snapshots-list-detailed-response.json
@@ -6,7 +6,8 @@
             "status": "available",
             "created_at": "2015-09-16T09:28:52.000000",
             "name": "my_group_snapshot1",
-            "description": "my first group snapshot"
+            "description": "my first group snapshot",
+            "group_type_id": "0ef094a2-d9fd-4c79-acfd-ac60a0506b7d"
         },
         {
             "id": "aed36625-a6d7-4681-ba59-c7ba3d18c148",
@@ -14,7 +15,8 @@
             "status": "error",
             "created_at": "2015-09-16T09:31:15.000000",
             "name": "my_group_snapshot2",
-            "description": "Edited description"
+            "description": "Edited description",
+            "group_type_id": "7270c56e-6354-4528-8e8b-f54dee2232c8"
         }
     ]
 }
diff --git a/api-ref/source/v3/samples/group-snapshots-show-response.json b/api-ref/source/v3/samples/group-snapshots-show-response.json
index 256224959f0..137bfd17437 100644
--- a/api-ref/source/v3/samples/group-snapshots-show-response.json
+++ b/api-ref/source/v3/samples/group-snapshots-show-response.json
@@ -5,6 +5,7 @@
         "status": "available",
         "created_at": "2015-09-16T09:28:52.000000",
         "name": "my_group_snapshot1",
-        "description": "my first group snapshot"
+        "description": "my first group snapshot",
+        "group_type_id": "7270c56e-6354-4528-8e8b-f54dee2232c8"
     }
 }