From 72081ded4d9bd4a992c73944deeed84bfd290a14 Mon Sep 17 00:00:00 2001 From: jichenjc Date: Fri, 24 Feb 2017 09:45:59 +0800 Subject: [PATCH] Add description for Image location in snapshot snapshot action nova will return image URL in response header better to provide this info to end user for their reference. Also, the backup header description is changed as well. Change-Id: I15cf228b4a5a2d0dbae5fa76ec6821487e7808ed Closes-Bug: 1657998 --- api-ref/source/parameters.yaml | 7 +++++++ api-ref/source/servers-actions.inc | 4 +++- api-ref/source/servers-admin-action.inc | 5 +++-- 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index c1aa107af3..b4fcad6a5a 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -1,4 +1,11 @@ # variables in header +image_location: + description: | + The image location URL of the image or backup created, HTTP header + "Location: " will be returned. + in: header + required: true + type: string tag_location: description: | The location of the tag. It's individual tag URL which can be used for diff --git a/api-ref/source/servers-actions.inc b/api-ref/source/servers-actions.inc index ce22f10eef..2c77dfca2b 100644 --- a/api-ref/source/servers-actions.inc +++ b/api-ref/source/servers-actions.inc @@ -271,7 +271,9 @@ Request Response -------- -If successful, this method does not return content in the response body. +.. rest_parameters:: parameters.yaml + + - image_location: image_location Lock Server (lock Action) diff --git a/api-ref/source/servers-admin-action.inc b/api-ref/source/servers-admin-action.inc index 5e90eaeb9d..1110a49104 100644 --- a/api-ref/source/servers-admin-action.inc +++ b/api-ref/source/servers-admin-action.inc @@ -55,8 +55,9 @@ Request Response -------- -If successful, the header 'Location' : -will be returned. No response body is returned. +.. rest_parameters:: parameters.yaml + + - image_location: image_location Inject Network Information (injectNetworkInfo Action)