openstack/ironic
Code Issues Proposed changes

Add missing include for inventory API reference

Browse Source 
Also fix up the title and make sure the linter checks API ref files.

Change-Id: I360fd4fab699e732ac03dc07faab33e18fe2bf13
This commit is contained in:
Dmitry Tantsur 2023-02-23 18:38:19 +01:00
parent 8f25cf03a3
commit c0460efd06
3 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api-ref/source/baremetal-api-v1-nodes-inventory.inc
View File

@ -9,8 +9,12 @@ Node inventory
Given a Node identifier, the API provides access to the introspection data Given a Node identifier, the API provides access to the introspection data
associated to the Node via ``v1/nodes/{node_ident}/inventory`` endpoint. associated to the Node via ``v1/nodes/{node_ident}/inventory`` endpoint.
Fetch node inventory The format inventory comes from ironic-python-agent and is currently documented
=============================== in the `agent inventory documentation
<https://docs.openstack.org/ironic-python-agent/latest/admin/how_it_works.html#hardware-inventory>`_.
Show Node Inventory
===================
.. rest_method:: GET /v1/nodes/{node_ident}/inventory .. rest_method:: GET /v1/nodes/{node_ident}/inventory

1
api-ref/source/index.rst
View File

@ -28,6 +28,7 @@
.. include:: baremetal-api-v1-node-allocation.inc .. include:: baremetal-api-v1-node-allocation.inc
.. include:: baremetal-api-v1-deploy-templates.inc .. include:: baremetal-api-v1-deploy-templates.inc
.. include:: baremetal-api-v1-nodes-history.inc .. include:: baremetal-api-v1-nodes-history.inc
.. include:: baremetal-api-v1-nodes-inventory.inc
.. include:: baremetal-api-v1-shards.inc .. include:: baremetal-api-v1-shards.inc
.. NOTE(dtantsur): keep chassis close to the end since it's semi-deprecated .. NOTE(dtantsur): keep chassis close to the end since it's semi-deprecated
.. include:: baremetal-api-v1-chassis.inc .. include:: baremetal-api-v1-chassis.inc

2
tox.ini
View File

@ -52,7 +52,7 @@ commands =
# the check and gate queues. # the check and gate queues.
{toxinidir}/tools/run_bashate.sh {toxinidir} {toxinidir}/tools/run_bashate.sh {toxinidir}
# Check the *.rst files # Check the *.rst files
doc8 README.rst CONTRIBUTING.rst doc/source --ignore D001 doc8 README.rst CONTRIBUTING.rst doc/source api-ref/source --ignore D001
# Check to make sure reno releasenotes created with 'reno new' # Check to make sure reno releasenotes created with 'reno new'
{toxinidir}/tools/check-releasenotes.py {toxinidir}/tools/check-releasenotes.py