diff --git a/doc/source/devref/api_microversion_dev.rst b/doc/source/devref/api_microversion_dev.rst index 7508784098d..da3975bbd66 100644 --- a/doc/source/devref/api_microversion_dev.rst +++ b/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