bitwarden / bitwarden/passwordless-docs

Standardize on API endpoints in examples

Open
#45 1 comment 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
CSS
Stars
31
Forks
51
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.