Merge "[placement] Add 'Location' parameters in API ref"

2017-12-14 14:26:12 +00:00 · 2017-12-14 14:26:12 +00:00 · b11c9a7e89
commit b11c9a7e89
parent b9cdcc3f80 0027ee4018
5 changed files with 25 additions and 0 deletions
--- 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: <Location URL>" will be returned.
+  in: header
+  required: true
+  type: string
+
 # variables in path
 consumer_uuid: &consumer_uuid
  type: string
--- 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)
--- 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.
--- a/placement-api-ref/source/resource_providers.inc
+++ b/placement-api-ref/source/resource_providers.inc
@ -82,4 +82,8 @@ Request example
 Response
 --------

+.. rest_parameters:: parameters.yaml
+
+  - Location: location
+
 No body content is returned on a successful POST.
--- 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