summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2019-03-01 11:08:48 +0000
committerGerrit Code Review <review@openstack.org>2019-03-01 11:08:48 +0000
commit84f6e5fb84f9cdb0eb1e9c9d37f2247e32a61637 (patch)
treef8493cdb14b8232d9d79a4a5d1ffc271ec0a8774 /api-ref
parentb277be27a9cd4505679c71a5b69653242f9f09ea (diff)
parente0639875f4e2b18095e2599639dd410ac3027661 (diff)
downloadironic-84f6e5fb84f9cdb0eb1e9c9d37f2247e32a61637.tar.gz
Merge "Adding bios_interface reference to api docs"
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/baremetal-api-v1-drivers.inc4
-rw-r--r--api-ref/source/parameters.yaml13
-rw-r--r--api-ref/source/samples/driver-get-response.json4
-rw-r--r--api-ref/source/samples/drivers-list-detail-response.json8
4 files changed, 29 insertions, 0 deletions
diff --git a/api-ref/source/baremetal-api-v1-drivers.inc b/api-ref/source/baremetal-api-v1-drivers.inc
index d10335b0e..b7d851814 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 635eeb14a..0e0c1eb08 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -577,6 +577,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
@@ -703,6 +710,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 552eb8a3d..87cbcb1d3 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 789b90a96..d3d93c8ce 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"
],