summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBob Fournier <bfournie@redhat.com>2021-05-19 12:26:50 -0400
committerBob Fournier <bfournie@redhat.com>2021-05-21 09:16:40 -0400
commit9a09f1bdc99b827bb6fe0ac5b44be5904ec12368 (patch)
treee9523ee7df3ffef3360326e4ba2c09ba68c9ba4b
parent9a8b501e5c66a1f31adcfcc342f677a6288188fc (diff)
downloadironic-9a09f1bdc99b827bb6fe0ac5b44be5904ec12368.tar.gz
Add missing bios_interface to api-ref for validate API
Fixing another case of bios interface missing from the api-ref documentation, this one for the validate API. Change-Id: I8ae3212f04a8d150af8adde5f5f87e5a5451da14
-rw-r--r--api-ref/source/baremetal-api-v1-node-management.inc1
-rw-r--r--api-ref/source/parameters.yaml6
-rw-r--r--releasenotes/notes/bios-interface-api-ref-validate-ddb95461adb0e478.yaml5
3 files changed, 12 insertions, 0 deletions
diff --git a/api-ref/source/baremetal-api-v1-node-management.inc b/api-ref/source/baremetal-api-v1-node-management.inc
index 0d543a669..96f3e833a 100644
--- a/api-ref/source/baremetal-api-v1-node-management.inc
+++ b/api-ref/source/baremetal-api-v1-node-management.inc
@@ -66,6 +66,7 @@ the Node's driver does not support that interface.
.. rest_parameters:: parameters.yaml
+ - bios: v_bios
- boot: v_boot
- console: v_console
- deploy: v_deploy
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 2db02f853..5129333f0 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -1844,6 +1844,12 @@ uuid:
type: string
# variables returned from node-validate
+v_bios:
+ description: |
+ Status of the "bios" interface
+ in: body
+ required: true
+ type: object
v_boot:
description: |
Status of the "boot" interface
diff --git a/releasenotes/notes/bios-interface-api-ref-validate-ddb95461adb0e478.yaml b/releasenotes/notes/bios-interface-api-ref-validate-ddb95461adb0e478.yaml
new file mode 100644
index 000000000..93a6dd822
--- /dev/null
+++ b/releasenotes/notes/bios-interface-api-ref-validate-ddb95461adb0e478.yaml
@@ -0,0 +1,5 @@
+---
+fixes:
+ - |
+ The bios_interface is returned in the node validate API but it's not in the
+ api-ref documentation. This change adds it to the documentation.