From 77e42e2f3939131ae616457e9913c7f44bde0283 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Tue, 12 Sep 2017 12:51:55 -0400 Subject: [PATCH] api-ref: document microversions for the attachments API The attachments API is completely new in the 3.27 API so that should be pointed out in the API reference. The only wrinkle is the 'complete attachment' API which is new in 3.44. Change-Id: Ia22ddbcd86ecd12d74f365ec3c72d0635ff3566c Partial-Bug: #1716705 --- api-ref/source/v3/attachments.inc | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/api-ref/source/v3/attachments.inc b/api-ref/source/v3/attachments.inc index 605b884c09e..240e47e1c92 100644 --- a/api-ref/source/v3/attachments.inc +++ b/api-ref/source/v3/attachments.inc @@ -6,6 +6,10 @@ Attachments Lists all, lists all with details, shows details for, creates, and deletes attachment. +.. note:: Everything except for `Complete attachment` is new as of the 3.27 + microversion. `Complete attachment` is new as of the 3.44 + microversion. + Delete attachment ~~~~~~~~~~~~~~~~~ @@ -14,6 +18,8 @@ Delete attachment Deletes an attachment. +Available starting in the 3.27 microversion. + Normal response codes: 200 Error response codes: badRequest(400), itemNotFound(404) @@ -35,6 +41,7 @@ Show attachment details Shows details for an attachment. +Available starting in the 3.27 microversion. Normal response codes: 200 @@ -79,6 +86,8 @@ List attachments with details Lists all attachments with details. Since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. +Available starting in the 3.27 microversion. + Normal response codes: 200 Error response codes: badRequest(400) @@ -123,6 +132,7 @@ List attachments Lists all attachments, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. +Available starting in the 3.27 microversion. Normal response codes: 200 @@ -166,6 +176,8 @@ Create attachment Creates an attachment. +Available starting in the 3.27 microversion. + Normal response codes: 202 Error response codes: badRequest(400), itemNotFound(404) @@ -218,6 +230,8 @@ Update an attachment Update a reserved attachment record with connector information and set up the appropriate connection_info from the driver. +Available starting in the 3.27 microversion. + Normal response codes: 200 Error response codes: badRequest(400), itemNotFound(404) @@ -267,6 +281,8 @@ Complete attachment Complete an attachment for a cinder volume. +Available starting in the 3.44 microversion. + Normal response codes: 202 Error response codes: badRequest(400), itemNotFound(404)