openstack/api-sig
Code Issues Proposed changes

Clarify the status values in versions

Browse Source 
When querying for supported versions, the example shows a single API,
with a `status` key that has a value of 'CURRENT'. This patch clarifies
the other possible status values, and what they mean to the consumer.

Closes-Bug: #1636641

Change-Id: I2e5450c77b6f614cff206c352d6d8a23b4f8e9a3
This commit is contained in:
EdLeafe 2016-12-16 14:52:35 +00:00
parent e01a677e96
commit 0ba0491758
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
guidelines/microversion_specification.rst
View File

@ -159,6 +159,27 @@ provided by Nova::
"max_version" is maximum version, "min_version" is minimum version.
While it is typical for there to be a single API for a given service, it is
also sometimes useful to be able to offer more than one version of a given API.
Common examples of this are when an older version is still made available in
order to support clients that have not yet upgraded to the current version, or
when a new API version is being tested before it is released. To distinguish
these different APIs for the same service, the `status` value is used. The
following values can be returned for status:
============ =======
Status Meaning
============ =======
CURRENT The newest API that is currently being developed and improved.
Unless you need to support old code, use this API.
SUPPORTED An older version of the API. No new features will be added to
this version, but any bugs discovered in the code may be fixed.
DEPRECATED This API will be removed in the foreseeable future. You should
start planning on using alternatives.
EXPERIMENTAL This API is under development ('alpha'), and you can expect it to
change or even be removed.
============ =======
When the requested version is out of range for the server, the server returns
status code **406 Not Acceptable** along with a response body.