openstack/cinder
Code Issues Proposed changes

Fix api-ref status parameter

Browse Source 
In the api ref most of our references to the status parameter are wrong,
since they are all referencing `status`, which in most cases is:

 status:
   description: |
     The ``status`` of the consistency group snapshot.

This patch fixes this by referencing the right status parameter.

TrivialFix

Change-Id: I3f76ad10bacd8c75f742efc3ff3395a7effc31b5
This commit is contained in:
Gorka Eguileor
2017-01-26 13:27:20 +01:00
parent a53068f23c
commit bc7c001d76
13 changed files with 49 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
api-ref/source/v2/consistencygroups-v2.inc
View File

@@ -123,7 +123,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_1
- description: description
- availability_zone: availability_zone
- created_at: created_at
@@ -153,7 +153,7 @@ Request
.. rest_parameters:: parameters.yaml
- status: status
- status: status_1
- user_id: user_id
- description: description
- cgsnapshot_id: cgsnapshot_id
@@ -224,7 +224,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_1
- description: description
- availability_zone: availability_zone
- created_at: created_at

4
api-ref/source/v2/ext-backups.inc
View File

@@ -67,7 +67,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_4
- object_count: object_count
- fail_reason: fail_reason
- description: description
@@ -117,7 +117,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_4
- object_count: object_count
- container: container
- description: description

12
api-ref/source/v2/volumes-v2-snapshots.inc
View File

@@ -52,7 +52,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_2
- os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress
- description: description
- created_at: created_at
@@ -103,7 +103,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_2
- description: description
- created_at: created_at
- name: name
@@ -143,7 +143,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_2
- description: description
- created_at: created_at
- name: name
@@ -185,7 +185,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_2
- os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress
- description: description
- created_at: created_at
@@ -268,7 +268,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_2
- os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress
- description: description
- created_at: created_at
@@ -323,7 +323,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_2
- description: description
- created_at: created_at
- name: name

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

@@ -73,7 +73,7 @@ Request
.. rest_parameters:: parameters.yaml
- status: status
- status: status_3
- migration_status: migration_status
- os-reset_status: os-reset_status
- attach_status: attach_status

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

@@ -88,7 +88,7 @@ Response Parameters
- os-vol-tenant-attr:tenant_id: os-vol-tenant-attr:tenant_id
- os-vol-mig-status-attr:migstat: os-vol-mig-status-attr:migstat
- metadata: metadata
- status: status
- status: status_3
- description: description
- multiattach: multiattach
- source_volid: source_volid
@@ -197,7 +197,7 @@ Response Parameters
- size: size
- user_id: user_id
- metadata: metadata
- status: status
- status: status_3
- description: description
- multiattach: multiattach
- source_volid: source_volid
@@ -302,7 +302,7 @@ Response Parameters
- os-vol-tenant-attr:tenant_id: os-vol-tenant-attr:tenant_id
- os-vol-mig-status-attr:migstat: os-vol-mig-status-attr:migstat
- metadata: metadata
- status: status
- status: status_3
- description: description
- multiattach: multiattach
- source_volid: source_volid
@@ -375,7 +375,7 @@ Response Parameters
- size: size
- user_id: user_id
- metadata: metadata
- status: status
- status: status_3
- description: description
- multiattach: multiattach
- source_volid: source_volid

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

@@ -123,7 +123,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_1
- description: description
- availability_zone: availability_zone
- created_at: created_at
@@ -153,7 +153,7 @@ Request
.. rest_parameters:: parameters.yaml
- status: status
- status: status_1
- user_id: user_id
- description: description
- cgsnapshot_id: cgsnapshot_id
@@ -224,7 +224,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_1
- description: description
- availability_zone: availability_zone
- created_at: created_at

4
api-ref/source/v3/ext-backups.inc
View File

@@ -67,7 +67,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_4
- object_count: object_count
- fail_reason: fail_reason
- description: description
@@ -117,7 +117,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_4
- object_count: object_count
- container: container
- description: description

6
api-ref/source/v3/group-snapshots.inc
View File

@@ -54,7 +54,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_7
- description: description
- created_at: created_at
- group_id: group_id
@@ -92,7 +92,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_7
- description: description
- created_at: created_at
- group_id: group_id
@@ -173,7 +173,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_7
- description: description
- created_at: created_at
- group_id: group_id

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

@@ -110,7 +110,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_8
- description: description
- availability_zone: availability_zone
- created_at: created_at
@@ -211,7 +211,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_8
- description: description
- availability_zone: availability_zone
- created_at: created_at

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

@@ -1582,6 +1582,18 @@ status_6:
in: body
required: false
type: string
status_7:
description: |
The ``status`` of the generic group snapshot.
in: body
required: false
type: string
status_8:
description: |
The status of the generic group.
in: body
required: true
type: string
storage_protocol:
description: |
The storage back end for the back-end volume. For

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

@@ -52,7 +52,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_2
- os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress
- description: description
- created_at: created_at
@@ -103,7 +103,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_2
- description: description
- created_at: created_at
- name: name
@@ -143,7 +143,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_2
- description: description
- created_at: created_at
- name: name
@@ -185,7 +185,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_2
- os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress
- description: description
- created_at: created_at
@@ -268,7 +268,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_2
- os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress
- description: description
- created_at: created_at
@@ -323,7 +323,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status
- status: status_2
- description: description
- created_at: created_at
- name: name

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

@@ -73,7 +73,7 @@ Request
.. rest_parameters:: parameters.yaml
- status: status
- status: status_3
- migration_status: migration_status
- os-reset_status: os-reset_status
- attach_status: attach_status

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

@@ -88,7 +88,7 @@ Response Parameters
- os-vol-tenant-attr:tenant_id: os-vol-tenant-attr:tenant_id
- os-vol-mig-status-attr:migstat: os-vol-mig-status-attr:migstat
- metadata: metadata
- status: status
- status: status_3
- description: description
- multiattach: multiattach
- source_volid: source_volid
@@ -197,7 +197,7 @@ Response Parameters
- size: size
- user_id: user_id
- metadata: metadata
- status: status
- status: status_3
- description: description
- multiattach: multiattach
- source_volid: source_volid
@@ -302,7 +302,7 @@ Response Parameters
- os-vol-tenant-attr:tenant_id: os-vol-tenant-attr:tenant_id
- os-vol-mig-status-attr:migstat: os-vol-mig-status-attr:migstat
- metadata: metadata
- status: status
- status: status_3
- description: description
- multiattach: multiattach
- source_volid: source_volid
@@ -375,7 +375,7 @@ Response Parameters
- size: size
- user_id: user_id
- metadata: metadata
- status: status
- status: status_3
- description: description
- multiattach: multiattach
- source_volid: source_volid