openstack/cinder
Code Issues Proposed changes

Api-ref: fix parameter 'volume_id' info

Browse Source 
In Volumes (volumes) v2/v3 API methods, the request parameter
'volume_id' should be a 'path' param in request param table,
not a 'body' param.

Closes-bug: #1691989
Change-Id: If931d05504d4f050e7da4f4df6f8d49d4318c95d
This commit is contained in:
lihaijing 2017-06-07 12:21:13 +08:00
parent 9151ea2719
commit 5ee69ae2f0
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -293,7 +293,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- tenant_id: tenant_id - tenant_id: tenant_id
- volume_id: volume_id - volume_id: volume_id_path
Response Parameters Response Parameters
@ -363,7 +363,7 @@ Request
- name: name - name: name
- metadata: metadata_2 - metadata: metadata_2
- tenant_id: tenant_id - tenant_id: tenant_id
- volume_id: volume_id - volume_id: volume_id_path
Request Example Request Example
--------------- ---------------
@ -453,7 +453,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- tenant_id: tenant_id - tenant_id: tenant_id
- volume_id: volume_id - volume_id: volume_id_path
- cascade: cascade - cascade: cascade
@ -479,7 +479,7 @@ Request
- metadata: metadata_3 - metadata: metadata_3
- tenant_id: tenant_id - tenant_id: tenant_id
- volume_id: volume_id - volume_id: volume_id_path
Request Example Request Example
--------------- ---------------
@ -523,7 +523,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- tenant_id: tenant_id - tenant_id: tenant_id
- volume_id: volume_id - volume_id: volume_id_path
Response Parameters Response Parameters
@ -563,7 +563,7 @@ Request
- metadata: metadata_3 - metadata: metadata_3
- tenant_id: tenant_id - tenant_id: tenant_id
- volume_id: volume_id - volume_id: volume_id_path
Request Example Request Example
--------------- ---------------

12
api-ref/source/v3/volumes-v3-volumes.inc
View File

@ -301,7 +301,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id - volume_id: volume_id_path
Response Parameters Response Parameters
@ -371,7 +371,7 @@ Request
- name: name - name: name
- metadata: metadata - metadata: metadata
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id - volume_id: volume_id_path
Request Example Request Example
--------------- ---------------
@ -461,7 +461,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id - volume_id: volume_id_path
- cascade: cascade - cascade: cascade
@ -487,7 +487,7 @@ Request
- metadata: metadata_3 - metadata: metadata_3
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id - volume_id: volume_id_path
Request Example Request Example
--------------- ---------------
@ -532,7 +532,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id - volume_id: volume_id_path
Response Parameters Response Parameters
@ -572,7 +572,7 @@ Request
- metadata: metadata_3 - metadata: metadata_3
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id - volume_id: volume_id_path
Request Example Request Example
--------------- ---------------