openstack/cinder
Code Issues Proposed changes

Small change to microversion header on devref

Browse Source 
The way the API microversion dev ref is rendered can lead to a confusion
on the required header, as it reads:

 volume: OpenStack-API-Version: volume 3.0

This patch makes a small change so that the actual header is standing on
its own.

TrivialFix

Change-Id: Ibbc90ef55e2b3bfe746ee9fcfda686491469a5d2
This commit is contained in:
Gorka Eguileor 2017-01-26 11:51:07 +01:00
parent a53068f23c
commit 893eb180f1
1 changed files with 7 additions and 3 deletions

10
doc/source/devref/api_microversion_dev.rst

@ -11,9 +11,13 @@ a particular version of the API. So breaking changes can be added to
the API without breaking users who don't specifically ask for it. This
is done with an HTTP header ``OpenStack-API-Version`` which
is a monotonically increasing semantic version number starting from
``3.0``. Each service that uses microversions will share this header, so
the Volume service will need to specify ``volume``:
``OpenStack-API-Version: volume 3.0``
``3.0``.
Each OpenStack service that uses microversions will share this header, so
the Volume service will need to prefix the semantic version number with the
word ``volume``::
OpenStack-API-Version: volume 3.0
If a user makes a request without specifying a version, they will get
the ``DEFAULT_API_VERSION`` as defined in