search

supabase / auth

A JWT based API for managing users and issuing JWT tokens
https://supabase.com/docs/guides/auth
MIT License
1.53k stars 373 forks source link

API Endpoints Update - Add Missing Resend Route #1711

Open 18mstalberg opened 3 months ago

18mstalberg commented 3 months ago

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

J0 commented 2 months ago

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