summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorTakashi NATSUME <natsume.takashi@lab.ntt.co.jp>2017-06-19 13:13:09 +0900
committerTakashi NATSUME <natsume.takashi@lab.ntt.co.jp>2017-06-28 03:01:10 +0000
commitd04ddb0a2bff3d91455962a94213e17d9693ee2d (patch)
tree24ea549753200765693a5783af1d71b64b102f6c /api-ref
parent09fd39b194eb527953be52e41984ee30436b61fd (diff)
downloadnova-d04ddb0a2bff3d91455962a94213e17d9693ee2d.tar.gz
api-ref: Fix missing parameters in API Versions
Add 'updated' and 'media-types' explicitly in parameter tables. Change-Id: I3e9f3374d4183d7ef7d3cb55cc95a4499ab20d49 Closes-Bug: #1634668
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/parameters.yaml23
-rw-r--r--api-ref/source/versions.inc21
2 files changed, 30 insertions, 14 deletions
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 02ae9ead27..2e0672226f 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -3415,6 +3415,18 @@ md5hash:
in: body
required: true
type: string
+media_types:
+ description: |
+ The `media types
+ <https://www.iana.org/assignments/media-types/media-types.xhtml>`_.
+ It is an array of a fixed dict.
+
+ .. note::
+ It is vestigial and provide no useful information.
+ It will be deprecated and removed in the future.
+ in: body
+ required: true
+ type: array
members:
description: |
A list of members in the server group.
@@ -5153,6 +5165,17 @@ updated_consider_null:
in: body
required: true
type: string
+updated_version:
+ description: |
+ This is a fixed string. It is ``2011-01-21T11:33:21Z`` in version 2.0,
+ ``2013-07-23T11:33:21Z`` in version 2.1.
+
+ .. note::
+ It is vestigial and provides no useful information.
+ It will be deprecated and removed in the future.
+ in: body
+ required: true
+ type: string
uptime:
description: |
The total uptime of the hypervisor and information about average
diff --git a/api-ref/source/versions.inc b/api-ref/source/versions.inc
index bc5cdfdfc5..2d07eb3c2f 100644
--- a/api-ref/source/versions.inc
+++ b/api-ref/source/versions.inc
@@ -44,15 +44,12 @@ Response
- versions: versions
- id: version_id
- - status: version_status
- links: links
- - version: version_max
- min_version: version_min
+ - status: version_status
+ - updated: updated_version
+ - version: version_max
-.. note::
-
- The ``updated`` parameter in the response is vestigial and provides
- no useful information.
Response Example
----------------
@@ -94,16 +91,12 @@ Response
- version: version
- id: version_id
- - status: version_status
- links: links
- - version: version_max
+ - media-types: media_types
- min_version: version_min
-
-.. note::
-
- The ``updated`` and ``media-types`` parameters in the response are
- vestigial and provide no useful information. They will probably be
- deprecated and removed in the future.
+ - status: version_status
+ - updated: updated_version
+ - version: version_max
Response Example