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