From 3a91dafb1ad9f7a0dc968fc84d8087288c1f5d5e Mon Sep 17 00:00:00 2001
From: Naohiro Tamura <naohirot@jp.fujitsu.com>
Date: Mon, 23 Jan 2017 14:56:18 +0900
Subject: [PATCH] Add Inject NMI to api-ref

This patch updates api-ref documentation with Inject NMI (Non-Masking
Interrupts) that were added in API microversion 1.29.

Partial-Bug: #1526226
Change-Id: I5003abcfd9a79751f40964c5bd5cb0bd550ba89d
---
 api-ref/regenerate-samples.sh                 |  4 ++-
 .../baremetal-api-v1-node-management.inc      | 30 +++++++++++++++++++
 api-ref/source/samples/api-root-response.json |  4 +--
 api-ref/source/samples/node-inject-nmi.json   |  1 +
 4 files changed, 36 insertions(+), 3 deletions(-)
 create mode 100644 api-ref/source/samples/node-inject-nmi.json

diff --git a/api-ref/regenerate-samples.sh b/api-ref/regenerate-samples.sh
index d35113cf97..13794e301e 100755
--- a/api-ref/regenerate-samples.sh
+++ b/api-ref/regenerate-samples.sh
@@ -11,7 +11,7 @@ fi
 OS_AUTH_TOKEN=$(openstack token issue | grep ' id ' | awk '{print $4}')
 IRONIC_URL="http://127.0.0.1:6385"
 
-IRONIC_API_VERSION="1.28"
+IRONIC_API_VERSION="1.29"
 
 export OS_AUTH_TOKEN IRONIC_URL
 
@@ -238,6 +238,8 @@ GET v1/nodes/$NID/management/boot_device/supported > node-get-supported-boot-dev
 PUT v1/nodes/$NID/management/boot_device node-set-boot-device.json
 GET v1/nodes/$NID/management/boot_device > node-get-boot-device-response.json
 
+PUT v1/nodes/$NID/management/inject_nmi node-inject-nmi.json
+
 #############################
 # NODES VIF ATTACH/DETACH API
 
diff --git a/api-ref/source/baremetal-api-v1-node-management.inc b/api-ref/source/baremetal-api-v1-node-management.inc
index daae5fe02e..791535ce72 100644
--- a/api-ref/source/baremetal-api-v1-node-management.inc
+++ b/api-ref/source/baremetal-api-v1-node-management.inc
@@ -223,6 +223,36 @@ Response
 .. literalinclude:: samples/node-get-supported-boot-devices-response.json
 
 
+Inject NMI (Non-Masking Interrupts)
+===================================
+
+.. rest_method:: PUT /v1/nodes/{node_ident}/management/inject_nmi
+
+Inject NMI (Non-Masking Interrupts) for the given Node. This feature
+can be used for hardware diagnostics, and actual support depends on a
+driver.
+
+Normal response code: 204 (No content)
+
+Error codes:
+    - 400 (Invalid)
+    - 403 (Forbidden)
+    - 404 (NotFound)
+    - 406 (NotAcceptable)
+    - 409 (NodeLocked, ClientError)
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+    - node_ident: node_ident
+
+**Request to inject NMI to a node has to be empty dictionary:**
+
+.. literalinclude:: samples/node-inject-nmi.json
+
+
 Node State Summary
 ==================
 
diff --git a/api-ref/source/samples/api-root-response.json b/api-ref/source/samples/api-root-response.json
index 16f548a611..ec4b77c897 100644
--- a/api-ref/source/samples/api-root-response.json
+++ b/api-ref/source/samples/api-root-response.json
@@ -9,7 +9,7 @@
     ],
     "min_version": "1.1",
     "status": "CURRENT",
-    "version": "1.28"
+    "version": "1.29"
   },
   "description": "Ironic is an OpenStack project which aims to provision baremetal machines.",
   "name": "OpenStack Ironic API",
@@ -24,7 +24,7 @@
       ],
       "min_version": "1.1",
       "status": "CURRENT",
-      "version": "1.28"
+      "version": "1.29"
     }
   ]
 }
diff --git a/api-ref/source/samples/node-inject-nmi.json b/api-ref/source/samples/node-inject-nmi.json
new file mode 100644
index 0000000000..0967ef424b
--- /dev/null
+++ b/api-ref/source/samples/node-inject-nmi.json
@@ -0,0 +1 @@
+{}