openstack
/
heat
Code Issues Proposed changes

Merge "api-ref doc for stack (4)"

This commit is contained in:
Jenkins 2016-08-19 05:31:26 +00:00 committed by Gerrit Code Review
parent 2673dbdeff 772ef5ef89
commit bfc1d11990
4 changed files with 222 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
api-ref/source/v1/parameters.yaml
View File

@ -432,6 +432,14 @@ check:
in: body
required: true
type: string
clear_parameters:
description: |
A list of parameters, if specified, to be removed from the set of
parameters of the current stack. The default values in the template will
be used.
in: body
required: false
type: array
code:
description: |
The response code to a resource find request. e.g. ``302 Found``.
@ -645,6 +653,18 @@ environment_files:
in: body
required: false
type: object
existing:
description:
A boolean specifying whether the service is about to reuse the existing
stack template, parameters and environment. If ``template`` parameter is
not provided, the existing template is used. If ``template_files`` is not
provided, the existing environment is used. Parameters specified in the
``parameters`` key will patch over the existing values in the current
stack. Parameters omitted will keep the existing values.
in: body
required: false
default: false
type: boolean
files:
description: |
Supplies the contents of files referenced in the template or the
@ -956,6 +976,41 @@ physical_resource_id:
in: body
required: true
type: string
preview_added:
description: |
A list of resource objects that will be added if a stack update is
performed.
in: body
required: true
type: array
preview_deleted:
description: |
A list of resource objects that will be deleted if a stack update is
performed.
in: body
required: true
type: array
preview_replaced:
description: |
A list of resource objects that will be replaced if a stack update is
performed.
in: body
required: true
type: array
preview_unchanged:
description: |
A list of resource objects that will remain unchanged if a stack update is
performed.
in: body
required: true
type: array
preview_updated:
description: |
A list of resource objects that will have their properties updated in place
if a stack update is performed.
in: body
required: true
type: array
project_id:
description: |
The UUID of the project.
@ -996,6 +1051,13 @@ resource:
in: body
required: true
type: object
resource_changes:
description: |
An map that describes what resources will be added, deleted, replaced,
updated or remain unchanged.
in: body
required: true
type: object
resource_description:
description: |
Displays resource type's description.
@ -1121,6 +1183,13 @@ stack_id:
in: body
required: true
type: string
stack_disable_rollback:
description: |
Whether deletion of all stack resources when stack creation fails is
enabled.
in: body
required: true
type: boolean
stack_name:
description: |
A name for the stack. The value must be unique within a project.
@ -1321,6 +1390,13 @@ update_allowed:
in: body
required: true
type: boolean
update_show_nested:
description: |
Set to ``true`` to include nested stacks in the preview result.
in: body
required: false
default: false
type: boolean
updated_at:
description: |
The date and time when the resource was updated.
@ -1357,3 +1433,4 @@ updated_time:
in: body
required: true
type: string

5
api-ref/source/v1/samples/stack-find-delete-response.json Normal file
View File

@ -0,0 +1,5 @@
{
"code": "302 Found",
"message": "The resource was found at <a href=\"http://192.168.42.11:8004/v1/369166a68a3a49b78b4e138531556e55/stacks/s2/321c4eed-c87f-4cea-8288-9238f3b92e63\">http://192.168.42.11:8004/v1/369166a68a3a49b78b4e138531556e55/stacks/s2/321c4eed-c87f-4cea-8288-9238f3b92e63</a>;\nyou should be redirected automatically.\n\n",
"title": "Found"
}

5
api-ref/source/v1/samples/stack-update-response.json Normal file
View File

@ -0,0 +1,5 @@
{
"code": "202 Accepted",
"message": "The request is accepted for processing.<br /><br />\n\n\n",
"title": "Accepted"
}

145
api-ref/source/v1/stacks.inc
View File

@ -341,7 +341,19 @@ Update stack
Updates a stack.
Error response codes:404,202,500,401,400,
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 202
.. rest_status_code:: error status.yaml
- 400
- 401
- 404
- 500
Request Parameters
------------------
@ -351,13 +363,16 @@ Request Parameters
- tenant_id: tenant_id
- stack_name: stack_name_url
- stack_id: stack_id_url
- files: files
- clear_parameters: clear_parameters
- disable_rollback: disable_rollback
- environment: environment
- environment_files: environment_files
- existing: existing
- files: files
- parameters: parameters
- tags: tags
- environment: environment
- template_url: template_url
- template: template
- template_url: template_url
- timeout_mins: timeout_mins
Request Example
@ -366,6 +381,22 @@ Request Example
.. literalinclude:: samples/stack-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- code: code
- message: message
- title: title
Response Example
----------------
.. literalinclude:: samples/stack-update-response.json
:language: javascript
Preview stack update
====================
@ -374,8 +405,19 @@ Preview stack update
Previews an update for a stack.
Normal response codes: 200
Error response codes:
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 404
- 500
Request Parameters
------------------
@ -385,12 +427,17 @@ Request Parameters
- tenant_id: tenant_id
- stack_name: stack_name_url
- stack_id: stack_id_url
- clear_parameters: clear_parameters
- disable_rollback: disable_rollback
- environment: environment
- environment_files: environment_files
- existing: existing
- files: files
- parameters: parameters
- show_nested: update_show_nested
- tags: tags
- environment: environment
- template_url: template_url
- template: template
- template_url: template_url
- timeout_mins: timeout_mins
Request Example
@ -399,6 +446,19 @@ Request Example
.. literalinclude:: samples/stack-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- resource_changes: resource_changes
- added: preview_added
- deleted: preview_deleted
- replaced: preview_replaced
- unchanged: preview_unchanged
- updated: preview_updated
Response Example
----------------
@ -406,15 +466,75 @@ Response Example
:language: javascript
Find stack for deletion
=======================
.. rest_method:: DELETE /v1/{tenant_id}/stacks/{stack_name}
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
request a stack deletion.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 302
.. rest_status_code:: error status.yaml
- 400
- 401
- 404
- 500
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- stack_name: stack_name_url
Reponse Parameters
------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- location: location
- code: code
- message: message
- title: title
Response Example
----------------
.. literalinclude:: samples/stack-find-delete-response.json
:language: javascript
Delete stack
============
.. rest_method:: DELETE /v1/{tenant_id}/stacks/{stack_name}/{stack_id}
Deletes a stack and its snapshots.
Deletes a stack. If a stack has snapshots, those snapshots are deleted as well.
Error response codes:500,404,204,401,400,
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 204
.. rest_status_code:: error status.yaml
- 400
- 401
- 404
- 500
Request Parameters
------------------
@ -425,6 +545,11 @@ Request Parameters
- stack_name: stack_name_url
- stack_id: stack_id_url
Reponse Parameters
------------------
This request does not return anything in the response body.
Abandon stack
=============