openstack/heat
Code Issues Proposed changes
30d63c5b63
heat/api-ref/source/v1/versions.inc

42 lines
646 B
PHP
Raw Normal View History

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
.. -*- rst -*-
============
API versions
============
List versions
=============
.. rest_method:: GET /
Lists all Orchestration API versions.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 300
Request Parameters
------------------
This operation does not accept a request body.
[api-ref] Rewrite the Heat API version This patch validate the header: Change redundant request parameters to response parameters and add more parameters to response parameters table. http://developer.openstack.org/api-ref/orchestration/ v1/?expanded=list-versions-detail Change-Id: I392af2faa54940f93ce1344e5e880a5583099608
2016-08-31 17:25:51 +07:00
Response Parameters
Fix api-ref build with Sphinx 1.5 Sphinx 1.5 is more picky about some code, it complaints if code-blocks are not valid json and also about too short underlines. Fix one json file, fix underlines, change code-blocks to none so that Sphinx 1.5 builds this again. Enable treating warnings as errors to avoid regressions. Note that with current tools there are no double stanza warnings anymore. Change-Id: I58d1452ffddf091d56dcfad8140caba084800a0e
2017-03-04 09:30:53 +01:00
-------------------
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
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- versions: versions
[api-ref] Rewrite the Heat API version This patch validate the header: Change redundant request parameters to response parameters and add more parameters to response parameters table. http://developer.openstack.org/api-ref/orchestration/ v1/?expanded=list-versions-detail Change-Id: I392af2faa54940f93ce1344e5e880a5583099608
2016-08-31 17:25:51 +07:00
- id: version_id
- status: version_status
- links: links
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
Response Example
----------------
.. literalinclude:: samples/versions-list-response.json
:language: javascript
Copy Permalink