summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorSteven Hardy <shardy@redhat.com>2017-10-31 11:26:09 +0000
committerSteven Hardy <shardy@redhat.com>2017-11-14 17:35:52 +0000
commit313faad5f13abf0fddd85d07706fded6ed02bf38 (patch)
treec527fa30496ba621265019445e2ef8e04158d2f1 /api-ref
parente875186c4e491eaa7ab1bb2f602a27e0cf22f345 (diff)
downloadheat-313faad5f13abf0fddd85d07706fded6ed02bf38.tar.gz
Return Environment from validate_template
This is to enable preview of the merged environment without merging the environment on the client side. Related-Bug: #1635409 Change-Id: I7ec3af729a65164230153021f438bf226cc5e858
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/v1/parameters.yaml8
-rw-r--r--api-ref/source/v1/samples/template-validate-response.json10
-rw-r--r--api-ref/source/v1/stack-templates.inc1
3 files changed, 17 insertions, 2 deletions
diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml
index 7722b0f44..7c657efe7 100644
--- a/api-ref/source/v1/parameters.yaml
+++ b/api-ref/source/v1/parameters.yaml
@@ -646,6 +646,12 @@ engine_status:
in: body
required: true
type: string
+Environment:
+ description: |
+ Environment for the stack, where multiple environment files are provided this will be the merged result.
+ in: body
+ required: false
+ type: object
environment:
description: |
A JSON environment for the stack.
@@ -943,7 +949,7 @@ ParameterGroups:
type: array
Parameters:
description: |
- Key and value pairs that contain CFN template parameters.
+ Parameter schema in CFN format.
in: body
required: true
type: object
diff --git a/api-ref/source/v1/samples/template-validate-response.json b/api-ref/source/v1/samples/template-validate-response.json
index cbdf7c26f..80c9374ab 100644
--- a/api-ref/source/v1/samples/template-validate-response.json
+++ b/api-ref/source/v1/samples/template-validate-response.json
@@ -37,5 +37,13 @@
"param_name-2"
]
}
- ]
+ ],
+ "Environment": {
+ "event_sinks": [],
+ "parameter_defaults": {},
+ "parameters": {},
+ "resource_registry": {
+ "resources": {}
+ }
+ }
}
diff --git a/api-ref/source/v1/stack-templates.inc b/api-ref/source/v1/stack-templates.inc
index e9b735871..f6e0b42e9 100644
--- a/api-ref/source/v1/stack-templates.inc
+++ b/api-ref/source/v1/stack-templates.inc
@@ -145,6 +145,7 @@ Response Parameters
- Description: Description
- ParameterGroups: ParameterGroups
- Parameters: Parameters
+ - Environment: Environment
Response Example
----------------