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

2017-05-19 15:55:39 +00:00 · 2017-05-19 15:55:39 +00:00 · e3a5ca62d1
commit e3a5ca62d1
parent 1ebeebaf99 238a16a8a6
4 changed files with 61 additions and 0 deletions
--- a/api-ref/source/v2/samples/volume-force-delete-request.json
+++ b/api-ref/source/v2/samples/volume-force-delete-request.json
@ -0,0 +1,3 @@
+{
+   "os-force_delete": {}
+}
--- a/api-ref/source/v2/volumes-v2-volumes-actions.inc
+++ b/api-ref/source/v2/volumes-v2-volumes-actions.inc
@ -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
+
+
--- a/api-ref/source/v3/samples/volume-force-delete-request.json
+++ b/api-ref/source/v3/samples/volume-force-delete-request.json
@ -0,0 +1,3 @@
+{
+   "os-force_delete": {}
+}
--- a/api-ref/source/v3/volumes-v3-volumes-actions.inc
+++ b/api-ref/source/v3/volumes-v3-volumes-actions.inc
@ -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
+