8659ff0ef5
This patch is for converting API Reference to RST and host it in the Cinder tree. This patch contains all the RST for cinder to bring over to their repos to begin building API reference information from within. This contains .inc files which have all the contents of the .rst files but are grouped together for easier editing This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API. Cleaning task will be done once this part is merged. As we have removed XML API support in Newton release, we need to remove XML from API reference as well. But we still have installations which are using XML. So implementation plan is to first merge this patch in Newton release keeping XML for now, then I will backport same to stable branches. After that I will remove same from Newton release to match API reference with actual API implementation. Implements: bp api-reference-to-rst Change-Id: I865ac922538bfa5bd45c24eb4bc49f5e966dc811
39 lines
785 B
ReStructuredText
39 lines
785 B
ReStructuredText
.. -*- rst -*-
|
|
|
|
================================
|
|
Backup actions (backups, action)
|
|
================================
|
|
|
|
Force-deletes a backup.
|
|
|
|
|
|
Force-delete backup
|
|
===================
|
|
|
|
.. rest_method:: POST /v2/{tenant_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.
|
|
|
|
Error response codes:404,405,202,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- os-force_delete: os-force_delete
|
|
- tenant_id: tenant_id
|
|
- backup_id: backup_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ./samples/backup-force-delete-request.json
|
|
:language: javascript
|