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

Improve documentation around email and password Account Keys #47

Open
1 task done
Supereg opened this issue Jan 22, 2024 · 0 comments
Open
1 task done

Improve documentation around email and password Account Keys #47

Supereg opened this issue Jan 22, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@Supereg
Copy link
Member

Supereg commented Jan 22, 2024

Problem

With the current documentation it is hard to grasp of the EmailAccountKey is implemented internally. The EmailAccountKey is highly dynamic (e.g., falling back to the userId key if the user id is configured to be an email, otherwise it's a regularly stored Account Key). This behavior is not really documented and only visible when looking into the implementation. Further, this behavior depends on the specific Account Service implementation.

Similarly, the PasswordKey is usually not meant to be specified by the user directly (rather it is implicitly specified for Account Services that require password input as a credential).

Solution

This behavior needs to be explicitly documented. Further, it might make sense to explain it with the example of our Firebase Account Service implementation (what most people would be working with initially).

For the password key, it might make sense to add a hint that you most likely won't need to specify that or make it only visible for the documentation that is gathered towards Account Service implementors.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct and Contributing Guidelines
@Supereg Supereg added the enhancement New feature or request label Jan 22, 2024
@PSchmiedmayer PSchmiedmayer moved this to Backlog in Project Planning Feb 22, 2024
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
Status: Backlog
Development

No branches or pull requests

1 participant