summaryrefslogtreecommitdiff
path: root/api-ref/source
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2016-08-23 07:11:12 +0000
committerGerrit Code Review <review@openstack.org>2016-08-23 07:11:12 +0000
commitb4a2b4387b9b4c35783c73b5fb21b3a95dd313d2 (patch)
tree3dc53d1cb6c3657b466b039a442cff53f87ce282 /api-ref/source
parent9c8e321020275530f1aa0b4f92314576d8ff070d (diff)
parent5a43527d8ef1f2abab03a24c5112a54ec5ba032a (diff)
downloadheat-b4a2b4387b9b4c35783c73b5fb21b3a95dd313d2.tar.gz
Merge "api-ref - stack identity usage in find calls"
Diffstat (limited to 'api-ref/source')
-rw-r--r--api-ref/source/v1/parameters.yaml8
-rw-r--r--api-ref/source/v1/stacks.inc8
2 files changed, 11 insertions, 5 deletions
diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml
index 080e3016a..380edbc23 100644
--- a/api-ref/source/v1/parameters.yaml
+++ b/api-ref/source/v1/parameters.yaml
@@ -64,7 +64,13 @@ stack_id_url:
description: |
The UUID of the stack.
in: path
- required: false
+ required: true
+ type: string
+stack_identity:
+ description: |
+ The UUID or the name of a stack.
+ in: path
+ required: true
type: string
stack_name_url:
description: |
diff --git a/api-ref/source/v1/stacks.inc b/api-ref/source/v1/stacks.inc
index 14c0fdddb..65ffe49dc 100644
--- a/api-ref/source/v1/stacks.inc
+++ b/api-ref/source/v1/stacks.inc
@@ -217,7 +217,7 @@ Response Example
Find stack
==========
-.. rest_method:: GET /v1/{tenant_id}/stacks/{stack_name}
+.. rest_method:: GET /v1/{tenant_id}/stacks/{stack_identity}
Finds the canonical URL for a stack.
@@ -248,7 +248,7 @@ Request Parameters
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- - stack_name: stack_name_url
+ - stack_identity: stack_identity
Response Parameters
-------------------
@@ -469,7 +469,7 @@ Response Example
Find stack for deletion
=======================
-.. rest_method:: DELETE /v1/{tenant_id}/stacks/{stack_name}
+.. rest_method:: DELETE /v1/{tenant_id}/stacks/{stack_identity}
Find the canonical URL for a stack for deletion. This request returns a status
code of ``302`` pointing to the location where a DELETE request can be sent to
@@ -495,7 +495,7 @@ Request Parameters
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- - stack_name: stack_name_url
+ - stack_identity: stack_identity
Reponse Parameters
------------------