From 9448e6e372030981ac6611f0e9de584ca56eee2b Mon Sep 17 00:00:00 2001 From: junboli Date: Wed, 6 Jun 2018 18:30:58 +0800 Subject: [PATCH] Api-ref: Fix the incorrect parameter description 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 --- api-ref/source/v3/attachments.inc | 10 +++++----- api-ref/source/v3/parameters.yaml | 6 +++--- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/api-ref/source/v3/attachments.inc b/api-ref/source/v3/attachments.inc index fdc24630d17..06dbfcf44a4 100644 --- a/api-ref/source/v3/attachments.inc +++ b/api-ref/source/v3/attachments.inc @@ -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 diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml index 7321023b490..fabf367423a 100644 --- a/api-ref/source/v3/parameters.yaml +++ b/api-ref/source/v3/parameters.yaml @@ -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: |