openstack/cinder
Code Issues Proposed changes

Merge "api-ref: document microversions for the attachments API"

Browse Source
This commit is contained in:
Jenkins 2017-09-12 21:51:35 +00:00 committed by Gerrit Code Review
commit 8358e28428
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -6,6 +6,10 @@ Attachments
Lists all, lists all with details, shows details for, creates, and Lists all, lists all with details, shows details for, creates, and
deletes attachment. 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 Delete attachment
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
@ -14,6 +18,8 @@ Delete attachment
Deletes an attachment. Deletes an attachment.
Available starting in the 3.27 microversion.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -35,6 +41,7 @@ Show attachment details
Shows details for an attachment. Shows details for an attachment.
Available starting in the 3.27 microversion.
Normal response codes: 200 Normal response codes: 200
@ -79,6 +86,8 @@ List attachments with details
Lists all attachments with details. Since v3.31 if non-admin Lists all attachments with details. Since v3.31 if non-admin
users specify invalid filters in the url, API will return bad request. users specify invalid filters in the url, API will return bad request.
Available starting in the 3.27 microversion.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400) Error response codes: badRequest(400)
@ -123,6 +132,7 @@ List attachments
Lists all attachments, since v3.31 if non-admin users Lists all attachments, since v3.31 if non-admin users
specify invalid filters in the url, API will return bad request. specify invalid filters in the url, API will return bad request.
Available starting in the 3.27 microversion.
Normal response codes: 200 Normal response codes: 200
@ -166,6 +176,8 @@ Create attachment
Creates an attachment. Creates an attachment.
Available starting in the 3.27 microversion.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -218,6 +230,8 @@ Update an attachment
Update a reserved attachment record with connector information Update a reserved attachment record with connector information
and set up the appropriate connection_info from the driver. and set up the appropriate connection_info from the driver.
Available starting in the 3.27 microversion.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -267,6 +281,8 @@ Complete attachment
Complete an attachment for a cinder volume. Complete an attachment for a cinder volume.
Available starting in the 3.44 microversion.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)