InseeFrLab / InseeFrLab/onyxia-api

Implement Problem Details for HTTP APIs (RFC 9457) for api errors

Open
#495 2 comments 1 reaction 0 assignees View on GitHub
Dominant language
Java
Stars
34
Forks
34
PR merge metrics
No merged PRs in 30d

Description

The API should return more descriptive errors, rather than just plain status code errors, such that the frontend can display this information in a more user friendly (and descriptive) manner.

A suggestion is to implement the well known RFC 9457 standard for this, as documented here: https://datatracker.ietf.org/doc/html/rfc9457
Spring (and other frameworks) also has out-of-the-box support for this, e.g.: https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-ann-rest-exceptions.html

As discussed in community meeting in August.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.