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
39 lines
578 B
ReStructuredText
39 lines
578 B
ReStructuredText
.. -*- 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.
|
|
|
|
Request Parameters
|
|
------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- X-Openstack-Request-Id: request_id
|
|
- versions: versions
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/versions-list-response.json
|
|
:language: javascript
|