summaryrefslogtreecommitdiff
path: root/placement-api-ref/source/root.inc
blob: f27edf40c1fb2e695aa3d33de79503ce72c5978e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
============
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
=============

.. 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

Response Example
----------------

.. literalinclude:: ./samples/root/get-root.json
   :language: javascript