openstack/cinder
Code Issues Proposed changes
88011280e8
cinder/api-ref/source/v2/ext-backups-actions-v2.inc

71 lines
1.4 KiB
PHP
Raw Normal View History

WADL to RST migration in cinder tree 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
2016-05-13 00:33:12 +05:30
.. -*- rst -*-
Backup actions (backups, action)
================================
Api-ref: add documentation for v2/v3 backup 'os-reset_status' action There is no document about v2/v3 backup 'os-reset_status' action. This action explicitly updates the backup state. So add the missing content. Change-Id: Ie0dd2b4e184d09e957c4ba296544f5019d05fda3 Partial-Bug: #1607539
2017-06-26 15:18:09 +08:00
Force-deletes a backup and reset status for a backup.
WADL to RST migration in cinder tree 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
2016-05-13 00:33:12 +05:30
Force-delete backup
Fix Block Storage API reference nesting Modifies heading levels in .inc files to allow nested display in table of contents. Table of contents depth has been changed to allow this. Change-Id: I3d8c9cf38a12272f0d32d3aa183d741277767535
2017-02-02 15:56:50 -06:00
~~~~~~~~~~~~~~~~~~~
WADL to RST migration in cinder tree 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
2016-05-13 00:33:12 +05:30
.. 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.
Api-ref: add documentation for v2/v3 backup 'os-reset_status' action There is no document about v2/v3 backup 'os-reset_status' action. This action explicitly updates the backup state. So add the missing content. Change-Id: Ie0dd2b4e184d09e957c4ba296544f5019d05fda3 Partial-Bug: #1607539
2017-06-26 15:18:09 +08:00
Normal response codes: 202
api-ref: Normalize response codes We had a mix of formatting for our API response codes. This makes it so all have a leading space, no trailing comma, and no empty Error response labels. This also addresses a formatting issue with due to the spacing between the Normal and Error lines that was causing the two to run together in the formatted HTML, making it harder to read. Change-Id: Ic411ee9f671c48ce60bda21984dafe55135685ba
2017-09-03 18:13:01 -05:00
Api-ref: add documentation for v2/v3 backup 'os-reset_status' action There is no document about v2/v3 backup 'os-reset_status' action. This action explicitly updates the backup state. So add the missing content. Change-Id: Ie0dd2b4e184d09e957c4ba296544f5019d05fda3 Partial-Bug: #1607539
2017-06-26 15:18:09 +08:00
Error response codes: itemNotFound(404), badMethod(405)
WADL to RST migration in cinder tree 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
2016-05-13 00:33:12 +05:30
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
Api-ref: add documentation for v2/v3 backup 'os-reset_status' action There is no document about v2/v3 backup 'os-reset_status' action. This action explicitly updates the backup state. So add the missing content. Change-Id: Ie0dd2b4e184d09e957c4ba296544f5019d05fda3 Partial-Bug: #1607539
2017-06-26 15:18:09 +08:00
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
api-ref: Normalize response codes We had a mix of formatting for our API response codes. This makes it so all have a leading space, no trailing comma, and no empty Error response labels. This also addresses a formatting issue with due to the spacing between the Normal and Error lines that was causing the two to run together in the formatted HTML, making it harder to read. Change-Id: Ic411ee9f671c48ce60bda21984dafe55135685ba
2017-09-03 18:13:01 -05:00
Api-ref: add documentation for v2/v3 backup 'os-reset_status' action There is no document about v2/v3 backup 'os-reset_status' action. This action explicitly updates the backup state. So add the missing content. Change-Id: Ie0dd2b4e184d09e957c4ba296544f5019d05fda3 Partial-Bug: #1607539
2017-06-26 15:18:09 +08:00
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
Copy Permalink