From 6ee0da7e5bffcfa70bfae60d60345c42fbc881b9 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Tue, 22 Oct 2019 15:22:28 -0400 Subject: [PATCH] api-ref: mark device response param as optional for list/show vol attachments The 'device' response parameter is not included in GET /servers/{server_id}/os-volume_attachments or GET /servers/{server_id}/os-volume_attachments/{volume_id} when the BDM doesn't have a device_name set, which can be the case with a volume attached to a shelved offloaded server. Also, see the logic in _translate_attachment_detail_view and _translate_attachment_summary_view. This simply marks the response parameter as optional in those APIs. Since the parameter is optional, it is sorted to after the required parameters but before the parameters added in new microversions. Change-Id: Ifda2f7983f349d51d97e5621cac6c5ad9cb0295f Closes-Bug: #1818345 --- api-ref/source/os-volume-attachments.inc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api-ref/source/os-volume-attachments.inc b/api-ref/source/os-volume-attachments.inc index 68db210c2bd4..d93167893bb0 100644 --- a/api-ref/source/os-volume-attachments.inc +++ b/api-ref/source/os-volume-attachments.inc @@ -34,10 +34,10 @@ Response .. rest_parameters:: parameters.yaml - volumeAttachments: volumeAttachments - - device: device_resp - id: attachment_id_required - serverId: server_id - volumeId: volumeId_resp + - device: attachment_device_resp - tag: device_tag_bdm_attachment_resp - delete_on_termination: delete_on_termination_attachments_resp @@ -150,10 +150,10 @@ Response .. rest_parameters:: parameters.yaml - volumeAttachment: volumeAttachment - - device: device_resp - id: attachment_id_required - serverId: server_id - volumeId: volumeId_resp + - device: attachment_device_resp - tag: device_tag_bdm_attachment_resp - delete_on_termination: delete_on_termination_attachments_resp