openstack
/
ironic-inspector
Code Issues Proposed changes

Merge "Document error response format in HTTP-API.rst"

This commit is contained in:
Jenkins 2015-08-12 10:34:44 +00:00 committed by Gerrit Code Review
parent fd7d609ef1 b9fa3b4214
commit 19058467b8
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
HTTP-API.rst
View File

@ -107,6 +107,23 @@ body will contain the following keys:
.. _Setting IPMI Credentials: https://github.com/openstack/ironic-inspector#setting-ipmi-credentials
.. _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
~~~~~~~~~~~~~~