openstack/cinder
Code Issues Proposed changes

Fix incorrect volume_id request description in api-ref

Browse Source 
Now some API documents for volume actions like
extending volume(https://developer.openstack.org/api-ref/
block-storage/v3/?expanded=extend-a-volume-size-detail) are
using incorrect request argument description
'volume_id in body'.

It should be 'in path'.

Change-Id: I2006b4af4dfc09fb0403c1a78ecef4ac920a51c4
Closes-Bug: #1691358
This commit is contained in:
wanghao 2017-05-17 14:41:51 +08:00
parent ffe7d919d8
commit 7e17004018
2 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
api-ref/source/v2/volumes-v2-volumes-actions.inc
View File

@ -43,7 +43,7 @@ Request
- os-extend: os-extend
- new_size: new_size
- tenant_id: tenant_id
- volume_id: volume_id
- volume_id: volume_id_path
Request Example
---------------
@ -77,7 +77,7 @@ Request
- os-reset_status: os-reset_status
- attach_status: attach_status
- tenant_id: tenant_id
- volume_id: volume_id
- volume_id: volume_id_path
Request Example
---------------
@ -109,7 +109,7 @@ Request
- os-set_image_metadata: os-set_image_metadata
- metadata: metadata
- tenant_id: tenant_id
- volume_id: volume_id
- volume_id: volume_id_path
Request Example
---------------
@ -141,7 +141,7 @@ Request
- os-unset_image_metadata: os-unset_image_metadata
- key: key
- tenant_id: tenant_id
- volume_id: volume_id
- volume_id: volume_id_path
Request Example
---------------
@ -255,7 +255,7 @@ Request
- os-unmanage: os-unmanage
- tenant_id: tenant_id
- volume_id: volume_id
- volume_id: volume_id_path
Request Example
---------------
@ -291,7 +291,7 @@ Request
- attachment_id: attachment_id
- os-force_detach: os-force_detach
- tenant_id: tenant_id
- volume_id: volume_id
- volume_id: volume_id_path
Request Example
---------------

14
api-ref/source/v3/volumes-v3-volumes-actions.inc
View File

@ -43,7 +43,7 @@ Request
- os-extend: os-extend
- new_size: new_size
- project_id: project_id_path
- volume_id: volume_id
- volume_id: volume_id_path
Request Example
---------------
@ -77,7 +77,7 @@ Request
- os-reset_status: os-reset_status
- attach_status: attach_status
- project_id: project_id_path
- volume_id: volume_id
- volume_id: volume_id_path
Request Example
---------------
@ -109,7 +109,7 @@ Request
- os-set_image_metadata: os-set_image_metadata
- metadata: metadata
- project_id: project_id_path
- volume_id: volume_id
- volume_id: volume_id_path
Request Example
---------------
@ -141,7 +141,7 @@ Request
- os-unset_image_metadata: os-unset_image_metadata
- key: key
- project_id: project_id_path
- volume_id: volume_id
- volume_id: volume_id_path
Request Example
---------------
@ -217,7 +217,7 @@ Request
- attachment_id: attachment_id
- os-detach: os-detach
- project_id: project_id_path
- volume_id: volume_id
- volume_id: volume_id_path
Request Example
---------------
@ -252,7 +252,7 @@ Request
- os-unmanage: os-unmanage
- project_id: project_id_path
- volume_id: volume_id
- volume_id: volume_id_path
Request Example
---------------
@ -288,7 +288,7 @@ Request
- attachment_id: attachment_id
- os-force_detach: os-force_detach
- project_id: project_id_path
- volume_id: volume_id
- volume_id: volume_id_path
Request Example
---------------