openstack/heat
Code Issues Proposed changes
e9679344c9
heat/api-ref/source/v1/stack-actions.inc

204 lines
3.4 KiB
PHP
Raw Normal View History

Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
.. -*- rst -*-
=============
Stack actions
=============
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
Performs non-lifecycle operations on the stack. Specify the action in the
request body.
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
Suspend stack
=============
.. rest_method:: POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/actions
Suspends a stack.
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
Response Codes
--------------
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 404
Request Parameters
------------------
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
.. 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
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
- stack_id: stack_id_url
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
- suspend: suspend
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
Request Example
---------------
.. literalinclude:: samples/stack-action-suspend-request.json
:language: javascript
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
Response Example
----------------
Fix api-ref generation errors This patch fixes errors with the include directives generated by the api-site team for the migration. This patch fixes the errors by bringing our api-ref docs in line with the existing docs; verifying that the previous docs are still valid will be a separate initiative. Change-Id: Ibb7d57d8665dbfb655b2c3bd4a69fdc0f8a44d69
2016-05-16 12:17:06 -04:00
This operation does not return a response body.
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
Resume stack
============
.. rest_method:: POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/actions
Resumes a suspended stack.
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
Response Codes
--------------
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 404
Request Parameters
------------------
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
.. 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
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
- stack_id: stack_id_url
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
- resume: resume
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
Request Example
---------------
.. literalinclude:: samples/stack-action-resume-request.json
:language: javascript
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
Response Example
----------------
Fix api-ref generation errors This patch fixes errors with the include directives generated by the api-site team for the migration. This patch fixes the errors by bringing our api-ref docs in line with the existing docs; verifying that the previous docs are still valid will be a separate initiative. Change-Id: Ibb7d57d8665dbfb655b2c3bd4a69fdc0f8a44d69
2016-05-16 12:17:06 -04:00
This operation does not return a response body.
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
Cancel stack update
===================
.. rest_method:: POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/actions
Cancels a currently running update of a stack.
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
Response Codes
--------------
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 404
Request Parameters
------------------
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
.. 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
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
- stack_id: stack_id_url
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
- cancel_update: cancel_update
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
Request Example
---------------
.. literalinclude:: samples/stack-action-cancel-update-request.json
:language: javascript
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
Response Example
----------------
Fix api-ref generation errors This patch fixes errors with the include directives generated by the api-site team for the migration. This patch fixes the errors by bringing our api-ref docs in line with the existing docs; verifying that the previous docs are still valid will be a separate initiative. Change-Id: Ibb7d57d8665dbfb655b2c3bd4a69fdc0f8a44d69
2016-05-16 12:17:06 -04:00
This operation does not return a response body.
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
Check stack resources
=====================
.. rest_method:: POST /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/actions
Checks whether the resources are in expected states for a stack.
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
Response Codes
--------------
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 404
Request Parameters
------------------
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
.. 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
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
- stack_id: stack_id_url
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
- check: check
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
Request Example
---------------
.. literalinclude:: samples/stack-action-check-request.json
:language: javascript
api-ref - stack actions This patch fixes problems found in api-ref documentation related to stack actions and missing stack APIs. More specifically, this include the following changes: - Fix status code documentation about stack actions; - Added response parameters for some actions although there is no body returned -- there are still header returned; - Added documentation about stack-export API; - Added documentation about stack-environment-show API; - Added documentation about stack-files-show API; Change-Id: I8b2266ec7a7a22fc1cb1782e98beac315e054013
2016-08-21 22:14:54 -04:00
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
Migrate API documentations into the Heat tree For more information, see: http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html This is the initial port from api-site. The includes in source/v1/index.rst are alphabetized, but we may want to revisit that and reorder them according to importance. Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048 Implements: blueprint api-doc-migration
2016-05-04 15:23:15 -04:00
Response Example
----------------
Fix api-ref generation errors This patch fixes errors with the include directives generated by the api-site team for the migration. This patch fixes the errors by bringing our api-ref docs in line with the existing docs; verifying that the previous docs are still valid will be a separate initiative. Change-Id: Ibb7d57d8665dbfb655b2c3bd4a69fdc0f8a44d69
2016-05-16 12:17:06 -04:00
This operation does not return a response body.
Copy Permalink