diff options
| author | Dmitry Tantsur <divius.inside@gmail.com> | 2019-02-26 11:13:07 +0100 |
|---|---|---|
| committer | Dmitry Tantsur <divius.inside@gmail.com> | 2019-02-26 11:13:07 +0100 |
| commit | 08270cebab61c889b1780b33232e4965e456dbd6 (patch) | |
| tree | c5372af042efde4a39114dc742887d226d1d9afb /api-ref | |
| parent | ba83855111b6d41595be7c1fff6b4c254519b793 (diff) | |
| download | ironic-08270cebab61c889b1780b33232e4965e456dbd6.tar.gz | |
Allocation API: fix minor issues in the API reference
Follow-up to commit acc4c402de42be0b1fb179d13dcf86a4ca384206.
Change-Id: Ie519caf791b6444afdc5a8665b1fbd719f916388
Story: #2004341
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/baremetal-api-v1-allocation.inc | 6 | ||||
| -rw-r--r-- | api-ref/source/baremetal-api-v1-node-allocation.inc | 2 | ||||
| -rw-r--r-- | api-ref/source/parameters.yaml | 4 |
3 files changed, 6 insertions, 6 deletions
diff --git a/api-ref/source/baremetal-api-v1-allocation.inc b/api-ref/source/baremetal-api-v1-allocation.inc index e94739b93..a233a6dbb 100644 --- a/api-ref/source/baremetal-api-v1-allocation.inc +++ b/api-ref/source/baremetal-api-v1-allocation.inc @@ -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. diff --git a/api-ref/source/baremetal-api-v1-node-allocation.inc b/api-ref/source/baremetal-api-v1-node-allocation.inc index 2a4bf598b..4bb7b86c3 100644 --- a/api-ref/source/baremetal-api-v1-node-allocation.inc +++ b/api-ref/source/baremetal-api-v1-node-allocation.inc @@ -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. diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 205cb1401..635eeb14a 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -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 |