Skip to content

Authentication error messages poorly/not documented #22203

Description

@LukeHosk

Improve documentation

Link

Could potentially go in multiple places, e.g. just for email/password login auth docs or client docs.

Describe the problem

The potential return values of most of the auth functions are not documented, which makes it hard to handle potential errors client-side.

Describe the improvement

Include details of the potential messages the auth functions can return.

Could alternatively link to the gotrue docs if you wish to maintain a separation, however they would also need to be improved first as they currently list the only possible response as 200 success

Additional context

After manually working up through the dependancy tree to try and document the potential errors for the supabase-js signInWithPassword function figure out how to handle them in my project, i came up with the following list (links are to the part of the code that returns the error):

Metadata

Metadata

Assignees

No one assigned

    Labels

    authAll thing Supabase Auth relatedawaiting-detailsFor issues needing detail from the opener.documentationImprovements or additions to documentationtriaged/l1Has been initially triaged by reviewing/verifying and labelling for relevant teams

    Type

    No type

    Projects

    Status
    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions