84b1d89a80
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
46 lines
723 B
ReStructuredText
46 lines
723 B
ReStructuredText
.. -*- rst -*-
|
|
|
|
==========
|
|
Build info
|
|
==========
|
|
|
|
Show build information
|
|
======================
|
|
|
|
.. rest_method:: GET /v1/{tenant_id}/build_info
|
|
|
|
Shows build information for an Orchestration deployment.
|
|
|
|
Response Codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 401
|
|
|
|
Request Parameters
|
|
------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- X-Openstack-Request-Id: request_id
|
|
- api: build_api
|
|
- engine: build_engine
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/build-info-response.json
|
|
:language: javascript
|