From e0639875f4e2b18095e2599639dd410ac3027661 Mon Sep 17 00:00:00 2001
From: Riccardo Pittau <elfosardo@gmail.com>
Date: Mon, 25 Feb 2019 14:30:51 +0100
Subject: [PATCH] Adding bios_interface reference to api docs

As per title, this patch adds default_boot_interface and
enabled_boot_interfaces references, definitions and examples
to the api-ref documentation.

Change-Id: I35d4829c32cc48d5734c269c0a83ad9b4fbdd660
---
 api-ref/source/baremetal-api-v1-drivers.inc         |  4 ++++
 api-ref/source/parameters.yaml                      | 13 +++++++++++++
 api-ref/source/samples/driver-get-response.json     |  4 ++++
 .../samples/drivers-list-detail-response.json       |  8 ++++++++
 4 files changed, 29 insertions(+)

diff --git a/api-ref/source/baremetal-api-v1-drivers.inc b/api-ref/source/baremetal-api-v1-drivers.inc
index d10335b0eb..b7d8518140 100644
--- a/api-ref/source/baremetal-api-v1-drivers.inc
+++ b/api-ref/source/baremetal-api-v1-drivers.inc
@@ -80,6 +80,7 @@ drivers supported by this Ironic service.
 
 .. rest_parameters:: parameters.yaml
 
+   - default_bios_interface: default_bios_interface
    - default_boot_interface: default_boot_interface
    - default_console_interface: default_console_interface
    - default_deploy_interface: default_deploy_interface
@@ -91,6 +92,7 @@ drivers supported by this Ironic service.
    - default_rescue_interface: default_rescue_interface
    - default_storage_interface: default_storage_interface
    - default_vendor_interface: default_vendor_interface
+   - enabled_bios_interfaces: enabled_bios_interfaces
    - enabled_boot_interfaces: enabled_boot_interfaces
    - enabled_console_interfaces: enabled_console_interfaces
    - enabled_deploy_interfaces: enabled_deploy_interfaces
@@ -140,6 +142,7 @@ Response Parameters
    - name: driver_name
    - hosts: hosts
    - type: response_driver_type
+   - default_bios_interface: default_bios_interface
    - default_boot_interface: default_boot_interface
    - default_console_interface: default_console_interface
    - default_deploy_interface: default_deploy_interface
@@ -151,6 +154,7 @@ Response Parameters
    - default_rescue_interface: default_rescue_interface
    - default_storage_interface: default_storage_interface
    - default_vendor_interface: default_vendor_interface
+   - enabled_bios_interfaces: enabled_bios_interfaces
    - enabled_boot_interfaces: enabled_boot_interfaces
    - enabled_console_interfaces: enabled_console_interfaces
    - enabled_deploy_interfaces: enabled_deploy_interfaces
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index c5f9b80c9b..c822eb607b 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -502,6 +502,13 @@ d_bios_setting:
   in: body
   required: true
   type: dictionary
+default_bios_interface:
+  description: |
+    The default bios interface used for a node with a dynamic driver, if no
+    bios interface is specified for the node.
+  in: body
+  required: true
+  type: string
 default_boot_interface:
   description: |
     The default boot interface used for a node with a dynamic driver, if no
@@ -628,6 +635,12 @@ drivers:
   in: body
   required: true
   type: array
+enabled_bios_interfaces:
+  description: |
+    The enabled bios interfaces for this driver.
+  in: body
+  required: true
+  type: list
 enabled_boot_interfaces:
   description: |
     The enabled boot interfaces for this driver.
diff --git a/api-ref/source/samples/driver-get-response.json b/api-ref/source/samples/driver-get-response.json
index 552eb8a3d8..87cbcb1d34 100644
--- a/api-ref/source/samples/driver-get-response.json
+++ b/api-ref/source/samples/driver-get-response.json
@@ -1,4 +1,5 @@
 {
+  "default_bios_interface": "no-bios",
   "default_boot_interface": "pxe",
   "default_console_interface": "no-console",
   "default_deploy_interface": "iscsi",
@@ -10,6 +11,9 @@
   "default_rescue_interface": "no-rescue",
   "default_storage_interface": "noop",
   "default_vendor_interface": "no-vendor",
+  "enabled_bios_interfaces": [
+    "no-bios"
+  ],
   "enabled_boot_interfaces": [
     "pxe"
   ],
diff --git a/api-ref/source/samples/drivers-list-detail-response.json b/api-ref/source/samples/drivers-list-detail-response.json
index 789b90a967..d3d93c8cef 100644
--- a/api-ref/source/samples/drivers-list-detail-response.json
+++ b/api-ref/source/samples/drivers-list-detail-response.json
@@ -1,6 +1,7 @@
 {
   "drivers": [
     {
+      "default_bios_interface": null,
       "default_boot_interface": null,
       "default_console_interface": null,
       "default_deploy_interface": null,
@@ -12,6 +13,7 @@
       "default_rescue_interface": null,
       "default_storage_interface": null,
       "default_vendor_interface": null,
+      "enabled_bios_interfaces": null,
       "enabled_boot_interfaces": null,
       "enabled_console_interfaces": null,
       "enabled_deploy_interfaces": null,
@@ -50,6 +52,7 @@
       "type": "classic"
     },
     {
+      "default_bios_interface": null,
       "default_boot_interface": null,
       "default_console_interface": null,
       "default_deploy_interface": null,
@@ -61,6 +64,7 @@
       "default_rescue_interface": null,
       "default_storage_interface": null,
       "default_vendor_interface": null,
+      "enabled_bios_interfaces": null,
       "enabled_boot_interfaces": null,
       "enabled_console_interfaces": null,
       "enabled_deploy_interfaces": null,
@@ -99,6 +103,7 @@
       "type": "classic"
     },
     {
+      "default_bios_interface": "no-bios",
       "default_boot_interface": "pxe",
       "default_console_interface": "no-console",
       "default_deploy_interface": "iscsi",
@@ -110,6 +115,9 @@
       "default_rescue_interface": "no-rescue",
       "default_storage_interface": "noop",
       "default_vendor_interface": "no-vendor",
+      "enabled_bios_interfaces": [
+        "no-bios"
+      ],
       "enabled_boot_interfaces": [
         "pxe"
       ],