diff options
| author | Ruby Loo <ruby.loo@intel.com> | 2017-11-14 17:42:43 -0500 |
|---|---|---|
| committer | Ruby Loo <ruby.loo@intel.com> | 2017-11-14 17:47:01 -0500 |
| commit | c7e7d3076d9733b73d1c236548f301ff1d9aafc4 (patch) | |
| tree | e738208f30d4656f8b6f7e34c82a663b54f7b8bb | |
| parent | de7911b2cc289399e5ae8a030b703c69baca1d25 (diff) | |
| download | ironic-c7e7d3076d9733b73d1c236548f301ff1d9aafc4.tar.gz | |
update description for Change Node Power State
This updates the description of the
'PUT /v1/nodes/{node_ident}/states/power' request to mention that
Bare Metal API version 1.27 was when:
- the 'timeout' parameter was added
- the 'soft power off' and 'soft rebooting' values were made available
for the 'target' parameter
Change-Id: I1c720a2dd15eab1246ad672b9d7f2b8708ceec0b
| -rw-r--r-- | api-ref/source/baremetal-api-v1-node-management.inc | 7 | ||||
| -rw-r--r-- | api-ref/source/parameters.yaml | 2 |
2 files changed, 8 insertions, 1 deletions
diff --git a/api-ref/source/baremetal-api-v1-node-management.inc b/api-ref/source/baremetal-api-v1-node-management.inc index 3e6c6d9d0..7e4c01e71 100644 --- a/api-ref/source/baremetal-api-v1-node-management.inc +++ b/api-ref/source/baremetal-api-v1-node-management.inc @@ -302,6 +302,13 @@ Request a change to the Node's power state. Normal response code: 202 (Accepted) +.. versionadded:: 1.27 + In the request, the ``target`` value can also be one of ``soft power off`` + or ``soft rebooting``. + +.. versionadded:: 1.27 + In the request, a ``timeout`` can be specified. + Error codes: - 409 (NodeLocked, ClientError) - 400 (Invalid, InvalidStateRequested, InvalidParameterValue) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 3a72555bb..8c201ac77 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -873,7 +873,7 @@ power_state: type: string power_timeout: description: | - Timeout for a power state transition. + Timeout (in seconds) for a power state transition. in: body required: false type: integer |