Fix discrepancy in api-ref for volume_types APIs

In the api ref document, for create volume_types 'extra_specs'
parameter is missing. And for parameter 'is_public', in code it
is used as 'os-volume-type-access:is_public'. For update volume_types
api as per api ref, 'name' and 'extra_specs' parameters are mandatory.
But in code 'name' is optional and 'extra_specs' implementation is not
done.

This patch fixes this discrepancy by updating the api-ref according to
the code.

Change-Id: I7faa711fc72cd81676812017a92ef40273f1bf7c
This commit is contained in:
Neha Alhat 2017-12-05 10:04:39 +05:30
parent 48cd5e44a6
commit 029767c0f2
4 changed files with 15 additions and 9 deletions

View File

@ -1036,7 +1036,7 @@ extra_specs_1:
include capabilities, capacity, compression, and so on, depending
on the storage driver in use.
in: body
required: true
required: false
type: object
fail_reason:
description: |
@ -1820,6 +1820,12 @@ name_9:
in: body
required: true
type: string
name_10:
description: |
The name of the volume type.
in: body
required: false
type: string
name_optional:
description: |
The name of the Volume Backup.

View File

@ -2,6 +2,9 @@
"volume_type": {
"name": "vol-type-001",
"description": "volume type 0001",
"is_public": true,
"os-volume-type-access:is_public": true,
"extra_specs": {
"capabilities": "gpu"
}
}
}

View File

@ -2,9 +2,6 @@
"volume_type": {
"name": "vol-type-001",
"description": "volume type 0001",
"is_public": true,
"extra_specs": {
"capabilities": "gpu"
}
"is_public": true
}
}

View File

@ -36,10 +36,9 @@ Request
- project_id: project_id_path
- volume_type_id: volume_type_id
- volume_type: volume_type_1
- name: name_7
- name: name_10
- description: description_15
- is_public: is_public
- extra_specs: extra_specs
Request Example
---------------
@ -355,8 +354,9 @@ Request
- volume_type: volume_type_1
- project_id: project_id_path
- name: name_7
- is_public: is_public
- os-volume-type-access:is_public: is_public
- description: description_15
- extra_specs: extra_specs_1
Request Example
---------------