Merge "Api-ref: add documentation for v2/v3 backup 'os-reset_status' action"

api-ref/source/v2/ext-backups-actions-v2.inc

@@ -3,7 +3,7 @@
 Backup actions (backups, action)
 ================================
 
-Force-deletes a backup.
+Force-deletes a backup and reset status for a backup.
 
 
 Force-delete backup
@@ -18,9 +18,8 @@ This operations deletes the backup and any backup data.
 The backup driver returns the ``405`` status code if it does not
 support this operation.
 
-Normal response codes: 202,
+Normal response codes: 202
-
+Error response codes: itemNotFound(404), badMethod(405)
-Error response codes:404,405,
 
 
 Request
@@ -37,3 +36,33 @@ Request Example
 
 .. literalinclude:: ./samples/backup-force-delete-request.json
    :language: javascript
+
+
+
+Reset backup's status
+~~~~~~~~~~~~~~~~~~~~~
+
+.. rest_method::  POST /v2/{tenant_id}/backups/{backup_id}/action
+
+Reset a backup's status. Specify the ``os-reset_status`` action in the request body.
+
+Normal response codes: 202
+Error response codes: badRequest(400), itemNotFound(404)
+
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - status: status_7
+   - os-reset_status: os-reset_status
+   - tenant_id: tenant_id
+   - backup_id: backup_id
+
+Request Example
+---------------
+
+.. literalinclude:: ./samples/backup-reset-status-request.json
+   :language: javascript
+

api-ref/source/v2/parameters.yaml

@@ -1578,6 +1578,12 @@ status_6:
   in: body
   required: false
   type: string
+status_7:
+  description: |
+    The status for the backup.
+  in: body
+  required: true
+  type: string
 storage_protocol:
   description: |
     The storage back end for the back-end volume. For

api-ref/source/v2/samples/backup-reset-status-request.json

@@ -0,0 +1,5 @@
+{
+    "os-reset_status": {
+        "status": "available"
+    }
+}

api-ref/source/v3/ext-backups-actions-v3.inc

@@ -3,7 +3,7 @@
 Backup actions (backups, action)
 ================================
 
-Force-deletes a backup.
+Force-deletes a backup and reset status for a backup.
 
 
 Force-delete a backup
@@ -18,8 +18,8 @@ This operations deletes the backup and any backup data.
 The backup driver returns the ``405`` status code if it does not
 support this operation.
 
-Error response codes:404,405,202,
+Normal response codes: 202
-
+Error response codes: itemNotFound(404), badMethod(405)
 
 Request
 -------
@@ -35,3 +35,33 @@ Request Example
 
 .. literalinclude:: ./samples/backup-force-delete-request.json
    :language: javascript
+
+
+
+Reset a backup's status
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. rest_method::  POST /v3/{project_id}/backups/{backup_id}/action
+
+Reset a backup's status. Specify the ``os-reset_status`` action in the request body.
+
+Normal response codes: 202
+Error response codes: badRequest(400), itemNotFound(404)
+
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - status: status_10
+   - os-reset_status: os-reset_status
+   - project_id: project_id_path
+   - backup_id: backup_id
+
+Request Example
+---------------
+
+.. literalinclude:: ./samples/backup-reset-status-request.json
+   :language: javascript
+

api-ref/source/v3/parameters.yaml

@@ -2050,6 +2050,12 @@ status_1:
   in: body
   required: true
   type: string
+status_10:
+  description: |
+    The status for the backup.
+  in: body
+  required: true
+  type: string
 status_2:
   description: |
     The status for the snapshot.

api-ref/source/v3/samples/backup-reset-status-request.json

@@ -0,0 +1,5 @@
+{
+    "os-reset_status": {
+        "status": "available"
+    }
+}