Skip to content

Method names createCredentialsOptions and getCredentialsOptions are misleading #698

Description

@ynojima

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions