summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorKaifeng Wang <kaifeng.w@gmail.com>2018-06-05 20:33:00 +0800
committerRuby Loo <opensrloo@gmail.com>2018-06-06 13:20:55 +0000
commit8ee2f4b58f62d2c96e7da640e17102e979322eb1 (patch)
tree1f842d4927156cebda00c0d06029b7b6263709f9 /api-ref
parentd69dc019cb0573a3edcbff3ccca479cefc5ec67c (diff)
downloadironic-8ee2f4b58f62d2c96e7da640e17102e979322eb1.tar.gz
Power fault recovery follow up
This patch addresses comments relate to API and notification. [1] https://review.openstack.org/#/c/558152 [2] https://review.openstack.org/#/c/556015/ Story: #1596107 Task: #10469 Change-Id: Ic2f7e6847790ae7af43570ca7af572539e7d5f2c
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/baremetal-api-v1-nodes.inc4
-rw-r--r--api-ref/source/parameters.yaml3
2 files changed, 6 insertions, 1 deletions
diff --git a/api-ref/source/baremetal-api-v1-nodes.inc b/api-ref/source/baremetal-api-v1-nodes.inc
index 40f6195db..e85d5f279 100644
--- a/api-ref/source/baremetal-api-v1-nodes.inc
+++ b/api-ref/source/baremetal-api-v1-nodes.inc
@@ -212,6 +212,9 @@ provision state, and maintenance setting for each Node.
Added the ``resource_class`` Request parameter, allowing the list of returned
Nodes to be filtered by this field.
+.. versionadded:: 1.42
+ Introduced the ``fault`` field.
+
Normal response codes: 200
Error codes: 400,403,406
@@ -227,6 +230,7 @@ Request
- provision_state: r_provision_state
- driver: r_driver
- resource_class: r_resource_class
+ - fault: r_fault
- fields: fields
- limit: limit
- marker: marker
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 982525c6c..3c81dc506 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -201,7 +201,8 @@ r_driver:
r_fault:
description: |
Filter the list of returned nodes, and only return those with the specified
- ``fault``.
+ ``fault``. Possible values are determined by faults supported by ironic,
+ e.g., ``power failure``, ``clean failure`` or ``rescue abort failure``.
in: query
required: false
type: string