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.

Sign up for GitHub

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

Jump to bottom

API Endpoints Update - Add Missing Resend Route #1711

Open
18mstalberg opened this issue Aug 5, 2024 · 2 comments · May be fixed by #1895
Open

API Endpoints Update - Add Missing Resend Route #1711

18mstalberg opened this issue Aug 5, 2024 · 2 comments · May be fixed by #1895
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 at least one endpoint missing from the API Endpoints documentation. Specifically, I the /verify route is missing from documentation.

Describe the improvement

Add POST /resend to the README in the Endpoints section, specifying the required fields in the body and the potential values for the fields. Additionally, add one or more code blocks demonstrating example Requests and Responses for the endpoint

Additional context

https://github.com/supabase/auth/blob/master/internal/api/resend.go#L65
@18mstalberg 18mstalberg added the documentation Improvements or additions to documentation label Aug 5, 2024
@J0
Copy link
Contributor

J0 commented Aug 26, 2024

Hey,

@18mstalberg Thanks for the feedback this is a good suggestion. We'll open this for contributions but for now you can probably refer to the OpenAPI spec for detailed overview of routes

https://github.com/supabase/auth/blob/master/openapi.yaml#L438

@J0 J0 added the good first issue Good for newcomers label Aug 26, 2024
@12138zhen
Copy link
Contributor

I can help with this issue.

@12138zhen 12138zhen linked a pull request Dec 28, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: update README to correct code snippets and add resend OTP endpoint 12138zhen/auth
3 participants
@J0 @12138zhen @18mstalberg