nova/placement-api-ref/source
Chris Dent df15426863 [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.

Changes:
  placement-api-ref/source/get-root.json

NOTE(stephenfin): Modified the root API sample to reflect the max
placement API version in Queens.

[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
(cherry picked from commit 1a5a3a9bc8)
2020-09-11 14:15:54 +01:00
..
aggregates.inc [placement] Add api-ref for aggregates 2017-06-08 15:32:33 +00:00
allocation_candidates.inc placement: support traits in allocation candidates API 2018-01-22 22:10:10 +08:00
allocations.inc [placement]Enhance doc for placement allocation list 2017-11-30 20:41:08 +00:00
conf.py trivial: Remove crud from 'conf.py' 2018-01-18 10:39:24 +00:00
create-resource_classes-request.json [placement] Add api-ref for resource classes 2017-06-05 14:39:29 +03:00
create-resource_providers-request.json placement: adds REST API for nested providers 2017-12-06 10:48:09 -06:00
get-aggregates.json [placement] Add api-ref for aggregates 2017-06-08 15:32:33 +00:00
get-allocation_candidates-1.12.json [placement] Symmetric GET and PUT /allocations/{consumer_uuid} 2017-11-21 19:39:59 +00:00
get-allocation_candidates.json [placement] Add api-ref for allocation_candidates 2017-08-10 11:26:19 +00:00
get-allocations.json [placement] Symmetric GET and PUT /allocations/{consumer_uuid} 2017-11-21 19:39:59 +00:00
get-inventories.json [placement] Add api-ref for GET RP inventories 2017-05-27 10:15:12 +00:00
get-inventory.json [placement] Add api-ref for GET RP inventory 2017-05-29 09:18:32 +03:00
get-resource_class.json [placement] Add api-ref for resource classes 2017-06-05 14:39:29 +03:00
get-resource_classes.json [placement] Add api-ref for resource classes 2017-06-05 14:39:29 +03:00
get-resource_provider-traits.json [placement] Add api-ref for RP traits 2017-07-18 12:44:08 +03:00
get-resource_provider.json placement: adds REST API for nested providers 2017-12-06 10:48:09 -06:00
get-resource_provider_allocations.json [placement] Add api-ref for RP allocations 2017-08-07 12:06:53 +03:00
get-resource_provider_usages.json [placement] Add api-ref for RP usages 2017-08-10 09:37:27 +00:00
get-resource_providers.json placement: adds REST API for nested providers 2017-12-06 10:48:09 -06:00
get-root.json [placement] Add status and links fields to version document at / 2020-09-11 14:15:54 +01:00
get-traits.json [placement] Add api-ref for traits 2017-07-18 12:44:04 +03:00
get-usages.json [placement] Add api-ref for usages 2017-08-09 15:54:48 +00:00
index.rst Fix OpenStack capitalization 2018-01-07 12:38:39 +01:00
inventories.inc placement doc: Conflict caveat for DELETE APIs 2018-02-05 17:34:35 +00:00
inventory.inc [placement] Fix parameter order in placement API ref 2017-11-23 21:01:07 +00:00
manage-allocations-request.json [placement] POST /allocations to set allocations for >1 consumers 2017-11-28 12:15:53 +00:00
parameters.yaml [placement] Add status and links fields to version document at / 2020-09-11 14:15:54 +01: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] Add 'Location' parameters in API ref 2017-12-07 21:00:43 +00:00
resource_classes.inc Doc: Nix os-traits link from POST resource_classes 2018-02-02 18:00:21 -06:00
resource_provider.inc Handle CannotDeleteParentResourceProvider to 409 Conflict 2018-06-28 13:50:18 +00:00
resource_provider_allocations.inc [placement] Add api-ref for RP allocations 2017-08-07 12:06:53 +03:00
resource_provider_traits.inc placement doc: Conflict caveat for DELETE APIs 2018-02-05 17:34:35 +00:00
resource_provider_usages.inc [placement] Add api-ref for RP usages 2017-08-10 09:37:27 +00:00
resource_providers.inc Merge "[placement] Add 'Location' parameters in API ref" 2017-12-14 14:26:12 +00:00
root.inc [placement] Add status and links fields to version document at / 2020-09-11 14:15:54 +01:00
traits.inc Fix OpenStack capitalization 2018-01-07 12:38:39 +01:00
update-aggregates-request.json [placement] Add api-ref for aggregates 2017-06-08 15:32:33 +00:00
update-aggregates.json [placement] Add api-ref for aggregates 2017-06-08 15:32:33 +00:00
update-allocations-request-1.12.json [placement] Symmetric GET and PUT /allocations/{consumer_uuid} 2017-11-21 19:39:59 +00:00
update-allocations-request.json [placement] Add api-ref for allocations 2017-07-18 13:06:12 +03:00
update-inventories-request.json [placement] Add api-ref for PUT RP inventories 2017-05-29 09:18:32 +03:00
update-inventories.json [placement] Add api-ref for PUT RP inventories 2017-05-29 09:18:32 +03:00
update-inventory-request.json [placement] Add api-ref for PUT RP inventory 2017-05-29 09:18:32 +03:00
update-inventory.json [placement] Add api-ref for PUT RP inventory 2017-05-29 09:18:32 +03:00
update-resource_class-request.json [placement] Add api-ref for resource classes 2017-06-05 14:39:29 +03:00
update-resource_class.json [placement] Add api-ref for resource classes 2017-06-05 14:39:29 +03:00
update-resource_provider-request.json placement: adds REST API for nested providers 2017-12-06 10:48:09 -06:00
update-resource_provider-traits-request.json [placement] Add api-ref for RP traits 2017-07-18 12:44:08 +03:00
update-resource_provider-traits.json [placement] Add api-ref for RP traits 2017-07-18 12:44:08 +03:00
update-resource_provider.json [placement] Fix API reference for microversion 1.14 2017-12-11 11:37:31 +09:00
usages.inc [placement] Add api-ref for usages 2017-08-09 15:54:48 +00:00