7b3c179fe4
The api documentation is now published on docs.openstack.org instead of developer.openstack.org. Update all links that are changed to the new location. Note that redirects will be set up as well but let's point now to the new location. For details, see: http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html Change-Id: Iccddd4356b5d7c28977ad954654d0875972dae97
52 lines
1.3 KiB
PHP
52 lines
1.3 KiB
PHP
============
|
|
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://docs.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/placement/latest/placement-api-microversion-history.html>`__
|
|
for API microversion history details.
|
|
|
|
List Versions
|
|
=============
|
|
|
|
.. rest_method:: GET /
|
|
|
|
Fetch information about all known major versions of the placement API,
|
|
including information about the minimum and maximum microversions.
|
|
|
|
.. note:: At this time there is only one major version of the placement API:
|
|
version 1.0.
|
|
|
|
Normal Response Codes: 200
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- versions: versions
|
|
- id: version_id
|
|
- min_version: version_min
|
|
- max_version: version_max
|
|
- status: version_status
|
|
- links: version_links
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/root/get-root.json
|
|
:language: javascript
|