openstack/ironic-inspector
Code Issues Proposed changes

Merge "link introspection API docs to client docs"

Browse Source
This commit is contained in:
Zuul 2020-01-27 16:53:30 +00:00 committed by Gerrit Code Review
commit 2c2193a1b7
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/user/http-api.rst
View File

@ -129,11 +129,15 @@ Response:
* 401, 403 - missing or invalid authentication * 401, 403 - missing or invalid authentication
* 404 - data cannot be found or data storage not configured * 404 - data cannot be found or data storage not configured
Response body: JSON dictionary with introspection data Response body: JSON dictionary with introspection data. For more
details about the inventory key, refer to the
:ironic-python-agent-doc:`ironic-python-agent documentation
<admin/how_it_works.html#inspection-data>`.
.. note:: .. note::
We do not provide any backward compatibility guarantees regarding the We do not provide any backward compatibility guarantees regarding the
format and contents of the stored data. Notably, it depends on the ramdisk format and contents of the stored data, other than the ``inventory``.
Notably, it depends on the ramdisk
used and plugins enabled both in the ramdisk and in inspector itself. used and plugins enabled both in the ramdisk and in inspector itself.
Reapply introspection on stored data Reapply introspection on stored data