Add API document for build_info

This patch adds API document for build_info.

Change-Id: I5075fc7f9f8b91748458059e51ffaf5b4e121ed6
This commit is contained in:
yanyanhu 2016-05-15 23:22:17 -04:00
parent a3a361a5de
commit abf644b0cc
4 changed files with 74 additions and 0 deletions

View File

@ -0,0 +1,44 @@
==============================
Build information (build-info)
==============================
Shows build information for a Senlin deployment.
Shows build information
=======================
.. rest_method:: GET /v1/build-info
Shows build information for a Senlin deployment.
Normal response codes: 200
Error response codes:
- unauthorized (401)
- forbidden (403)
- serviceUavailable (503)
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- OpenStack-API-Version: microversion
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- build_info: build_info
- api: build_info_api
- engine: build_info_engine
Response Example
----------------
.. literalinclude:: samples/build-show-response.json
:language: javascript
This operation does not accept a request body.

View File

@ -5,6 +5,8 @@ Clustering API
==============
.. include:: versions.inc
.. include:: build_info.inc
.. include:: policy_types.inc
.. include:: profile_types.inc
.. include:: profiles.inc
.. include:: policy_types.inc

View File

@ -175,6 +175,24 @@ adjustment_type:
When this paramter is specified, the ``number`` parameter has to be
provided as well.
build_info:
type: object
in: body
description: |
Build information for a Senlin deployment.
build_info_api:
type: object
in: build_info
description: |
Revision information of Senlin API service.
build_info_engine:
type: object
in: build_info
description: |
Revision information of Senlin engine service.
cause:
type: string
in: action

View File

@ -0,0 +1,10 @@
{
"build_info": {
"api": {
"revision": "1.0"
},
"engine": {
"revision": "2.0"
}
}
}