eclipse-vertx / eclipse-vertx/vertx-auth

Method names `createCredentialsOptions` and `getCredentialsOptions` are misleading

Open
#698 0 comments 0 reactions 1 assignee Claimed by @tsegismont View on GitHub
Dominant language
Java
Stars
175
Forks
159
Avg merge
3d 4h
Merged PRs (30d)
3

Description

https://github.com/eclipse-vertx/vertx-auth/blob/f2fe95820b41db7da3afcc8a2028fedeb8b5ee8f/vertx-auth-webauthn4j/src/main/java/io/vertx/ext/auth/webauthn4j/WebAuthn4J.java#L64
https://github.com/eclipse-vertx/vertx-auth/blob/f2fe95820b41db7da3afcc8a2028fedeb8b5ee8f/vertx-auth-webauthn4j/src/main/java/io/vertx/ext/auth/webauthn4j/WebAuthn4J.java#L76

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`.

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.