openstack/ironic
Code Issues Proposed changes

Fix API docs for target_power_state response

Browse Source 
The API docs stated that the values of target_power_state in a
Node State Summary are the same as the valid input values in a Change
Node Power State request (i.e. they include "rebooting", "soft
rebooting", and "soft power off"). However, in actuality these are all
compressed to either "power on" or "power off" by the
_calculate_target_state() function.

Change-Id: I8c8b8c707102275a48233fc853acfb65f556946e
Story: #2007089
Task: 38115
This commit is contained in:
Zane Bitter 2020-01-14 16:33:45 -05:00
parent 9be5b37296
commit 6da62945bc
1 changed files with 1 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1565,8 +1565,7 @@ supported_boot_devices:
target_power_state: target_power_state:
description: | description: |
If a power state transition has been requested, this field represents the If a power state transition has been requested, this field represents the
requested (ie, "target") state either "power on", "power off", "rebooting", requested (ie, "target") state, either "power on" or "power off".
"soft power off" or "soft rebooting".
in: body in: body
required: true required: true
type: string type: string