diff --git a/doc/source/user/http-api.rst b/doc/source/user/http-api.rst index 96ac6e3aa..e2254a88b 100644 --- a/doc/source/user/http-api.rst +++ b/doc/source/user/http-api.rst @@ -129,11 +129,15 @@ Response: * 401, 403 - missing or invalid authentication * 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 +`. .. note:: 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. Reapply introspection on stored data