openstack/heat
Code Issues Proposed changes
3aeaefc29f
heat/api-ref/source/v1/stack-templates.inc

154 lines
2.6 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 -*-
=========
Templates
=========
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
List template versions
======================
[api-ref] Added template-function-list Change-Id: I4a11f2937606131a9dd467ead87f9b6ad8c2df2d Closes-Bug: #1473814
2016-05-23 13:50:53 +05:30
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
.. rest_method:: GET /v1/{tenant_id}/template_versions
[api-ref] Added template-function-list Change-Id: I4a11f2937606131a9dd467ead87f9b6ad8c2df2d Closes-Bug: #1473814
2016-05-23 13:50:53 +05:30
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
Lists all available template versions.
[api-ref] Added template-function-list Change-Id: I4a11f2937606131a9dd467ead87f9b6ad8c2df2d Closes-Bug: #1473814
2016-05-23 13:50:53 +05:30
api-ref - template version and functions This patch fixes problems found in api-ref documentation about template versions and template functions. The detailed changes include: - Fixed status codes for the related APIs; - Fixed response parameters which were missing in original doc; - Fixed dcumentation about template-validate API where some request parameters were not documented. Change-Id: I72d4a19e36f3bb3d139becd308ebcdf4103c2570
2016-08-21 23:07:10 -04:00
Response Codes
--------------
[api-ref] Added template-function-list Change-Id: I4a11f2937606131a9dd467ead87f9b6ad8c2df2d Closes-Bug: #1473814
2016-05-23 13:50:53 +05:30
api-ref - template version and functions This patch fixes problems found in api-ref documentation about template versions and template functions. The detailed changes include: - Fixed status codes for the related APIs; - Fixed response parameters which were missing in original doc; - Fixed dcumentation about template-validate API where some request parameters were not documented. Change-Id: I72d4a19e36f3bb3d139becd308ebcdf4103c2570
2016-08-21 23:07:10 -04:00
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 404
- 500
Request Parameters
------------------
[api-ref] Added template-function-list Change-Id: I4a11f2937606131a9dd467ead87f9b6ad8c2df2d Closes-Bug: #1473814
2016-05-23 13:50:53 +05:30
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
api-ref - template version and functions This patch fixes problems found in api-ref documentation about template versions and template functions. The detailed changes include: - Fixed status codes for the related APIs; - Fixed response parameters which were missing in original doc; - Fixed dcumentation about template-validate API where some request parameters were not documented. Change-Id: I72d4a19e36f3bb3d139becd308ebcdf4103c2570
2016-08-21 23:07:10 -04:00
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request_id: request_id
- template_versions: template_versions
- alias: template_version_alias
- type: template_type
- version: template_version
[api-ref] Added template-function-list Change-Id: I4a11f2937606131a9dd467ead87f9b6ad8c2df2d Closes-Bug: #1473814
2016-05-23 13:50:53 +05:30
Response Example
----------------
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
.. literalinclude:: samples/template-versions-response.json
[api-ref] Added template-function-list Change-Id: I4a11f2937606131a9dd467ead87f9b6ad8c2df2d Closes-Bug: #1473814
2016-05-23 13:50:53 +05:30
:language: javascript
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
List template functions
=======================
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 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
.. rest_method:: GET /v1/{tenant_id}/template_versions/{template_version}/functions
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 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
Lists all available functions for a template version.
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 - template version and functions This patch fixes problems found in api-ref documentation about template versions and template functions. The detailed changes include: - Fixed status codes for the related APIs; - Fixed response parameters which were missing in original doc; - Fixed dcumentation about template-validate API where some request parameters were not documented. Change-Id: I72d4a19e36f3bb3d139becd308ebcdf4103c2570
2016-08-21 23:07:10 -04:00
Response Codes
--------------
.. rest_status_code:: success status.yaml
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 - template version and functions This patch fixes problems found in api-ref documentation about template versions and template functions. The detailed changes include: - Fixed status codes for the related APIs; - Fixed response parameters which were missing in original doc; - Fixed dcumentation about template-validate API where some request parameters were not documented. Change-Id: I72d4a19e36f3bb3d139becd308ebcdf4103c2570
2016-08-21 23:07:10 -04:00
- 200
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 - template version and functions This patch fixes problems found in api-ref documentation about template versions and template functions. The detailed changes include: - Fixed status codes for the related APIs; - Fixed response parameters which were missing in original doc; - Fixed dcumentation about template-validate API where some request parameters were not documented. Change-Id: I72d4a19e36f3bb3d139becd308ebcdf4103c2570
2016-08-21 23:07:10 -04:00
.. rest_status_code:: error status.yaml
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 - template version and functions This patch fixes problems found in api-ref documentation about template versions and template functions. The detailed changes include: - Fixed status codes for the related APIs; - Fixed response parameters which were missing in original doc; - Fixed dcumentation about template-validate API where some request parameters were not documented. Change-Id: I72d4a19e36f3bb3d139becd308ebcdf4103c2570
2016-08-21 23:07:10 -04:00
- 400
- 401
- 404
- 500
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 - template version and functions This patch fixes problems found in api-ref documentation about template versions and template functions. The detailed changes include: - Fixed status codes for the related APIs; - Fixed response parameters which were missing in original doc; - Fixed dcumentation about template-validate API where some request parameters were not documented. Change-Id: I72d4a19e36f3bb3d139becd308ebcdf4103c2570
2016-08-21 23:07:10 -04:00
- template_version: template_version_url
Reponse Parameters
------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- template_functions: template_functions
Fix problems left in api-ref This patch fixes the known problems in api-ref docs: - the patch update stack api is now documented; - the patch update preview api is now documented; - the unused parameters in 'parameters.yaml' are all removed; - some incorrect references of parameters are fixed. Change-Id: I89457c98f542304df788636e4ad3ace5d2e7deb5
2016-08-23 04:16:03 -04:00
- description: function_description
api-ref - template version and functions This patch fixes problems found in api-ref documentation about template versions and template functions. The detailed changes include: - Fixed status codes for the related APIs; - Fixed response parameters which were missing in original doc; - Fixed dcumentation about template-validate API where some request parameters were not documented. Change-Id: I72d4a19e36f3bb3d139becd308ebcdf4103c2570
2016-08-21 23:07:10 -04:00
- functions: functions
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
----------------
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
.. literalinclude:: samples/template-functions-list-response.json
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
:language: javascript
Validate template
=================
.. rest_method:: POST /v1/{tenant_id}/validate
Validates a template.
api-ref - template version and functions This patch fixes problems found in api-ref documentation about template versions and template functions. The detailed changes include: - Fixed status codes for the related APIs; - Fixed response parameters which were missing in original doc; - Fixed dcumentation about template-validate API where some request parameters were not documented. Change-Id: I72d4a19e36f3bb3d139becd308ebcdf4103c2570
2016-08-21 23:07:10 -04:00
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
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 - template version and functions This patch fixes problems found in api-ref documentation about template versions and template functions. The detailed changes include: - Fixed status codes for the related APIs; - Fixed response parameters which were missing in original doc; - Fixed dcumentation about template-validate API where some request parameters were not documented. Change-Id: I72d4a19e36f3bb3d139becd308ebcdf4103c2570
2016-08-21 23:07:10 -04:00
.. rest_status_code:: error status.yaml
- 400
- 500
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 - template version and functions This patch fixes problems found in api-ref documentation about template versions and template functions. The detailed changes include: - Fixed status codes for the related APIs; - Fixed response parameters which were missing in original doc; - Fixed dcumentation about template-validate API where some request parameters were not documented. Change-Id: I72d4a19e36f3bb3d139becd308ebcdf4103c2570
2016-08-21 23:07:10 -04:00
- environment: environment
- environment_files: environment_files
- files: files
template validate ignore errors api-ref update api-ref is updated for template validate REST API to provide details on the ignore_errors query parameter. Change-Id: I9e2911c7fbe708913b6f143c6d4e408b148ce672
2016-05-23 15:17:05 +05:30
- ignore_errors: ignore_errors
api-ref - template version and functions This patch fixes problems found in api-ref documentation about template versions and template functions. The detailed changes include: - Fixed status codes for the related APIs; - Fixed response parameters which were missing in original doc; - Fixed dcumentation about template-validate API where some request parameters were not documented. Change-Id: I72d4a19e36f3bb3d139becd308ebcdf4103c2570
2016-08-21 23:07:10 -04:00
- show_nested: show_nested
- template: template
- template_url: template_url
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/template-validate-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
api-ref - template version and functions This patch fixes problems found in api-ref documentation about template versions and template functions. The detailed changes include: - Fixed status codes for the related APIs; - Fixed response parameters which were missing in original doc; - Fixed dcumentation about template-validate API where some request parameters were not documented. Change-Id: I72d4a19e36f3bb3d139becd308ebcdf4103c2570
2016-08-21 23:07:10 -04:00
- 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
- Description: Description
api-ref - template version and functions This patch fixes problems found in api-ref documentation about template versions and template functions. The detailed changes include: - Fixed status codes for the related APIs; - Fixed response parameters which were missing in original doc; - Fixed dcumentation about template-validate API where some request parameters were not documented. Change-Id: I72d4a19e36f3bb3d139becd308ebcdf4103c2570
2016-08-21 23:07:10 -04:00
- ParameterGroups: ParameterGroups
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
- Parameters: Parameters
Response Example
----------------
.. literalinclude:: samples/template-validate-response.json
:language: javascript
Copy Permalink