openstack/cinder
Code Issues Proposed changes

api-ref: Fix volume_id parameter for the path

Browse Source 
When the volume_id is in the path for an API, it is
required. This fixes the volume_id_1 parameter for the
path argument by making it required and also renaming
it to be more clear of what it's used for. And finally,
this fixes the os-attach parameter to indicate volume_id
is in the path and is required, not optional.

Change-Id: I0e8868d35b5ea06ef809c896f943d92ad8e71e3e
This commit is contained in:
Matt Riedemann 2017-03-23 12:59:07 -04:00
parent 6b04a764cb
commit b3400efd96
6 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
api-ref/source/v2/parameters.yaml
View File

@ -90,11 +90,11 @@ user_id_1:
in: path
required: false
type: string
volume_id_1:
volume_id_path:
description: |
The UUID of the volume.
in: path
required: false
required: true
type: string
volume_type:
description: |

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

@ -181,7 +181,7 @@ Request
- host_name: host_name
- os-attach: os-attach
- tenant_id: tenant_id
- volume_id: volume_id
- volume_id: volume_id_path
Request Example
---------------
@ -217,7 +217,7 @@ Request
- attachment_id: attachment_id
- os-detach: os-detach
- tenant_id: tenant_id
- volume_id: volume_id_1
- volume_id: volume_id_path
Request Example
---------------

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

@ -591,7 +591,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- volume_id: volume_id_1
- volume_id: volume_id_path
- key: key_2
@ -629,5 +629,5 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- volume_id: volume_id_1
- volume_id: volume_id_path
- key: key_1

4
api-ref/source/v3/parameters.yaml
View File

@ -120,11 +120,11 @@ user_id_1:
in: path
required: false
type: string
volume_id_1:
volume_id_path:
description: |
The UUID of the volume.
in: path
required: false
required: true
type: string
volume_type:
description: |

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

@ -181,7 +181,7 @@ Request
- host_name: host_name
- os-attach: os-attach
- project_id: project_id_path
- volume_id: volume_id
- volume_id: volume_id_path
Request Example
---------------

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

@ -595,7 +595,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- volume_id: volume_id_1
- volume_id: volume_id_path
- key: key_2
@ -632,7 +632,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- volume_id: volume_id_1
- volume_id: volume_id_path
- key: key_1