diff options
| author | Dmitry Tantsur <dtantsur@protonmail.com> | 2023-02-23 18:38:19 +0100 |
|---|---|---|
| committer | Dmitry Tantsur <dtantsur@protonmail.com> | 2023-02-23 18:38:19 +0100 |
| commit | c0460efd06ec0059ee1b6ddb2833f77e509d88bd (patch) | |
| tree | 74579a243496a89df19432e3c622596de1e03319 | |
| parent | 8f25cf03a3b1cf4c6f166871ea726bbd8901ee3a (diff) | |
| download | ironic-c0460efd06ec0059ee1b6ddb2833f77e509d88bd.tar.gz | |
Add missing include for inventory API reference
Also fix up the title and make sure the linter checks API ref files.
Change-Id: I360fd4fab699e732ac03dc07faab33e18fe2bf13
| -rw-r--r-- | api-ref/source/baremetal-api-v1-nodes-inventory.inc | 8 | ||||
| -rw-r--r-- | api-ref/source/index.rst | 1 | ||||
| -rw-r--r-- | tox.ini | 2 |
3 files changed, 8 insertions, 3 deletions
diff --git a/api-ref/source/baremetal-api-v1-nodes-inventory.inc b/api-ref/source/baremetal-api-v1-nodes-inventory.inc index 4c36e5aa2..ed3fb9a81 100644 --- a/api-ref/source/baremetal-api-v1-nodes-inventory.inc +++ b/api-ref/source/baremetal-api-v1-nodes-inventory.inc @@ -9,8 +9,12 @@ Node inventory Given a Node identifier, the API provides access to the introspection data 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 diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index bb41ba6fd..12beed40e 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -28,6 +28,7 @@ .. include:: baremetal-api-v1-node-allocation.inc .. include:: baremetal-api-v1-deploy-templates.inc .. include:: baremetal-api-v1-nodes-history.inc +.. include:: baremetal-api-v1-nodes-inventory.inc .. include:: baremetal-api-v1-shards.inc .. NOTE(dtantsur): keep chassis close to the end since it's semi-deprecated .. include:: baremetal-api-v1-chassis.inc @@ -52,7 +52,7 @@ commands = # the check and gate queues. {toxinidir}/tools/run_bashate.sh {toxinidir} # 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' {toxinidir}/tools/check-releasenotes.py |