placement/placement-api-ref/source
Chris Dent 71e0ae2433 [placement] Add status and links fields to version document at /
According to the spec [1] the version discovery doc must have a status
and links for each version. For the primary version the status value
should be 'CURRENT'. For placement the version discovery doc and "self"
are the same thing, so the provided "self" href looks redundant, but it
makes keystoneauth1 happy when doing version discovery.

In placement, since there is only one version at the moment, set status
to CURRENT.

Add a gabbi test that verifies the presence of both fields and values.

Without these fields, use of placement with a client that follows the
documented version discovery process will fail to work.

As the version doc is not considered microversioned[2] and in any case
this is making version discovery work where it didn't before, this is
not a candidate for a microversion and can be backported to the
beginning of placement's history if we like.

I've updated the api-ref docs. In the process I made the max
microversion in the sample discovery doc a bit more realistic and
in alignment with these modern times.

[1] http://specs.openstack.org/openstack/api-wg/guidelines/microversion_specification.html#version-discovery
[2] http://eavesdrop.openstack.org/irclogs/%23openstack-sdks/%23openstack-sdks.2018-06-13.log.html#t2018-06-13T13:40:12

Change-Id: Ie602ab1768efbf103563d8f6b9d28965fc81021a
Closes-Bug: #1776668
2018-06-14 14:32:07 +00:00
..
samples [placement] Add status and links fields to version document at / 2018-06-14 14:32:07 +00:00
aggregates.inc placement: generation in provider aggregate APIs 2018-03-14 17:08:52 -05:00
allocation_candidates.inc placement: Granular GET /allocation_candidates 2018-05-08 11:54:30 -05:00
allocations.inc [placement] Move body examples to an isolated directory 2018-02-08 21:59:19 +00:00
conf.py doc: Start using openstackdoctheme's extlink extension 2018-05-03 14:34:47 +01:00
index.rst doc: Start using openstackdoctheme's extlink extension 2018-05-03 14:34:47 +01:00
inventories.inc [placement] Move body examples to an isolated directory 2018-02-08 21:59:19 +00:00
inventory.inc [placement] Move body examples to an isolated directory 2018-02-08 21:59:19 +00:00
parameters.yaml [placement] Add status and links fields to version document at / 2018-06-14 14:32:07 +00:00
request-ids.inc [placement] Add x-openstack-request-id in API ref 2017-12-18 06:02:44 +00:00
resource_class.inc [placement] Move body examples to an isolated directory 2018-02-08 21:59:19 +00:00
resource_classes.inc [placement] Move body examples to an isolated directory 2018-02-08 21:59:19 +00:00
resource_provider_allocations.inc [placement] Move body examples to an isolated directory 2018-02-08 21:59:19 +00:00
resource_provider_traits.inc [placement] Move body examples to an isolated directory 2018-02-08 21:59:19 +00:00
resource_provider_usages.inc [placement] Move body examples to an isolated directory 2018-02-08 21:59:19 +00:00
resource_provider.inc placement: Return new provider from POST /rps 2018-03-14 17:08:55 -05:00
resource_providers.inc placement: Granular GET /allocation_candidates 2018-05-08 11:54:30 -05:00
root.inc [placement] Add status and links fields to version document at / 2018-06-14 14:32:07 +00:00
traits.inc [placement] Move body examples to an isolated directory 2018-02-08 21:59:19 +00:00
usages.inc [placement] Move body examples to an isolated directory 2018-02-08 21:59:19 +00:00