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

Standardize on API endpoints in examples #45

Open
Tyrrrz opened this issue Sep 20, 2023 · 1 comment
Open

Standardize on API endpoints in examples #45

Tyrrrz opened this issue Sep 20, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@Tyrrrz
Copy link
Contributor

Tyrrrz commented Sep 20, 2023

Currently, the docs are a bit misaligned on API routes when it comes to user-implemented backend endpoints.

For example, docs for the JS client (frontend) use /create-token and /signin: https://docs.passwordless.dev/guide/frontend/javascript.html#register

While the docs for the .NET client (backend) use /create-token and /verify-signin: https://docs.passwordless.dev/guide/backend/dotnet.html

Additionally, docs for the JS client assume that /create-token returns the raw token (string) directly: https://docs.passwordless.dev/guide/frontend/javascript.html#register

While the docs for the .NET client return the token as part of a JSON object: https://docs.passwordless.dev/guide/backend/dotnet.html

This inconsistency can lead to silly bugs and it would be nice to standardize on some convention.

@Tyrrrz Tyrrrz added the enhancement New feature or request label Sep 20, 2023
@abergs
Copy link
Member

abergs commented Sep 20, 2023

Agreed. Previously we returned a string but switched to returning an object, so the JS-client docs are just out of date.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants