openstack
/
nova
Code Issues Proposed changes

docs: add microversions description in the concept doc 

This patch adds generic description for microversions. We will write
more use-cases in later patches.

blueprint complete-todo-in-api-concept-doc

Change-Id: I600ad4186a38eaffbec38bb15b2de0146c076abf
This commit is contained in:
He Jie Xu 2015-12-08 10:25:14 +08:00
parent 3f8c69b2ef
commit 50aa74f91d
1 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
api-guide/source/microversions.rst
View File

@ -11,11 +11,26 @@
License for the specific language governing permissions and limitations
under the License.
==============
=============
Microversions
==============
=============
API v2.1 users micro versions, instead of extensions, to allow for the API
to slowly evolve over time, without breaking any existing users.
API v2.1 supports Microversions. User uses Microversions to discover the
supported API version in the cloud. If cloud is upgraded to support newer
versions, it will still support all older versions to maintain the backward
compatibility for users using older versions. Also user can discover new
features easily with Microversions, then user can take all the advantages of
current cloud.
TODO - add more information.
There are multiple cases which you can resolve with Microversions:
Legacy v2 API user with new cloud
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The minimum version of Microversions is `2.1`, this is a version compatible
with legacy v2 API. The legacy v2 API user don't need to worry about that his
old client is broken with new cloud deployment. Cloud operator don't need to
worry that upgrading cloud to newer versions will break any user with old
client.
TODO: add more use-cases for Microversions