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
This commit is contained in:
Tetsuro Nakamura 2019-03-16 22:10:45 +00:00
parent e69366675a
commit f4f98293d1
1 changed files with 5 additions and 0 deletions

View File

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