Skip to content

Commit 02a10f6

Browse files
committed
Tweak JavaDoc of authenticatorDisplayName
1 parent 4b3bdd8 commit 02a10f6

File tree

2 files changed

+16
-7
lines changed

2 files changed

+16
-7
lines changed

webauthn-server-core/src/main/java/com/yubico/webauthn/RegistrationResult.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -372,14 +372,15 @@ public Optional<Boolean> isDiscoverable() {
372372
* Retrieve a suitable nickname for this credential, if one is available.
373373
*
374374
* <p>This returns the <code>authenticatorDisplayName</code> output from the <a
375-
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-authenticator-credential-properties-extension">
375+
* href="https://w3c.github.io/webauthn/#sctn-authenticator-credential-properties-extension">
376376
* <code>credProps</code></a> extension.
377377
*
378378
* @return A user-chosen or vendor-default display name for the credential, if available.
379379
* Otherwise empty.
380380
* @see <a
381-
* href="https://w3c.github.io/webauthn/#dom-credentialpropertiesoutput-authenticatordisplayname">§10.1.3.
382-
* Credential Properties Extension (credProps), "authenticatorDisplayName" output</a>
381+
* href="https://w3c.github.io/webauthn/#dom-credentialpropertiesoutput-authenticatordisplayname">
382+
* <code>authenticatorDisplayName</code> in §10.1.3. Credential Properties Extension
383+
* (credProps)</a>
383384
* @see Extensions.CredentialProperties.CredentialPropertiesOutput#getAuthenticatorDisplayName()
384385
* @deprecated EXPERIMENTAL: This feature is from a not yet mature standard; it could change as
385386
* the standard matures.

webauthn-server-core/src/main/java/com/yubico/webauthn/data/Extensions.java

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,11 +117,19 @@ public Optional<Boolean> getRk() {
117117
* This OPTIONAL property is a human-palatable description of the credential's managing
118118
* authenticator, chosen by the user.
119119
*
120-
* <p>If the RP includes an <code>[$credential record/authenticatorDisplayName$]</code>
121-
* [=struct/item=] in [=credential records=], the [=[RP]=] MAY offer this value, if present,
122-
* as a default value for the <code>[$credential record/authenticatorDisplayName$]</code> of
123-
* the new [=credential record=].
120+
* <p>If the application supports setting "nicknames" for registered credentials, then this
121+
* value may be a suitable default value for such a nickname.
124122
*
123+
* <p>In an authentication ceremony, if this value is different from the stored nickname, then
124+
* the application may want to offer the user to update the stored nickname to match this
125+
* value.
126+
*
127+
* @return A user-chosen or vendor-default display name for the credential, if available.
128+
* Otherwise empty.
129+
* @see <a
130+
* href="https://w3c.github.io/webauthn/#dom-credentialpropertiesoutput-authenticatordisplayname">
131+
* <code>authenticatorDisplayName</code> in §10.1.3. Credential Properties Extension
132+
* (credProps)</a>
125133
* @see RegistrationResult#getAuthenticatorDisplayName()
126134
* @deprecated EXPERIMENTAL: This feature is from a not yet mature standard; it could change
127135
* as the standard matures.

0 commit comments

Comments
 (0)