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

Document all possible errors for each endpoint #21715

Open
Jonny1987 opened this issue Mar 3, 2024 · 2 comments
Open

Document all possible errors for each endpoint #21715

Jonny1987 opened this issue Mar 3, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@Jonny1987
Copy link

Jonny1987 commented Mar 3, 2024

Improve documentation

Describe the problem

The API documentation doesn't mention what errors can be returned by each endpoint. For example, The signIn method can return an AuthException with 400 statusCode and either "Email not confirmed" or "Invalid login credentials" as a message for two different errors, but I only discovered these by testing my code, not from reading the documentation. Maybe there are others which I need to know about too. I need to check for these so I can give an appropriate message to users in their own language, so it's no good just displaying the message that supabase returns.

Describe the improvement

Detail in the documentation which errors are raised by each method in the supabase package.

@Jonny1987 Jonny1987 added the documentation Improvements or additions to documentation label Mar 3, 2024
@encima
Copy link
Member

encima commented Mar 4, 2024

Thanks for opening this.

To clarify and refine this request, is it for all APIs under a Project? or specifically for Auth?

@Jonny1987 Jonny1987 changed the title Documents all possible errors for each endpoint Document all possible errors for each endpoint Mar 8, 2024
@Jonny1987
Copy link
Author

Look at the docs for flutter (https://supabase.com/docs/reference/dart), I can't see mention of any errors for any section, so I think the answer is: for all APIs.

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

No branches or pull requests

2 participants