openstack/ironic
Code Issues Proposed changes

Allocation API: fix minor issues in the API reference

Browse Source 
Follow-up to commit acc4c402de.

Change-Id: Ie519caf791b6444afdc5a8665b1fbd719f916388
Story: #2004341
This commit is contained in:
Dmitry Tantsur 2019-02-26 11:13:07 +01:00
parent ba83855111
commit 08270cebab
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api-ref/source/baremetal-api-v1-allocation.inc
View File

@ -26,13 +26,13 @@ A Node is suitable for an Allocation if all of the following holds:
* ``provision_state`` is ``available``
* ``power_state`` is not ``null``
* ``maintenance`` is false
* ``maintenance`` is ``false``
* ``instance_uuid`` is ``null``
* ``resource_class`` matches requested one
* ``traits`` list contains the requested ones
* ``traits`` list contains all of the requested ones
The allocation process is asynchronous. The new Allocation is returned in
the ``allocating`` state, and the process continues in background. If it
the ``allocating`` state, and the process continues in the background. If it
succeeds, the ``node_uuid`` field is populated with the Node's UUID, and the
Node's ``instance_uuid`` field is set to the Allocation's UUID.

2
api-ref/source/baremetal-api-v1-node-allocation.inc
View File

@ -61,7 +61,7 @@ Delete Allocation by Node
.. rest_method:: DELETE /v1/nodes/{node_ident}/allocation
Deletes the allocation of this node.
Deletes the allocation of this node and resets its ``instance_uuid``.
The deletion will fail if the allocation the node is ``active`` and not in
the ``maintenance`` mode.

4
api-ref/source/parameters.yaml
View File

@ -1215,8 +1215,8 @@ req_boot_interface:
type: string
req_candidate_nodes:
description: |
The list of nodes that should be considered for this allocation. If not
provided, all available nodes will be considered.
The list of nodes (names or UUIDs) that should be considered for this
allocation. If not provided, all available nodes will be considered.
in: body
required: false
type: array