From c7e7d3076d9733b73d1c236548f301ff1d9aafc4 Mon Sep 17 00:00:00 2001
From: Ruby Loo <ruby.loo@intel.com>
Date: Tue, 14 Nov 2017 17:42:43 -0500
Subject: [PATCH] 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
---
 api-ref/source/baremetal-api-v1-node-management.inc | 7 +++++++
 api-ref/source/parameters.yaml                      | 2 +-
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/api-ref/source/baremetal-api-v1-node-management.inc b/api-ref/source/baremetal-api-v1-node-management.inc
index 3e6c6d9d0c..7e4c01e716 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 3a72555bba..8c201ac770 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