openstack/cinder
Code Issues Proposed changes

Api-ref: Fix the incorrect parameter description

Browse Source 
In the attachment API, the response parameters, such as ``detached_at``,
``attached_at``, ``attach_mode``, ``instance`` are optional, however these
should be required, this is to fix these.

Change-Id: I2748e971655c3f5715585409e5c021f0d91690e4
This commit is contained in:
junboli 2018-06-06 18:30:58 +08:00
parent 9d263f711d
commit 9448e6e372
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -106,7 +106,7 @@ Response Parameters
- connection_info: connection_info
- attached_at: attached_at
- attach_mode: attach_mode
- instance: instance_uuid
- instance: instance_uuid_1
- volume_id: volume_id_7
- id: attachment_id_2
@ -161,7 +161,7 @@ Response Parameters
- connection_info: connection_info
- attached_at: attached_at
- attach_mode: attach_mode
- instance: instance_uuid
- instance: instance_uuid_1
- volume_id: volume_id_7
- id: attachment_id_2
@ -212,7 +212,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status_9
- instance: instance_uuid
- instance: instance_uuid_1
- volume_id: volume_id_7
- id: attachment_id_2
@ -274,7 +274,7 @@ Response Parameters
- connection_info: connection_info
- attached_at: attached_at
- attach_mode: attach_mode
- instance: instance_uuid
- instance: instance_uuid_1
- volume_id: volume_id_7
- id: attachment_id_2
@ -334,7 +334,7 @@ Response Parameters
- connection_info: connection_info
- attached_at: attached_at
- attach_mode: attach_mode
- instance: instance_uuid
- instance: instance_uuid_1
- volume_id: volume_id_7
- id: attachment_id_2

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

@ -441,7 +441,7 @@ attach_mode:
The attach mode of attachment, read-only ('ro') or
read-and-write ('rw'), default is 'rw'.
in: body
required: false
required: true
type: string
attach_status:
description: |
@ -453,7 +453,7 @@ attached_at:
description: |
The time when attachment is attached.
in: body
required: false
required: true
type: string
attachment:
description: |
@ -970,7 +970,7 @@ detached_at:
description: |
The time when attachment is detached.
in: body
required: false
required: true
type: string
disabled:
description: |