Skip to content

Commit 753375d

Browse files
emlunemlun
committed
Elaborate reference to "passkey" in passkeys.dev reference
1 parent d21061c commit 753375d

File tree

6 files changed

+44
-22
lines changed

6 files changed

+44
-22
lines changed

‎webauthn-server-core/src/main/java/com/yubico/webauthn/AssertionRequest.java

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ public class AssertionRequest {
6262
* credential</a> (passkey), and identification of the user has been deferred until the response
6363
* is received.
6464
*
65-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
65+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
66+
* href="https://passkeys.dev">passkeys.dev</a> reference
6667
*/
6768
private final String username;
6869

@@ -79,7 +80,8 @@ public class AssertionRequest {
7980
* credential</a> (passkey), and identification of the user has been deferred until the response
8081
* is received.
8182
*
82-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
83+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
84+
* href="https://passkeys.dev">passkeys.dev</a> reference
8385
*/
8486
private final ByteArray userHandle;
8587

@@ -112,7 +114,8 @@ private AssertionRequest(
112114
* credential</a> (passkey), and identification of the user has been deferred until the response
113115
* is received.
114116
*
115-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
117+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
118+
* href="https://passkeys.dev">passkeys.dev</a> reference
116119
*/
117120
public Optional<String> getUsername() {
118121
return Optional.ofNullable(username);
@@ -130,7 +133,8 @@ public Optional<String> getUsername() {
130133
* credential</a> (passkey), and identification of the user has been deferred until the response
131134
* is received.
132135
*
133-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
136+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
137+
* href="https://passkeys.dev">passkeys.dev</a> reference
134138
*/
135139
public Optional<ByteArray> getUserHandle() {
136140
return Optional.ofNullable(userHandle);
@@ -226,7 +230,8 @@ public AssertionRequestBuilder publicKeyCredentialRequestOptions(
226230
* credential</a> (passkey), and identification of the user has been deferred until the response
227231
* is received.
228232
*
229-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
233+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
234+
* href="https://passkeys.dev">passkeys.dev</a> reference
230235
*/
231236
public AssertionRequestBuilder username(@NonNull Optional<String> username) {
232237
return this.username(username.orElse(null));
@@ -243,7 +248,8 @@ public AssertionRequestBuilder username(@NonNull Optional<String> username) {
243248
* credential</a> (passkey), and identification of the user has been deferred until the response
244249
* is received.
245250
*
246-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
251+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
252+
* href="https://passkeys.dev">passkeys.dev</a> reference
247253
*/
248254
public AssertionRequestBuilder username(String username) {
249255
this.username = username;
@@ -265,7 +271,8 @@ public AssertionRequestBuilder username(String username) {
265271
* credential</a> (passkey), and identification of the user has been deferred until the response
266272
* is received.
267273
*
268-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
274+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
275+
* href="https://passkeys.dev">passkeys.dev</a> reference
269276
*/
270277
public AssertionRequestBuilder userHandle(@NonNull Optional<ByteArray> userHandle) {
271278
return this.userHandle(userHandle.orElse(null));
@@ -283,7 +290,8 @@ public AssertionRequestBuilder userHandle(@NonNull Optional<ByteArray> userHandl
283290
* credential</a> (passkey), and identification of the user has been deferred until the response
284291
* is received.
285292
*
286-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
293+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
294+
* href="https://passkeys.dev">passkeys.dev</a> reference
287295
*/
288296
public AssertionRequestBuilder userHandle(ByteArray userHandle) {
289297
if (userHandle != null) {

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,8 @@ public Optional<AuthenticatorRegistrationExtensionOutputs> getAuthenticatorExten
318318
* @see <a
319319
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#discoverable-credential">Discoverable
320320
* Credential</a>
321-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
321+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
322+
* href="https://passkeys.dev">passkeys.dev</a> reference
322323
*/
323324
@JsonIgnore
324325
public Optional<Boolean> isDiscoverable() {

‎webauthn-server-core/src/main/java/com/yubico/webauthn/StartAssertionOptions.java

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,8 @@ public class StartAssertionOptions {
9898
* @see <a
9999
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#client-side-discoverable-public-key-credential-source">Client-side-discoverable
100100
* credential</a>
101-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
101+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
102+
* href="https://passkeys.dev">passkeys.dev</a> reference
102103
*/
103104
public Optional<String> getUsername() {
104105
return Optional.ofNullable(username);
@@ -125,7 +126,8 @@ public Optional<String> getUsername() {
125126
* @see <a
126127
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#client-side-discoverable-public-key-credential-source">Client-side-discoverable
127128
* credential</a>
128-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
129+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
130+
* href="https://passkeys.dev">passkeys.dev</a> reference
129131
*/
130132
public Optional<ByteArray> getUserHandle() {
131133
return Optional.ofNullable(userHandle);
@@ -189,7 +191,8 @@ public static class StartAssertionOptionsBuilder {
189191
* @see <a
190192
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#client-side-discoverable-public-key-credential-source">Client-side-discoverable
191193
* credential</a>
192-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
194+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
195+
* href="https://passkeys.dev">passkeys.dev</a> reference
193196
*/
194197
public StartAssertionOptionsBuilder username(@NonNull Optional<String> username) {
195198
this.username = username.orElse(null);
@@ -222,7 +225,8 @@ public StartAssertionOptionsBuilder username(@NonNull Optional<String> username)
222225
* @see <a
223226
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#client-side-discoverable-public-key-credential-source">Client-side-discoverable
224227
* credential</a>
225-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
228+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
229+
* href="https://passkeys.dev">passkeys.dev</a> reference
226230
*/
227231
public StartAssertionOptionsBuilder username(String username) {
228232
return this.username(Optional.ofNullable(username));
@@ -253,7 +257,8 @@ public StartAssertionOptionsBuilder username(String username) {
253257
* @see <a
254258
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#client-side-discoverable-public-key-credential-source">Client-side-discoverable
255259
* credential</a>
256-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
260+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
261+
* href="https://passkeys.dev">passkeys.dev</a> reference
257262
*/
258263
public StartAssertionOptionsBuilder userHandle(@NonNull Optional<ByteArray> userHandle) {
259264
this.userHandle = userHandle.orElse(null);
@@ -286,7 +291,8 @@ public StartAssertionOptionsBuilder userHandle(@NonNull Optional<ByteArray> user
286291
* @see <a
287292
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#client-side-discoverable-public-key-credential-source">Client-side-discoverable
288293
* credential</a>
289-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
294+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
295+
* href="https://passkeys.dev">passkeys.dev</a> reference
290296
*/
291297
public StartAssertionOptionsBuilder userHandle(ByteArray userHandle) {
292298
return this.userHandle(Optional.ofNullable(userHandle));

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,8 @@ public class AuthenticatorSelectionCriteria {
7373
* @see <a
7474
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#client-side-discoverable-credential">Client-side
7575
* discoverable Credential</a>
76-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
76+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
77+
* href="https://passkeys.dev">passkeys.dev</a> reference
7778
*/
7879
private final ResidentKeyRequirement residentKey;
7980

@@ -128,7 +129,8 @@ public Optional<AuthenticatorAttachment> getAuthenticatorAttachment() {
128129
* @see <a
129130
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#client-side-discoverable-credential">Client-side
130131
* discoverable Credential</a>
131-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
132+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
133+
* href="https://passkeys.dev">passkeys.dev</a> reference
132134
*/
133135
public Optional<ResidentKeyRequirement> getResidentKey() {
134136
return Optional.ofNullable(residentKey);

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,8 @@ public static class CredentialPropertiesOutput {
9595
* @see <a
9696
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#server-side-credential">Server-side
9797
* Credential</a>
98-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
98+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
99+
* href="https://passkeys.dev">passkeys.dev</a> reference
99100
*/
100101
public Optional<Boolean> getRk() {
101102
return Optional.ofNullable(rk);

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

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@
4343
* @see <a
4444
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#client-side-discoverable-credential">Client-side
4545
* discoverable Credential</a>
46-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
46+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
47+
* href="https://passkeys.dev">passkeys.dev</a> reference
4748
*/
4849
@AllArgsConstructor
4950
public enum ResidentKeyRequirement {
@@ -61,7 +62,8 @@ public enum ResidentKeyRequirement {
6162
* @see <a
6263
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#server-side-credential">Server-side
6364
* Credential</a>
64-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
65+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
66+
* href="https://passkeys.dev">passkeys.dev</a> reference
6567
*/
6668
DISCOURAGED("discouraged"),
6769

@@ -78,7 +80,8 @@ public enum ResidentKeyRequirement {
7880
* @see <a
7981
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#server-side-credential">Server-side
8082
* Credential</a>
81-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
83+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
84+
* href="https://passkeys.dev">passkeys.dev</a> reference
8285
*/
8386
PREFERRED("preferred"),
8487

@@ -95,7 +98,8 @@ public enum ResidentKeyRequirement {
9598
* @see <a
9699
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#server-side-credential">Server-side
97100
* Credential</a>
98-
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a>
101+
* @see <a href="https://passkeys.dev/docs/reference/terms/#passkey">Passkey</a> in <a
102+
* href="https://passkeys.dev">passkeys.dev</a> reference
99103
*/
100104
REQUIRED("required");
101105

0 commit comments

Comments
 (0)