Add API documentation for force-delete volume in v2 and v3.

There is no API doc found for force-delete volume in cinder.
We need to add the API doc for the operation with its description,
request and response parameters.

Change-Id: Id25b4070a3946d2d7d89f44bdc81039286a5d8fe
Closes-bug: #1673644
This commit is contained in:
liuyamin 2017-05-19 15:06:50 +08:00
parent 8eac91d8e9
commit 238a16a8a6
4 changed files with 61 additions and 0 deletions

View File

@ -0,0 +1,3 @@
{
"os-force_delete": {}
}

View File

@ -341,3 +341,31 @@ Request Example
Force delete volume
~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action
Attempts force-delete of volume, regardless of state. Specify the ``os-force_delete`` action
in the request body.
Normal response codes: 202
Request
-------
.. rest_parameters:: parameters.yaml
- os-force_delete: os-force_delete
- tenant_id: tenant_id
- volume_id: volume_id_path
Request Example
---------------
.. literalinclude:: ./samples/volume-force-delete-request.json
:language: javascript

View File

@ -0,0 +1,3 @@
{
"os-force_delete": {}
}

View File

@ -338,3 +338,30 @@ Request Example
Force delete a volume
~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action
Attempts force-delete of volume, regardless of state. Specify the ``os-force_delete`` action
in the request body.
Normal response codes: 202
Request
-------
.. rest_parameters:: parameters.yaml
- os-force_delete: os-force_delete
- project_id: project_id_path
- volume_id: volume_id_path
Request Example
---------------
.. literalinclude:: ./samples/volume-force-delete-request.json
:language: javascript