Open timvandenberg-sqills opened 9 months ago
Decision: We setup small group to refine the situation lead by @timvandenberg-sqills
To implement the updated error handling, error detail object will adhere to updated RFC see #361
Presentation and approving on 2024-06-14.
Regarding the documentation changes in branch feature/gh-pages-390, we suggest some additions
There is no suitable problem code for http codes 401 and 503. Suggestion:
Add http code 429 without a body, to indicate to the consumer that they should stop flooding the system.
Need to add 429 to the OpenAPI specification
We have an inconsistency here: the documentation in https://osdm.io/spec/errors-problems/ specifies that http code 405 should be used. The OpenAPI / YAML specification states http code 406 instead.
We need to define which way we will move this and make it consistent.
Placeholder to discuss the error handling in OSDM.
Example:
Start using the code field in 3.1, with a URN, where:
Improve on the documented values of the response HTTP status codes:
Some messages can be returned as a warning or an error as well, resulting in a 200 HTTP response for the warning, a 400 HTTP response for the error
Add on not yet documented errors and warnings (continuing process)
Improve documentation