From f4f98293d1601e70c34e14504e2892f0b23f21c2 Mon Sep 17 00:00:00 2001 From: Tetsuro Nakamura Date: Sat, 16 Mar 2019 22:10:45 +0000 Subject: [PATCH] Add link to case studies in alloc_cands api-ref This patch adds a link to case studies for `GET /allocation_candidates` API in the api reference. Change-Id: I21a73bd1c9056c7ea365bcef43caeee4377e9166 --- api-ref/source/allocation_candidates.inc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/api-ref/source/allocation_candidates.inc b/api-ref/source/allocation_candidates.inc index 90da3cf13..c0cd61b12 100644 --- a/api-ref/source/allocation_candidates.inc +++ b/api-ref/source/allocation_candidates.inc @@ -18,6 +18,9 @@ inventory/capacity information. For example, this information is used by nova-scheduler's FilterScheduler to make decisions about on which compute host to build a server. +You can also find additional case studies of the request parameters in the +`Modeling with Provider Trees`_ document. + .. rest_method:: GET /allocation_candidates Normal Response Codes: 200 @@ -92,3 +95,5 @@ Response Example (microversions 1.10 - 1.11) .. literalinclude:: ./samples/allocation_candidates/get-allocation_candidates.json :language: javascript + +.. _`Modeling with Provider Trees`: https://docs.openstack.org/placement/latest/usage/provider-tree.html