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

Documentation of API error codes #920

Open
s-hamann opened this issue May 4, 2024 · 0 comments
Open

Documentation of API error codes #920

s-hamann opened this issue May 4, 2024 · 0 comments

Comments

@s-hamann
Copy link

s-hamann commented May 4, 2024

The docs currently do not contain a lot of information on possible error codes and conditions returned by the API. API clients therefore need to implement error handling based on observations and assumptions, and can not rely on documented behaviour.

It would be nice to have a reference of possible error conditions and HTTP status codes for each endpoint.
Furthermore, I noticed that errors seem to contain JSON data with a human-readable error message in the detail field. Is this always the case? At a quick glance, it seems to be. But I could not find any reliable information.

I believe, #359 has the potential to naturally provide this kind of information. In the mean time, a human-readable documentation would help.

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