From 84360f693fbaa8c6b4993d30c1ddf6db547ec770 Mon Sep 17 00:00:00 2001
From: Matt Riedemann <mriedem.os@gmail.com>
Date: Fri, 8 Sep 2017 16:02:27 -0400
Subject: [PATCH] api-ref: note the microversions for GET /resource_providers
 query params

The member_of query parameter was new in 1.3.

The resources query parameter was new in 1.4.

As a result, the 'resources' parameter description used for
allocation_candidates has to be decoupled since the entire
allocation_candidates API was new in 1.10 and is not specified
per parameter.

Change-Id: I6e0688b4a12212ace98a6876132735094df84b77
Closes-Bug: #1716046
---
 placement-api-ref/source/parameters.yaml | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/placement-api-ref/source/parameters.yaml b/placement-api-ref/source/parameters.yaml
index cbd55e1f90f5..3d6040b08296 100644
--- a/placement-api-ref/source/parameters.yaml
+++ b/placement-api-ref/source/parameters.yaml
@@ -33,6 +33,7 @@ member_of:
     A comma-separated list of strings representing aggregate uuids.
     The returned resource providers must be associated with at
     least one of the aggregates identified by uuid.
+  min_version: 1.3
 project_id: &project_id
   type: string
   in: query
@@ -49,7 +50,7 @@ resource_provider_uuid_query:
   <<: *resource_provider_uuid_path
   in: query
   required: false
-resources_query: &resources_query
+resources_query:
   type: string
   in: query
   required: false
@@ -59,9 +60,17 @@ resources_query: &resources_query
     capacity to serve::
 
         resources=VCPU:4,DISK_GB:64,MEMORY_MB:2048
+  min_version: 1.4
 resources_query_required:
-  <<: *resources_query
+  type: string
+  in: query
   required: true
+  description: |
+    A comma-separated list of strings indicating an amount of
+    resource of a specified class that a provider must have the
+    capacity to serve::
+
+        resources=VCPU:4,DISK_GB:64,MEMORY_MB:2048
 trait_associated:
   type: string
   in: query