openstack/ironic
Code Issues Proposed changes

Remove indicators list by component from api-ref

Browse Source 
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
This commit is contained in:
Harald Jensås 2023-05-09 15:29:25 +02:00
parent 1d0818cba2
commit 17d3b72b3d
No known key found for this signature in database
GPG Key ID: 693852E00DCEA408
2 changed files with 0 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
api-ref/source/baremetal-api-v1-indicators.inc
View File

@ -46,47 +46,6 @@ Response Parameters
:language: javascript :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 Get Indicator State
=================== ===================

45
api-ref/source/samples/node-indicators-component-list-response.json
View File

@ -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"
}
]
},
]
}