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

API Endpoints Documentation Update Verify Parameter Options #1710

Open
18mstalberg opened this issue Aug 5, 2024 · 1 comment
Open

API Endpoints Documentation Update Verify Parameter Options #1710

18mstalberg opened this issue Aug 5, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@18mstalberg
Copy link

Improve documentation

Link

https://github.com/supabase/auth/blob/master/README.md

Describe the problem

There is documentation missing in various ways. The first I noticed was with the /verify endpoint where I had to dig into the api folder to figure out which type I needed to pass. signup | recovery | invite and sms are noted, missing "email_change" and perhaps others but that's the one I ran into and had to search the api folder to figure out that it existed.

Describe the improvement

Add "email_change" and any other options for the "type" field to the documentation for the /verify route, including perhaps an example code block using it, as had been done for some of the other options.

Additional context

image
I just happened to come across the string as I was exploring the code and it did the job..
image

@18mstalberg 18mstalberg added the documentation Improvements or additions to documentation label Aug 5, 2024
@J0 J0 added the good first issue Good for newcomers label Aug 26, 2024
@J0
Copy link
Contributor

J0 commented Aug 26, 2024

Hey,

Thansk again! For anyone passing by please check the openapi spec for now if you are using the API directly. We also welcome contributions to the README though

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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants