openstack/heat
Code Issues Proposed changes
51f566c56c
heat/api-ref/source/v1/stack-outputs.inc

100 lines
1.7 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 Outputs
=============
List outputs
============
.. rest_method:: GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/outputs
Lists outputs for a stack.
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
Response Codes
--------------
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 - 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
.. rest_status_code:: success status.yaml
- 200
.. 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 - 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
- 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 - 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
- X-Openstack-Request-Id: request_id
- outputs: stack_outputs
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
- output_key: output_key
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
- description: output_description
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-outputs-list-response.json
:language: javascript
Show output
===========
.. rest_method:: GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/outputs/{output_key}
Shows details for a stack output.
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
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. 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 - 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
- stack_name: stack_name_url
- stack_id: stack_id_url
- output_key: output_key_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
Fix some typos s/X-Openstack-Reqeuest-Id/X-Openstack-Request-Id/ Change-Id: Ib35b941dbeedfd178a9ef89d4ef38d23e8c0e373 Closes-bug: #1739324
2018-02-09 15:33:21 +09:00
- X-Openstack-Request-Id: request_id
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
- output: output
- output_key: output_key
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
- output_value: output_value
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
- description: output_description
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
- output_error: output_error
Response Example
----------------
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
.. literalinclude:: samples/stack-output-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
Copy Permalink