Feature Request: add "diagnostics" field

[mofosyne]

Instead of a singular "code" field, you may want to add a "diagnostics" field where developers can place various error metadata like a developer specific error message, firmware version, function, line number etc...

The whole field will be considered opaque to common user interactions... but you could perhaps encode it within an error report that you can then send back to engineering.

[mofosyne]

This would also likely replace

code: A numeric code corresponding to the error, if applicable

As I'm not sure the user would really need to know it... or if you do have such a code.

I think it would be better shown as

{
    "status": "error",
    "message": "User facing error here",
    "diagnostics": {
        "level": "ERROR",
        "subsystem": "GENERAL",
        "code": "1.23",
        "codename": "subsystem.error_code_name",
        "message": "Engineering message error here",
        "file": "example.c",
        "line": 213,
        "function": "main",
        "git_hash": "2342cse",
        "details": "some extra details here"
    }
}

Where we can then define in the standard something like:

• diagnostics.code : A numeric code corresponding to the error, if applicable

Then in the app, use diagnostics.code to display the corresponding error code to report.