openstack
/
nova
Code Issues Proposed changes

placement: Document request headers in api-ref 

Briefly document in the Placement API reference:

a) the use of Content-Type: application/json
b) how to use microversion headers, including a link to the main
Microversions reference.

Change-Id: I60d7b9dfe4f1c50fc50eaf07a04848c220ffcf62
This commit is contained in:
Eric Fried 2017-11-20 09:38:58 -06:00
parent 57bf7f49cf
commit 44b77d887a
2 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
placement-api-ref/source/index.rst
View File

@ -8,6 +8,10 @@ This is a reference for the Openstack Placement API. To learn more about
Openstack Placement API concepts, please refer to the
`Placement Introduction <https://docs.openstack.org/nova/latest/user/placement.html>`_.
The Placement API uses JSON for data exchange. As such, the ``Content-Type``
header for APIs sending data payloads in the request body (i.e. ``PUT`` and
``POST``) must be set to ``application/json`` unless otherwise noted.
.. rest_expand_all::
.. include:: root.inc

23
placement-api-ref/source/root.inc
View File

@ -1,6 +1,23 @@
========
Versions
========
============
API Versions
============
In order to bring new features to users over time, the Placement API
supports microversioning. Microversions allow use of certain features on a
per-request basis via the ``OpenStack-API-Version`` header. For example, to
request microversion 1.10, specify the header::
Openstack-API-Version: placement 1.10
For more details about Microversions, please reference:
`Microversions
<https://developer.openstack.org/api-guide/compute/microversions.html>`_
.. note:: The maximum microversion supported by each release varies.
Please reference:
`REST API Version History
<https://docs.openstack.org/nova/latest/user/placement.html#rest-api-version-history>`__
for API microversion history details.
List Versions
=============