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

Method names createCredentialsOptions and getCredentialsOptions are misleading #698

Open
ynojima opened this issue Nov 14, 2024 · 0 comments

Comments

@ynojima
Copy link
Contributor

ynojima commented Nov 14, 2024

Future<JsonObject> createCredentialsOptions(JsonObject user);

Future<JsonObject> getCredentialsOptions(@Nullable String username);

The names of these methods are misleading.
When placed side by side, createCredentialsOptions appears to be method that create CredentialsOptions and getCredentialsOptions appears to just return CredentialsOptions.
However, they actually create PublicKeyCredentialCreationOptions and PublicKeyCredentialGetOptions, respectively.

Since introducing a new module vertx-auth-webauthn4j is a good chance to make a breaking change from vertx-auth-webauthn, I think these methods should be renamed to createPublicKeyCredentialCreationOptions and createPublicKeyCredentialGetOptions.

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

No branches or pull requests

1 participant