REST API errors aren't in JSON

[spinler]

The Robot CI tests needs responses like:

curl -c cjar -b cjar -k -H "Content-Type: application/json" -X GET   https://XXX/xyz/openbmc_project/blah
{
  "data": {
    "description": "org.freedesktop.DBus.Error.FileNotFound: path or object not found: /xyz/openbmc_project/blah"
  }, 
  "message": "404 Not Found", 
  "status": "error"
}

instead of:

$ curl -c cjar -b cjar -k -H "Content-Type: application/json" -X GET   https://XXX/xy_project/blah
Not Found

[edtanous]

Agreed, this needs to be improved.
It should just be a matter of hunting through https://github.com/openbmc/bmcweb/blob/master/include/openbmc_dbus_rest.hpp

And look for all calls to res.result, and append a call to res.jsonValue = {json payload I want}

Recently, for redfish error codes, we've moved to a different mechanism where the result code is set as part of a single error handler. (see methods in https://github.com/openbmc/bmcweb/blob/master/redfish-core/include/error_messages.hpp). I imagine a similar pattern might be useful in this case, although might be overkill.

[spinler]

I started working on this, and have a few of the paths finished and up in gerrit so far.

[spinler]

Resolved by https://gerrit.openbmc-project.xyz/#/c/openbmc/bmcweb/+/16641/