summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorHa Van Tu <tuhv@vn.fujitsu.com>2016-08-31 17:25:51 +0700
committerHa Van Tu <tuhv@vn.fujitsu.com>2016-08-31 17:31:07 +0700
commita3df3f8335c1b864279cf185537be63462a4fe30 (patch)
tree2b8f876524507ad9e0b966bcfb695eda34e98459 /api-ref
parent575a3055d42b8152bec5b479fa5498a84d9d2452 (diff)
downloadheat-a3df3f8335c1b864279cf185537be63462a4fe30.tar.gz
[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
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/v1/parameters.yaml17
-rw-r--r--api-ref/source/v1/versions.inc5
2 files changed, 21 insertions, 1 deletions
diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml
index 6fce60bb5..f8605d8d5 100644
--- a/api-ref/source/v1/parameters.yaml
+++ b/api-ref/source/v1/parameters.yaml
@@ -1591,6 +1591,23 @@ updated_time:
in: body
required: true
type: string
+version_id:
+ type: string
+ in: body
+ required: true
+ description: >
+ A common name for the version in question. Informative only, it
+ has no real semantic meaning.
+version_status:
+ type: string
+ in: body
+ required: true
+ description: |
+ The status of this API version. This can be one of:
+
+ - ``CURRENT``: this is the preferred version of the API to use
+ - ``SUPPORTED``: this is an older, but still supported version of the API
+ - ``DEPRECATED``: a deprecated version of the API that is slated for removal
versions:
description: |
A list of all orchestration API versions. Each object in the list provides
diff --git a/api-ref/source/v1/versions.inc b/api-ref/source/v1/versions.inc
index 4b1d5f23a..8fbcaa5e5 100644
--- a/api-ref/source/v1/versions.inc
+++ b/api-ref/source/v1/versions.inc
@@ -23,13 +23,16 @@ Request Parameters
This operation does not accept a request body.
-Request Parameters
+Response Parameters
------------------
.. rest_parameters:: parameters.yaml
- X-Openstack-Request-Id: request_id
- versions: versions
+ - id: version_id
+ - status: version_status
+ - links: links
Response Example
----------------