From 085d44ba784ffe3e8122fb876ae01f5fcd246b78 Mon Sep 17 00:00:00 2001
From: TommyLike <tommylikehu@gmail.com>
Date: Wed, 9 Nov 2016 16:47:29 +0800
Subject: [PATCH] [4/4]Reset generic volume group and group snapshot statuses

Currently the administrator could only reset the generic group
status by db operation(include snapshots), this change intends
to add new admin actions to achieve these.

The patch list:
    1. group API [1].
    2. snapshot API [2].
    3. cinder client [3].
    4. documentation(this).

[1] 92bbacdcef302b09d85618644e1dfc4511841274
[2] 70171dc2ff6b085db90228d98638047bfc6984ba
[3] 9820cb6f38b6a68351776c333e5deacd38c5afc9

Partial-Implements: blueprint reset-cg-and-cgs-status

Change-Id: I9b985349ccb61e51a91d47d94393b68d901ac738
---
 api-ref/source/v3/group-snapshots.inc         | 28 +++++++++++++++++++
 api-ref/source/v3/groups.inc                  | 28 +++++++++++++++++++
 api-ref/source/v3/parameters.yaml             |  6 ++++
 .../samples/group-reset-status-request.json   |  5 ++++
 .../group-snapshot-reset-status-request.json  |  5 ++++
 5 files changed, 72 insertions(+)
 create mode 100644 api-ref/source/v3/samples/group-reset-status-request.json
 create mode 100644 api-ref/source/v3/samples/group-snapshot-reset-status-request.json

diff --git a/api-ref/source/v3/group-snapshots.inc b/api-ref/source/v3/group-snapshots.inc
index ed47cfe3e11..3d37f586c88 100644
--- a/api-ref/source/v3/group-snapshots.inc
+++ b/api-ref/source/v3/group-snapshots.inc
@@ -178,3 +178,31 @@ Response Parameters
    - group_id: group_id
    - id: id
    - name: name
+
+
+Reset group snapshot status
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. rest_method::  PUT /v3/{project_id}/group_snapshots/{group_snapshot_id}/action
+
+Resets the status for a group snapshot. Specifies the ``reset_status`` action in the request body.
+
+Normal response codes: 202
+Error response codes: badRequest(400), itemNotFound(404)
+
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - reset_status: reset_status
+   - status: status
+   - project_id: project_id
+   - group_snapshot_id: group_snapshot_id
+
+Request Example
+---------------
+
+.. literalinclude:: ./samples/group-snapshot-reset-status-request.json
+   :language: javascript
diff --git a/api-ref/source/v3/groups.inc b/api-ref/source/v3/groups.inc
index 05b3bcd070c..7a9052c605d 100644
--- a/api-ref/source/v3/groups.inc
+++ b/api-ref/source/v3/groups.inc
@@ -254,3 +254,31 @@ Request Example
 
 .. literalinclude:: ./samples/group-update-request.json
    :language: javascript
+
+
+Reset group status
+~~~~~~~~~~~~~~~~~~
+
+.. rest_method::  PUT /v3/{project_id}/groups/{group_id}/action
+
+Resets the status for a group. Specify the ``reset_status`` action in the request body.
+
+Normal response codes: 202
+Error response codes: badRequest(400), itemNotFound(404)
+
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - reset_status: reset_status
+   - status: status
+   - project_id: project_id
+   - group_id: group_id
+
+Request Example
+---------------
+
+.. literalinclude:: ./samples/group-reset-status-request.json
+   :language: javascript
diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml
index a1b664e7977..390dd14dbd9 100644
--- a/api-ref/source/v3/parameters.yaml
+++ b/api-ref/source/v3/parameters.yaml
@@ -1421,6 +1421,12 @@ reserved_percentage:
   in: body
   required: true
   type: integer
+reset_status:
+  description: |
+    The ``reset_status`` action.
+  in: body
+  required: true
+  type: object
 restore:
   description: |
     A ``restore`` object.
diff --git a/api-ref/source/v3/samples/group-reset-status-request.json b/api-ref/source/v3/samples/group-reset-status-request.json
new file mode 100644
index 00000000000..4134830878c
--- /dev/null
+++ b/api-ref/source/v3/samples/group-reset-status-request.json
@@ -0,0 +1,5 @@
+{
+    "reset_status": {
+        "status": "available"
+    }
+}
\ No newline at end of file
diff --git a/api-ref/source/v3/samples/group-snapshot-reset-status-request.json b/api-ref/source/v3/samples/group-snapshot-reset-status-request.json
new file mode 100644
index 00000000000..4134830878c
--- /dev/null
+++ b/api-ref/source/v3/samples/group-snapshot-reset-status-request.json
@@ -0,0 +1,5 @@
+{
+    "reset_status": {
+        "status": "available"
+    }
+}
\ No newline at end of file