Document error response format in HTTP-API.rst

Change-Id: I9e75320b982aae4a52820bf620a29235413e5582
Closes-Bug: #1473106
This commit is contained in:
Dmitry Tantsur 2015-08-12 10:19:17 +02:00
parent 86dabccdc9
commit b9fa3b4214
1 changed files with 17 additions and 0 deletions

View File

@ -107,6 +107,23 @@ body will contain the following keys:
.. _Setting IPMI Credentials: https://github.com/openstack/ironic-inspector#setting-ipmi-credentials .. _Setting IPMI Credentials: https://github.com/openstack/ironic-inspector#setting-ipmi-credentials
.. _Plugins: https://github.com/openstack/ironic-inspector#plugins .. _Plugins: https://github.com/openstack/ironic-inspector#plugins
Error Response
~~~~~~~~~~~~~~
If an error happens during request processing, **Ironic Inspector** returns
a response with an appropriate HTTP code set, e.g. 400 for bad request or
404 when something was not found (usually node in cache or node in ironic).
The following JSON body is returned::
{
"error": {
"message": "Full error message"
}
}
This body may be extended in the future to include details that are more error
specific.
API Versioning API Versioning
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~