From 0027ee401803a852c4eea9d621f0852e3bec1f07 Mon Sep 17 00:00:00 2001 From: Takashi NATSUME Date: Mon, 20 Nov 2017 22:33:39 +0900 Subject: [PATCH] [placement] Add 'Location' parameters in API ref The 'Location' parameters are missing in the follwoing APIs of Placement API reference. So add them. * POST /resource_providers * POST /resource_classes * PUT /resource_classes/{name} (microversion 1.7-) * PUT /traits/{name} Change-Id: Ieed5cb7d4697472ab46b2e80d6d2df68098c5631 Closes-Bug: #1733329 --- placement-api-ref/source/parameters.yaml | 9 +++++++++ placement-api-ref/source/resource_class.inc | 4 ++++ placement-api-ref/source/resource_classes.inc | 4 ++++ placement-api-ref/source/resource_providers.inc | 4 ++++ placement-api-ref/source/traits.inc | 4 ++++ 5 files changed, 25 insertions(+) diff --git a/placement-api-ref/source/parameters.yaml b/placement-api-ref/source/parameters.yaml index faca4471015f..998aad1fd624 100644 --- a/placement-api-ref/source/parameters.yaml +++ b/placement-api-ref/source/parameters.yaml @@ -1,3 +1,12 @@ +# variables in header +location: + description: | + The location URL of the resource created, + HTTP header "Location: " will be returned. + in: header + required: true + type: string + # variables in path consumer_uuid: &consumer_uuid type: string diff --git a/placement-api-ref/source/resource_class.inc b/placement-api-ref/source/resource_class.inc index 61bb933f0cd2..f8f7e758cfb8 100644 --- a/placement-api-ref/source/resource_class.inc +++ b/placement-api-ref/source/resource_class.inc @@ -69,6 +69,10 @@ Request Response -------- +.. rest_parameters:: parameters.yaml + + - Location: location + No body content is returned on a successful PUT. Update resource class (microversions 1.2 - 1.6) diff --git a/placement-api-ref/source/resource_classes.inc b/placement-api-ref/source/resource_classes.inc index 4e1dad24d372..0e8f80b4543e 100644 --- a/placement-api-ref/source/resource_classes.inc +++ b/placement-api-ref/source/resource_classes.inc @@ -68,4 +68,8 @@ Request example Response -------- +.. rest_parameters:: parameters.yaml + + - Location: location + No body content is returned on a successful POST. diff --git a/placement-api-ref/source/resource_providers.inc b/placement-api-ref/source/resource_providers.inc index cffd98a7a191..fef031de4042 100644 --- a/placement-api-ref/source/resource_providers.inc +++ b/placement-api-ref/source/resource_providers.inc @@ -83,4 +83,8 @@ Request example Response -------- +.. rest_parameters:: parameters.yaml + + - Location: location + No body content is returned on a successful POST. diff --git a/placement-api-ref/source/traits.inc b/placement-api-ref/source/traits.inc index b40df81c1159..6b8ca246c90c 100644 --- a/placement-api-ref/source/traits.inc +++ b/placement-api-ref/source/traits.inc @@ -99,6 +99,10 @@ Request Response -------- +.. rest_parameters:: parameters.yaml + + - Location: location + No body content is returned on a successful PUT. Delete traits