openstack/ironic
Code Issues Proposed changes

update description for Change Node Power State

Browse Source 
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
This commit is contained in:
Ruby Loo 2017-11-14 17:42:43 -05:00
parent de7911b2cc
commit c7e7d3076d
2 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
api-ref/source/baremetal-api-v1-node-management.inc
View File

@ -302,6 +302,13 @@ Request a change to the Node's power state.
Normal response code: 202 (Accepted) 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: Error codes:
- 409 (NodeLocked, ClientError) - 409 (NodeLocked, ClientError)
- 400 (Invalid, InvalidStateRequested, InvalidParameterValue) - 400 (Invalid, InvalidStateRequested, InvalidParameterValue)

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

@ -873,7 +873,7 @@ power_state:
type: string type: string
power_timeout: power_timeout:
description: | description: |
Timeout for a power state transition. Timeout (in seconds) for a power state transition.
in: body in: body
required: false required: false
type: integer type: integer