auth icon indicating copy to clipboard operation
auth copied to clipboard

API Endpoints Documentation Update Verify Parameter Options

Open 18mstalberg opened this issue 1 year ago • 1 comments

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 avatar Aug 05 '24 16:08 18mstalberg

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

J0 avatar Aug 26 '24 21:08 J0