openstack/heat
Code Issues Proposed changes
33bd97db3f
heat/api-ref/source/v1/stack-snapshots.inc

254 lines
4.5 KiB
PHP
Raw Normal View History

Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
.. -*- rst -*-
===============
Stack Snapshots
===============
api-ref doc for stack (2) This patch continues the fix to the api-ref doc for stack resource. To ensure upcoming patches are not messing up the parameter defintions, this patch is cleansing up the parameters that appear both in URLs and request/response bodies: 'stack_id', 'stack_name', 'resource_name', 'event_id', 'snapshot_id', etc. These parameters sometimes are playing different roles although the name is the same. Other fixes included in this patch: - added back the stack-outputs and stack-snapshots into index - split resource-types out of stack-templates and add reference to it into index (git misunderstood this as a renaming, :)) Change-Id: I2b486a9b85d23d3225a5701c2265ecea2f4712f7
2016-08-18 05:58:24 -04:00
Snapshot a stack
================
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
.. rest_method:: POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/snapshots
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
Takes a snapshot of all resources in a stack. All snapshots are deleted when
the stack is deleted.
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 404
- 500
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
api-ref doc for stack (2) This patch continues the fix to the api-ref doc for stack resource. To ensure upcoming patches are not messing up the parameter defintions, this patch is cleansing up the parameters that appear both in URLs and request/response bodies: 'stack_id', 'stack_name', 'resource_name', 'event_id', 'snapshot_id', etc. These parameters sometimes are playing different roles although the name is the same. Other fixes included in this patch: - added back the stack-outputs and stack-snapshots into index - split resource-types out of stack-templates and add reference to it into index (git misunderstood this as a renaming, :)) Change-Id: I2b486a9b85d23d3225a5701c2265ecea2f4712f7
2016-08-18 05:58:24 -04:00
- stack_name: stack_name_url
- stack_id: stack_id_url
api-ref - build/resource-type/versions This patch fixes the format and content of the api-ref documentation for the build-info, resource-type-{list|template|schema}, versions APIs. Major changes include: - use status code table to show response codes - add missing response parameters such as request id - fixed cases where the response format was not clearly/correctly documented. Change-Id: Id7ac58ff19d3f7a0feb4d872efa7b46c01fa8f4b
2016-08-19 03:46:09 -04:00
- name: snapshot_name
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
Request Example
---------------
.. literalinclude:: samples/stack-snapshot-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
- X-Openstack-Request-Id: request_id
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
- creation_time: creation_time
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
- data: snapshot_data
api-ref - services/stack-outputs doc This patch fixes inaccuracies/defects in the api-ref documentation for services and stack-outputs. Change-Id: I083607df0f5b72ee004e23d855df870a963c1578
2016-08-19 05:59:07 -04:00
- id: snapshot_id
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
- name: snapshot_name
- status: snapshot_status
- status_reason: snapshot_status_reason
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
Response Example
----------------
.. literalinclude:: samples/stack-snapshot-response.json
:language: javascript
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
List snapshots
==============
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
.. rest_method:: GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/snapshots
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
Lists snapshots for a stack.
Response Codes
--------------
.. rest_status_code:: success status.yaml
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
- 200
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
.. rest_status_code:: error status.yaml
- 401
- 404
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
api-ref doc for stack (2) This patch continues the fix to the api-ref doc for stack resource. To ensure upcoming patches are not messing up the parameter defintions, this patch is cleansing up the parameters that appear both in URLs and request/response bodies: 'stack_id', 'stack_name', 'resource_name', 'event_id', 'snapshot_id', etc. These parameters sometimes are playing different roles although the name is the same. Other fixes included in this patch: - added back the stack-outputs and stack-snapshots into index - split resource-types out of stack-templates and add reference to it into index (git misunderstood this as a renaming, :)) Change-Id: I2b486a9b85d23d3225a5701c2265ecea2f4712f7
2016-08-18 05:58:24 -04:00
- stack_name: stack_name_url
- stack_id: stack_id_url
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
- X-Openstack-Request-Id: request_id
- snapshots: snapshots
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
- creation_time: creation_time
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
- data: snapshot_data
api-ref - services/stack-outputs doc This patch fixes inaccuracies/defects in the api-ref documentation for services and stack-outputs. Change-Id: I083607df0f5b72ee004e23d855df870a963c1578
2016-08-19 05:59:07 -04:00
- id: snapshot_id
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
- name: snapshot_name
- status: snapshot_status
- status_reason: snapshot_status_reason
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
Response Example
----------------
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
.. literalinclude:: samples/stack-snapshots-list-response.json
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
:language: javascript
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
Show snapshot
=============
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
.. rest_method:: GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/snapshots/{snapshot_id}
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
Shows details for a snapshot.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 404
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
api-ref doc for stack (2) This patch continues the fix to the api-ref doc for stack resource. To ensure upcoming patches are not messing up the parameter defintions, this patch is cleansing up the parameters that appear both in URLs and request/response bodies: 'stack_id', 'stack_name', 'resource_name', 'event_id', 'snapshot_id', etc. These parameters sometimes are playing different roles although the name is the same. Other fixes included in this patch: - added back the stack-outputs and stack-snapshots into index - split resource-types out of stack-templates and add reference to it into index (git misunderstood this as a renaming, :)) Change-Id: I2b486a9b85d23d3225a5701c2265ecea2f4712f7
2016-08-18 05:58:24 -04:00
- stack_name: stack_name_url
- stack_id: stack_id_url
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
- snapshot_id: snapshot_id_url
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
- X-Openstack-Request-Id: request_id
- snapshot: snapshot
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
- creation_time: creation_time
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
- data: snapshot_data
api-ref - services/stack-outputs doc This patch fixes inaccuracies/defects in the api-ref documentation for services and stack-outputs. Change-Id: I083607df0f5b72ee004e23d855df870a963c1578
2016-08-19 05:59:07 -04:00
- id: snapshot_id
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
- name: snapshot_name
- status: snapshot_status
- status_reason: snapshot_status_reason
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
Response Example
----------------
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
.. literalinclude:: samples/stack-snapshot-show-response.json
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
:language: javascript
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
Restore snapshot
================
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
.. rest_method:: POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/snapshots/{snapshot_id}/restore
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
Restores a stack snapshot.
You can restore only active stacks from a snapshot. You must recreate deleted
stacks.
Response Codes
--------------
.. rest_status_code:: success status.yaml
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
- 202
.. rest_status_code:: error status.yaml
- 401
- 404
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
api-ref doc for stack (2) This patch continues the fix to the api-ref doc for stack resource. To ensure upcoming patches are not messing up the parameter defintions, this patch is cleansing up the parameters that appear both in URLs and request/response bodies: 'stack_id', 'stack_name', 'resource_name', 'event_id', 'snapshot_id', etc. These parameters sometimes are playing different roles although the name is the same. Other fixes included in this patch: - added back the stack-outputs and stack-snapshots into index - split resource-types out of stack-templates and add reference to it into index (git misunderstood this as a renaming, :)) Change-Id: I2b486a9b85d23d3225a5701c2265ecea2f4712f7
2016-08-18 05:58:24 -04:00
- stack_name: stack_name_url
- stack_id: stack_id_url
- snapshot_id: snapshot_id_url
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
Response Parameters
-------------------
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
.. rest_parameters:: parameters.yaml
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
- X-Openstack-Request-Id: request_id
- code: restore_code
- message: restore_message
- title: restore_title
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
Response Example
----------------
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
.. literalinclude:: samples/stack-snapshot-restore-response.json
:language: javascript
Delete a snapshot
=================
.. rest_method:: DELETE /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/snapshots/{snapshot_id}
Deletes a stack snapshot.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 204
.. rest_status_code:: error status.yaml
- 401
- 404
- 500
Split stack api-ref doc into three files This patch splits the stacks.inc file into three files so that we can patch them separately. The original file contains API calls about stacks, stack snapshots and stack outputs, however, the latter two have every right to be documented separately. Change-Id: I3e3b71c914046939cd816c79359601e91791cf82
2016-08-18 03:23:05 -04:00
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
api-ref doc for stack (2) This patch continues the fix to the api-ref doc for stack resource. To ensure upcoming patches are not messing up the parameter defintions, this patch is cleansing up the parameters that appear both in URLs and request/response bodies: 'stack_id', 'stack_name', 'resource_name', 'event_id', 'snapshot_id', etc. These parameters sometimes are playing different roles although the name is the same. Other fixes included in this patch: - added back the stack-outputs and stack-snapshots into index - split resource-types out of stack-templates and add reference to it into index (git misunderstood this as a renaming, :)) Change-Id: I2b486a9b85d23d3225a5701c2265ecea2f4712f7
2016-08-18 05:58:24 -04:00
- stack_name: stack_name_url
- stack_id: stack_id_url
- snapshot_id: snapshot_id_url
api-ref - stack snapshots This patch fixes problems in api-ref doc for stack snapshots releated APIs. The specific changes include: - Added response parameter/example for stack-restore API; - Renamed stack-show-snapshot-response to stack-snapshot-show-response for consistency. - Fixed parameter reference for software-config related to status and status_reason. - Added missing docs for response codes. - Removed some parameters which never appears in snapshot list calls; - Reordered docs about API calls so the flow becomes: create, list, show, restore and delete. Change-Id: Iff5d671da597f640eb59d28e1533e3f6506f622c
2016-08-20 05:23:02 -04:00
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
Response Example
----------------
The response to this API does not have a body.
Copy Permalink