api-ref: Fix some params in volume types

This patch adds some missing params in volume types
and volume type access APIs. Also trivial fix for
the order of the params in the URL.

Change-Id: I767f68b4252a3b70755494cf82ca3b284112be75
This commit is contained in:
Dongcan Ye 2018-06-06 13:02:08 +00:00
parent 9d263f711d
commit e3f24ed15e
3 changed files with 46 additions and 18 deletions

View File

@ -176,12 +176,6 @@ volume_id_path:
in: path
required: true
type: string
volume_type_access:
description: |
The ID of Volume Type to be accessed by project.
in: path
required: true
type: string
volume_type_id:
description: |
The UUID for an existing volume type.
@ -415,6 +409,12 @@ active_backend_id:
in: body
required: false
type: string
add_project_access:
description: |
Adds volume type access to a project.
in: body
required: true
type: object
add_volumes:
description: |
One or more volume UUIDs, separated by commas, to
@ -2157,6 +2157,12 @@ qos_specs:
in: body
required: true
type: object
qos_specs_id:
description: |
The QoS specifications ID.
in: body
required: true
type: string
QoS_support:
description: |
The quality of service (QoS) support.
@ -2218,6 +2224,12 @@ reference:
in: body
required: true
type: object
remove_project_access:
description: |
Removes volume type access from a project.
in: body
required: true
type: object
remove_volumes:
description: |
One or more volume UUIDs, separated by commas, to
@ -2923,6 +2935,12 @@ volume_type_6:
in: body
required: true
type: string
volume_type_access:
description: |
The object contains volume type to be accessed by project.
in: body
required: true
type: object
volume_type_id_body:
description: |
The UUID of the volume type.

View File

@ -33,9 +33,10 @@ Request
.. rest_parameters:: parameters.yaml
- project: project
- project_id: project_id_path
- volume_type: volume_type_access
- volume_type: volume_type_id
- addProjectAccess: add_project_access
- project: project
Request Example
---------------
@ -64,9 +65,10 @@ Request
.. rest_parameters:: parameters.yaml
- project: project
- project_id: project_id_path
- volume_type: volume_type_access
- volume_type: volume_type_id
- removeProjectAccess: remove_project_access
- project: project
Request Example
---------------
@ -96,7 +98,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- volume_type: volume_type_access
- volume_type: volume_type_id
Response Parameters
@ -104,7 +106,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- volume_type_access: volume_type_access
- project_id: project_id
- volume_type_id: volume_type_id_body

View File

@ -267,8 +267,8 @@ Request
.. rest_parameters:: parameters.yaml
- volume_type_id: volume_type_id
- project_id: project_id_path
- volume_type_id: volume_type_id
Response Parameters
@ -281,6 +281,7 @@ Response Parameters
- extra_specs: extra_specs_volume_type_required
- description: description_volume_type_required
- name: name_volume_type_required
- id: volume_type_id_body
Response Example
@ -351,8 +352,8 @@ Request
.. rest_parameters:: parameters.yaml
- volume_type_id: volume_type_id
- project_id: project_id_path
- volume_type_id: volume_type_id
List all volume types
@ -390,6 +391,11 @@ Response Parameters
- volume_types: volume_types
- extra_specs: extra_specs_volume_type_required
- name: name_volume_type_required
- is_public: is_public_volume_type_required
- description: description_volume_type_required
- id: volume_type_id_body
- os-volume-type-access:is_public: is_public_volume_type_required
- qos_specs_id: qos_specs_id
Response Example
----------------
@ -418,8 +424,8 @@ Request
.. rest_parameters:: parameters.yaml
- volume_type: volume_type_1
- project_id: project_id_path
- volume_type: volume_type_1
- name: name_volume_type_required
- os-volume-type-access:is_public: is_public_volume_type_optional
- description: description_volume_type_optional
@ -472,8 +478,8 @@ Request
.. rest_parameters:: parameters.yaml
- volume_type_id: volume_type_id
- project_id: project_id_path
- volume_type_id: volume_type_id
Response Parameters
@ -551,8 +557,8 @@ Request
.. rest_parameters:: parameters.yaml
- volume_type_id: volume_type_id
- project_id: project_id_path
- volume_type_id: volume_type_id
- encryption_id: encryption_id
@ -576,8 +582,8 @@ Request
.. rest_parameters:: parameters.yaml
- volume_type_id: volume_type_id
- project_id: project_id_path
- volume_type_id: volume_type_id
- encryption: encryption
- key_size: key_size
- provider: provider
@ -631,8 +637,8 @@ Request
.. rest_parameters:: parameters.yaml
- volume_type_id: volume_type_id
- project_id: project_id_path
- volume_type_id: volume_type_id
- encryption_id: encryption_id
- encryption: encryption
- key_size: key_size