camaraproject / Commonalities

Repository to describe, develop, document and test the common guidelines and assets for CAMARA APIs
Apache License 2.0
12 stars 25 forks source link

Adopting RFC 9457 for Error Handling #157

Closed gmuratk closed 5 months ago

gmuratk commented 7 months ago

Problem description

CAMARA Service APIs need future proof, extensible schema for error handling beyond pure HTTP Status Codes

Possible evolution

IETF RFC 9457 is a promising and already adopted by some organizations. This RFC would allow the use of HTTP Standard, CAMARA Specific, and even API Specific problem types side-by-side in an IETF standardized way. With the move from the current proprietary error format to the format defined by the RFC will alleviate the need for another proprietary error format for developers to deal with. A proposal is available for review: 20240304-CAMARA-Issue 133 - RFC 9457 URN Option.pdf

Alternative solution

Retain existing non-standard format.

Additional context

Previous issues #133 and #31 have been closed. Proposal supports #156 Based on decision at Commonalities meeting on March 4, 2024, it was agreed to open this issue.

cc: @lbertz02

rartych commented 5 months ago

not to be implemented TSC decision: https://wiki.camaraproject.org/display/CAM/2024-04-04+TSC+Minutes#:~:text=Error%20response%20format