From 17d3b72b3daebd8afc307411de2e03fbed2ff505 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Harald=20Jens=C3=A5s?= <hjensas@redhat.com>
Date: Tue, 9 May 2023 15:29:25 +0200
Subject: [PATCH] Remove indicators list by component from api-ref

GET /v1/nodes/{node_ident}/management/indicators/{component}
as documented does not work. This calls ironic.api.
controllers.v1.node.IndicatorController.get_one and it will
raise InvalidParameterValue in ironic.api.controllers.v1.node.
IndicatorAtComponent unless `{indicator}@{component}` is given.

Change-Id: I5e7edb36b5f9dacf990215c05a84739d003a09b7
---
 .../source/baremetal-api-v1-indicators.inc    | 41 -----------------
 ...de-indicators-component-list-response.json | 45 -------------------
 2 files changed, 86 deletions(-)
 delete mode 100644 api-ref/source/samples/node-indicators-component-list-response.json

diff --git a/api-ref/source/baremetal-api-v1-indicators.inc b/api-ref/source/baremetal-api-v1-indicators.inc
index 1819519821..e185638a61 100644
--- a/api-ref/source/baremetal-api-v1-indicators.inc
+++ b/api-ref/source/baremetal-api-v1-indicators.inc
@@ -46,47 +46,6 @@ Response Parameters
    :language: javascript
 
 
-List Indicators for hardware component
-======================================
-
-.. rest_method:: GET /v1/nodes/{node_ident}/management/indicators/{component}
-
-.. versionadded:: 1.63
-
-Retrieves indicators for a given hardware component along with their attributes.
-The components that the ``redfish`` driver may have are: ``system``,
-``chassis`` and ``drive``. The actual list depends on the support by the
-underlying hardware.
-
-Normal response code: 200
-
-Error response codes: 404 (if node or component is not found)
-
-Request
--------
-
-.. rest_parameters:: parameters.yaml
-
-   - node_ident: node_ident
-   - component: component
-
-Response Parameters
--------------------
-
-.. rest_parameters:: parameters.yaml
-
-   - indicators: n_indicators
-   - name: indicator_name
-   - readonly: indicator_readonly
-   - states: indicator_states
-   - links: links
-
-**Example list of indicators for a given component of the node:**
-
-.. literalinclude:: samples/node-indicators-component-list-response.json
-   :language: javascript
-
-
 Get Indicator State
 ===================
 
diff --git a/api-ref/source/samples/node-indicators-component-list-response.json b/api-ref/source/samples/node-indicators-component-list-response.json
deleted file mode 100644
index 51a3b4b163..0000000000
--- a/api-ref/source/samples/node-indicators-component-list-response.json
+++ /dev/null
@@ -1,45 +0,0 @@
-{
-    "indicators": [
-        {
-            "name": "power",
-            "readonly": true,
-            "states": [
-                "OFF",
-                "ON"
-            ],
-            "links": [
-                {
-                    "href": "http://127.0.0.1:6385/v1/nodes/Compute0/
-                    management/indicators/system/power",
-                    "rel": "self"
-                },
-                {
-                    "href": "http://127.0.0.1:6385/nodes/Compute0/
-                    management/indicators/system/power",
-                    "rel": "bookmark"
-                }
-            ]
-        },
-        {
-            "name": "alert",
-            "readonly": false,
-            "states": [
-                "OFF",
-                "BLINKING",
-                "UNKNOWN"
-            ],
-            "links": [
-                {
-                    "href": "http://127.0.0.1:6385/v1/nodes/Compute0/
-                    management/indicators/system/alert",
-                    "rel": "self"
-                },
-                {
-                    "href": "http://127.0.0.1:6385/nodes/Compute0/
-                    management/indicators/system/alert",
-                    "rel": "bookmark"
-                }
-            ]
-        },
-    ]
-}