link introspection API docs to client docs
The introspection API documentation does not include any detail at all about the payload returned. That information is in the ironic-python-agent documentation instead. Add a link to that location to make it easier for someone trying to find out what introspection data is returned to do so. Change-Id: I972803ac700f25823ac6715d21dda09ebe40e307 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
parent
f8e26aa088
commit
f4fe4307be
|
@ -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
|
||||||
|
|
Loading…
Reference in New Issue