Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Machine-readable details of errors #1325

Open
Jeroen-VdB opened this issue Jan 29, 2025 · 0 comments
Open

Machine-readable details of errors #1325

Jeroen-VdB opened this issue Jan 29, 2025 · 0 comments

Comments

@Jeroen-VdB
Copy link

Jeroen-VdB commented Jan 29, 2025

Would it be interesting to add an RFC 9457 Problem Details for HTTP APIs inspired extension for error handling?

An example could be:

{
    "specversion" : "1.0",
    "type" : "com.example.someproblem",
    "source" : "/mycontext",
    "subject": null,
    "id" : "C234-1234-1234",
    "time" : "2018-04-05T17:31:00Z",
    "datacontenttype" : "application/problem+json", // specific media type
    "status" : "error",
    "title": "Processing failed",
    "detail": "An error occurred while processing.",
    "data" : {
         ...
    }
}

I'm currently looking into implementing error handling in asynchronous processes. I'm always in favour of using as much standardization as possible. Up until now, I was not able to find anything specific about asynchronous error handling.
Unless these details should remain domain-specific, and therefore reside only in data.

Ps: As mentioned in the RFC: Problem details are not a debugging tool for the underlying implementation;. Therefore I see a distinction between this and the already existing Severity Extension.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant