a96fad9f3b
Using the wrong character resulted in the wrong title level being used for the response codes, which in turn caused the "detail" show/hide toggle to not be able to hide all of the per-endpoint details. This corrects these to be at the correct level. Also ran into issues after changing them where sphinx was not happy with the random title levels. This appears to be due to the order processed and whether not earlier included files had all subsequent levels. Adding an additional title in our first included file resolved that problem. Change-Id: I19405778980310f2d6d06eb7b23102f74a3d6e03 Closes-bug: #1755566
85 lines
1.5 KiB
ReStructuredText
85 lines
1.5 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Backup actions (backups, action)
|
|
================================
|
|
|
|
Force-deletes a backup and reset status for a backup.
|
|
|
|
|
|
Force-delete backup
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: POST /v2/{project_id}/backups/{backup_id}/action
|
|
|
|
Force-deletes a backup. Specify the ``os-force_delete`` action in the request body.
|
|
|
|
This operations deletes the backup and any backup data.
|
|
|
|
The backup driver returns the ``405`` status code if it does not
|
|
support this operation.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 202
|
|
|
|
.. rest_status_code:: error ../status.yaml
|
|
|
|
- 404
|
|
- 405
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- os-force_delete: os-force_delete
|
|
- project_id: project_id_path
|
|
- backup_id: backup_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ./samples/backup-force-delete-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
Reset backup's status
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: POST /v2/{project_id}/backups/{backup_id}/action
|
|
|
|
Reset a backup's status. Specify the ``os-reset_status`` action in the request body.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 202
|
|
|
|
.. rest_status_code:: error ../status.yaml
|
|
|
|
- 400
|
|
- 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- status: status_7
|
|
- 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
|
|
|