From 589a74de2b36716a5c2398c76e819dbf567181e4 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Mon, 30 Sep 2019 16:32:21 -0400 Subject: [PATCH] api-ref: give an example of volume['attachments'] The API samples for GET /v3/{project_id}/volumes/detail and GET /v3/{project_id}/volumes/{volume_id} have an empty attachments field value and the parameter description does not give the actual keys in the attachments list of dicts. This change gives an example of what the volume attachments entry would look like with the actual keys the caller should expect. Change-Id: Ib3d7d54941ee98434297683a94d76fdab7788dee --- api-ref/source/v3/parameters.yaml | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml index eccd50f780d..616bcdd4321 100644 --- a/api-ref/source/v3/parameters.yaml +++ b/api-ref/source/v3/parameters.yaml @@ -549,7 +549,19 @@ attachments: is attached to a server instance, the attachments list includes the UUID of the attached server, an attachment UUID, the name of the attached host, if any, the volume UUID, the device, and the - device UUID. Otherwise, this list is empty. + device UUID. Otherwise, this list is empty. For example:: + + [ + { + 'server_id': '6c8cf6e0-4c8f-442f-9196-9679737feec6', + 'attachment_id': '3dafcac4-1cb9-4b60-a227-d729baa10cf6', + 'attached_at': '2019-09-30T19:30:34.000000', + 'host_name': null, + 'volume_id': '5d95d5ee-4bdd-4452-b9d7-d44ca10d3d53', + 'device': '/dev/vda', + 'id': '5d95d5ee-4bdd-4452-b9d7-d44ca10d3d53' + } + ] in: body required: true type: array