diff options
author | rabi <ramishra@redhat.com> | 2017-08-07 15:05:50 +0530 |
---|---|---|
committer | rabi <ramishra@redhat.com> | 2017-11-08 17:08:43 +0530 |
commit | 01b58781292ca8da97019594b6dc155817c46ca1 (patch) | |
tree | 2aca0fdd39d8d83f7b721e006b26bfd35f7af6fe /api-ref/source | |
parent | b1339abcd1b83c9a51020629f48c2b23bb32918b (diff) | |
download | heat-01b58781292ca8da97019594b6dc155817c46ca1.tar.gz |
Add REST api support for cancel without rollback
We already have REST api support for cancelling a
UPDATE_IN_PROGRESS stack with rollback. This adds a
new action 'cancel_without_rollback' to allow for
canceling a create/update in_progress stack without
rollback.
APIImpact
Change-Id: I6c6ffa0502ab8745cfb2f9c5ef263f1e02dfc4ca
Closes-Bug: #1709041
Diffstat (limited to 'api-ref/source')
-rw-r--r-- | api-ref/source/v1/parameters.yaml | 7 | ||||
-rw-r--r-- | api-ref/source/v1/samples/stack-action-cancel-without-rollback-request.json | 3 | ||||
-rw-r--r-- | api-ref/source/v1/stack-actions.inc | 49 |
3 files changed, 59 insertions, 0 deletions
diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml index 5667839de..7722b0f44 100644 --- a/api-ref/source/v1/parameters.yaml +++ b/api-ref/source/v1/parameters.yaml @@ -431,6 +431,13 @@ cancel_update: in: body required: true type: string +cancel_without_rollback: + description: | + Specify the ``cancel_without_rollback`` action in + the request body.. + in: body + required: true + type: string capabilities: description: | List of stack capabilities for stack. diff --git a/api-ref/source/v1/samples/stack-action-cancel-without-rollback-request.json b/api-ref/source/v1/samples/stack-action-cancel-without-rollback-request.json new file mode 100644 index 000000000..63ce670f5 --- /dev/null +++ b/api-ref/source/v1/samples/stack-action-cancel-without-rollback-request.json @@ -0,0 +1,3 @@ +{ + "cancel_without_rollback": null +} diff --git a/api-ref/source/v1/stack-actions.inc b/api-ref/source/v1/stack-actions.inc index 0efab0b86..bf6ad2d99 100644 --- a/api-ref/source/v1/stack-actions.inc +++ b/api-ref/source/v1/stack-actions.inc @@ -154,6 +154,55 @@ Response Example This operation does not return a response body. +Cancel stack create/update without rollback +=========================================== + +.. rest_method:: POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/actions + +Cancels a currently running create/update of a stack without rollback. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 200 + +.. rest_status_code:: error status.yaml + + - 400 + - 401 + - 404 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - tenant_id: tenant_id + - stack_name: stack_name_url + - stack_id: stack_id_url + - cancel_without_rollback: cancel_without_rollback + +Request Example +--------------- + +.. literalinclude:: samples/stack-action-cancel-without-rollback-request.json + :language: javascript + +Response Parameters +------------------- + +.. rest_parameters:: parameters.yaml + + - X-Openstack-Request-Id: request_id + +Response Example +---------------- + +This operation does not return a response body. + + Check stack resources ===================== |