api-ref: Fix volume_id parameter for the path
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:
@@ -90,11 +90,11 @@ user_id_1:
|
|||||||
in: path
|
in: path
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
volume_id_1:
|
volume_id_path:
|
||||||
description: |
|
description: |
|
||||||
The UUID of the volume.
|
The UUID of the volume.
|
||||||
in: path
|
in: path
|
||||||
required: false
|
required: true
|
||||||
type: string
|
type: string
|
||||||
volume_type:
|
volume_type:
|
||||||
description: |
|
description: |
|
||||||
|
@@ -181,7 +181,7 @@ Request
|
|||||||
- host_name: host_name
|
- host_name: host_name
|
||||||
- os-attach: os-attach
|
- os-attach: os-attach
|
||||||
- tenant_id: tenant_id
|
- tenant_id: tenant_id
|
||||||
- volume_id: volume_id
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
@@ -217,7 +217,7 @@ Request
|
|||||||
- attachment_id: attachment_id
|
- attachment_id: attachment_id
|
||||||
- os-detach: os-detach
|
- os-detach: os-detach
|
||||||
- tenant_id: tenant_id
|
- tenant_id: tenant_id
|
||||||
- volume_id: volume_id_1
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
@@ -591,7 +591,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- tenant_id: tenant_id
|
||||||
- volume_id: volume_id_1
|
- volume_id: volume_id_path
|
||||||
- key: key_2
|
- key: key_2
|
||||||
|
|
||||||
|
|
||||||
@@ -629,5 +629,5 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- tenant_id: tenant_id
|
||||||
- volume_id: volume_id_1
|
- volume_id: volume_id_path
|
||||||
- key: key_1
|
- key: key_1
|
||||||
|
@@ -120,11 +120,11 @@ user_id_1:
|
|||||||
in: path
|
in: path
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
volume_id_1:
|
volume_id_path:
|
||||||
description: |
|
description: |
|
||||||
The UUID of the volume.
|
The UUID of the volume.
|
||||||
in: path
|
in: path
|
||||||
required: false
|
required: true
|
||||||
type: string
|
type: string
|
||||||
volume_type:
|
volume_type:
|
||||||
description: |
|
description: |
|
||||||
|
@@ -181,7 +181,7 @@ Request
|
|||||||
- host_name: host_name
|
- host_name: host_name
|
||||||
- os-attach: os-attach
|
- os-attach: os-attach
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
@@ -595,7 +595,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_1
|
- volume_id: volume_id_path
|
||||||
- key: key_2
|
- key: key_2
|
||||||
|
|
||||||
|
|
||||||
@@ -632,7 +632,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_1
|
- volume_id: volume_id_path
|
||||||
- key: key_1
|
- key: key_1
|
||||||
|
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user