api-ref: Fix v3 API version details error

Show v3 API version details should not return informations about v2,
meanwhile location is not in Response Parameters.

Change-Id: Ida12222b3bdac10d030d56b9724f09ee097c0b3c
This commit is contained in:
Dongcan Ye 2018-05-25 08:06:52 +00:00
parent 910f534382
commit b8078a8e38
3 changed files with 63 additions and 25 deletions

View File

@ -1505,6 +1505,12 @@ links_5:
in: body
required: false
type: array
links_6:
description: |
Links to the resources in question.
in: body
required: true
type: array
location:
description: |
Full URL to a service or server.
@ -1586,6 +1592,18 @@ maxTotalVolumesOptional:
in: body
required: false
type: integer
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
message_level:
description: |
The level of the message, possible value is
@ -2694,6 +2712,44 @@ vendor_name:
in: body
required: true
type: string
version_id:
in: body
required: true
description: |
A common name for the version in question. Informative only, it
has no real semantic meaning.
type: string
version_max:
in: body
required: true
description: |
If this version of the API supports microversions, the maximum
microversion that is supported. This will be the empty string if
microversions are not supported.
type: string
version_min:
in: body
required: true
description: |
If this version of the API supports microversions, the minimum
microversion that is supported. This will be the empty string if
microversions are not supported.
type: string
version_status:
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
- ``DEPRECATED``: a deprecated version of the API that is slated for removal
type: string
version_updated:
description: |
This is a fixed string that API version updates.
in: body
required: true
type: string
visibility:
description: |
The volume type access.

View File

@ -1,29 +1,5 @@
{
"versions": [
{
"id": "v2.0",
"links": [
{
"href": "https://docs.openstack.org/",
"rel": "describedby",
"type": "text/html"
},
{
"href": "http://23.253.248.171:8776/v2/",
"rel": "self"
}
],
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"min_version": "",
"status": "SUPPORTED",
"updated": "2014-06-28T12:20:21Z",
"version": ""
},
{
"id": "v3.0",
"links": [

View File

@ -31,7 +31,13 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- location: location
- status: version_status
- updated: version_updated
- links: links_6
- min_version: version_min
- version: version_max
- media-types: media_types
- id: version_id
Response Example
----------------