openstack
/
cinder
Code Issues Proposed changes

Merge "Fix incorrect description in api ref"

This commit is contained in:
Zuul 2017-12-29 00:44:20 +00:00 committed by Gerrit Code Review
parent 0dfe26addd 03d4539247
commit 82ef221114
10 changed files with 57 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-ref/source/v3/capabilities-v3.inc
View File

@ -30,7 +30,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- pool_name: pool_name
- description: description
- description: description_10
- volume_backend_name: volume_backend_name
- namespace: namespace
- visibility: visibility

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

@ -69,7 +69,7 @@ Request
- project_id: project_id_path
- consistencygroup: consistencygroup
- description: description_6
- description: description_11
- availability_zone: availability_zone
- volume_types: volume_types_2
- name: name_15
@ -87,7 +87,7 @@ Response
- consistencygroup: consistencygroup
- status: status_1
- description: description_11
- description: description_6
- availability_zone: availability_zone
- created_at: created_at
- volume_types: volume_types
@ -123,7 +123,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status_1
- description: description
- description: description_6
- availability_zone: availability_zone
- created_at: created_at
- volume_types: volume_types
@ -156,7 +156,7 @@ Request
- consistencygroup-from-src: consistencygroup-from-src
- status: status_1
- user_id: user_id
- description: description
- description: description_11
- cgsnapshot_id: cgsnapshot_id
- source_cgid: source_cgid
- project_id: project_id
@ -225,7 +225,7 @@ Response Parameters
- consistencygroups: consistencygroups
- status: status_1
- description: description
- description: description_6
- availability_zone: availability_zone
- created_at: created_at
- volume_types: volume_types
@ -258,7 +258,7 @@ Request
- consistencygroup_id: consistencygroup_id_2
- consistencygroup: consistencygroup
- remove_volumes: remove_volumes
- description: description
- description: description_11
- add_volumes: add_volumes
- name: name

10
api-ref/source/v3/groups.inc
View File

@ -78,7 +78,7 @@ Request
- project_id: project_id_path
- group: group
- description: description
- description: description_group_false
- availability_zone: availability_zone
- group_type: group_type
- volume_types: volume_types
@ -117,7 +117,7 @@ Response Parameters
- group: group
- status: status_8
- description: description
- description: description_group_true
- availability_zone: availability_zone
- created_at: created_at
- group_type: group_type
@ -152,7 +152,7 @@ Request
- project_id: project_id_path
- create-from-src: create-from-src
- description: description
- description: description_group_false
- group_snapshot_id: group_snapshot_id_1
- source_group_id: source_group_id
- name: group_name
@ -226,7 +226,7 @@ Response Parameters
- groups: groups
- status: status_8
- description: description
- description: description_group_true
- availability_zone: availability_zone
- created_at: created_at
- group_type: group_type
@ -262,7 +262,7 @@ Request
- group_id: group_id
- group: group
- remove_volumes: remove_volumes
- description: description
- description: description_group_false
- add_volumes: add_volumes
- name: group_name

8
api-ref/source/v3/os-cgsnapshots-v3.inc
View File

@ -53,7 +53,7 @@ Response Parameters
- cgsnapshot: cgsnapshot
- status: status
- description: description
- description: description_cg_snapshot_true
- created_at: created_at
- consistencygroup_id: consistencygroup_id
- id: id
@ -91,7 +91,7 @@ Response Parameters
- cgsnapshots: cgsnapshots
- status: status
- description: description
- description: description_cg_snapshot_true
- created_at: created_at
- consistencygroup_id: consistencygroup_id
- id: id
@ -160,7 +160,7 @@ Request
- cgsnapshot: cgsnapshot
- name: name_5
- consistencygroup_id: consistencygroup_id
- description: description
- description: description_cg_snapshot_false
Request Example
---------------
@ -174,7 +174,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- description: description
- description: description_cg_snapshot_true
- created_at: created_at
- consistencygroup_id: consistencygroup_id
- id: id

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

@ -861,12 +861,6 @@ description:
in: body
required: false
type: string
description_1:
description: |
The consistency group snapshot description.
in: body
required: true
type: string
description_10:
description: |
The capabilities description.
@ -909,18 +903,6 @@ description_16:
in: body
required: true
type: string
description_2:
description: |
The description of the consistency group.
in: body
required: false
type: string
description_3:
description: |
The description of the consistency group.
in: body
required: true
type: string
description_4:
description: |
A description for the snapshot. Default is
@ -958,6 +940,30 @@ description_9:
in: body
required: true
type: string
description_cg_snapshot_false:
description: |
The consistency group snapshot description.
in: body
required: false
type: string
description_cg_snapshot_true:
description: |
The consistency group snapshot description.
in: body
required: true
type: string
description_group_false:
description: |
The group description.
in: body
required: false
type: string
description_group_true:
description: |
The group description.
in: body
required: true
type: string
detached_at:
description: |
The time when attachment is detached.

2
api-ref/source/v3/snapshot-manage.inc
View File

@ -35,7 +35,7 @@ Request
- project_id: project_id_path
- snapshot: snapshot_1
- description: description
- description: description_4
- metadata: metadata_7
- name: name_5
- ref: ref

2
api-ref/source/v3/volume-manage.inc
View File

@ -38,7 +38,7 @@ Request
- project_id: project_id_path
- volume: volume
- description: description
- description: description_5
- availability_zone: availability_zone
- bootable: bootable_1
- volume_type: volume_type

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

@ -33,7 +33,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- updated: updated
- description: description
- description: description_7
- links: links
- namespace: namespace
- alias: alias

16
api-ref/source/v3/volumes-v3-snapshots.inc
View File

@ -69,7 +69,7 @@ Response Parameters
- status: status_2
- os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress
- description: description
- description: description_8
- created_at: created_at
- name: name
- user_id: user_id_2
@ -107,7 +107,7 @@ Request
- snapshot: snapshot_1
- volume_id: volume_id
- name: name_12
- description: description
- description: description_4
- force: force
- metadata: metadata_7
@ -123,7 +123,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status_2
- description: description
- description: description_8
- created_at: created_at
- name: name_12
- snapshot: snapshot_1
@ -175,7 +175,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status_2
- description: description
- description: description_8
- created_at: created_at
- name: name
- user_id: user_id_2
@ -219,7 +219,7 @@ Response Parameters
- status: status_2
- os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress
- description: description
- description: description_8
- created_at: created_at
- name: name
- snapshot: snapshot_1
@ -346,7 +346,7 @@ Response Parameters
- status: status_2
- os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress
- description: description
- description: description_8
- created_at: created_at
- name: name
- snapshot: snapshot_1
@ -383,7 +383,7 @@ Request
- project_id: project_id_path
- snapshot_id: snapshot_id_path
- snapshot: snapshot_1
- description: description
- description: description_4
- name: name
Request Example
@ -400,7 +400,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status_2
- description: description
- description: description_8
- created_at: created_at
- name: name
- snapshot: snapshot_1

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

@ -112,7 +112,7 @@ Response Parameters
- metadata: metadata
- status: status_3
- volume_image_metadata: volume_image_metadata
- description: description
- description: description_9
- multiattach: multiattach
- source_volid: source_volid
- consistencygroup_id: consistencygroup_id
@ -185,7 +185,7 @@ Request
- size: size
- availability_zone: availability_zone
- source_volid: source_volid
- description: description
- description: description_5
- multiattach: multiattach
- snapshot_id: snapshot_id
- backup_id: backup_id_1
@ -222,7 +222,7 @@ Response Parameters
- user_id: user_id
- metadata: metadata
- status: status_3
- description: description
- description: description_9
- multiattach: multiattach
- source_volid: source_volid
- volume: volume
@ -336,7 +336,7 @@ Response Parameters
- metadata: metadata
- status: status_3
- volume_image_metadata: volume_image_metadata
- description: description
- description: description_9
- multiattach: multiattach
- source_volid: source_volid
- volume: volume
@ -378,7 +378,7 @@ Request
- project_id: project_id_path
- volume_id: volume_id_path
- volume: volume
- description: description
- description: description_5
- name: name_8
- metadata: metadata
@ -408,7 +408,7 @@ Response Parameters
- user_id: user_id
- metadata: metadata
- status: status_3
- description: description
- description: description_9
- multiattach: multiattach
- source_volid: source_volid
- volume: volume
@ -475,10 +475,6 @@ Request
- force: force_5
Create metadata for volume
~~~~~~~~~~~~~~~~~~~~~~~~~~