cinder/api-ref/source/v3/ext-backups-actions-v3.inc
whoami-rajat 609412fcd2 Improve/Clean api-ref parameters
The parameters with name like example_1, example_2 ... etc. cause
confusion while updating the api-ref docs like the examples below:

https://review.openstack.org/#/c/609639/
https://review.openstack.org/#/c/609611/

This patch does the following changes :
1) Replace numbering in the parameter with relevant names
2) Clean up unused parameters

Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
2018-11-05 10:47:14 +05:30

88 lines
1.6 KiB
ReStructuredText

.. -*- rst -*-
Backup actions (backups, action)
================================
Force-deletes a backup and reset status for a backup.
Force-delete a backup
~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v3/{project_id}/backups/{backup_id}/action
Force-deletes a backup. Specify the ``os-force_delete`` action in the request
body.
This operation 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
- project_id: project_id_path
- backup_id: backup_id_required
- os-force_delete: os-force_delete
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.
Response codes
--------------
.. rest_status_code:: success ../status.yaml
- 202
.. rest_status_code:: error ../status.yaml
- 400
- 404
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- backup_id: backup_id_required
- os-reset_status: os-reset_status
- status: status_backup_action
Request Example
---------------
.. literalinclude:: ./samples/backup-reset-status-request.json
:language: javascript