Skip to content

Commit 68a9c4b

Browse files
committed
Add @SInCE tags to PublicKeyCredentialParameters JavaDoc
1 parent 23ffeb9 commit 68a9c4b

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

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

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
/**
3333
* Used to supply additional parameters when creating a new credential.
3434
*
35+
* @since 0.2.0
3536
* @see <a
3637
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#dictdef-publickeycredentialparameters">§5.3.
3738
* Parameters for Credential Generation (dictionary PublicKeyCredentialParameters) </a>
@@ -44,10 +45,16 @@ public class PublicKeyCredentialParameters {
4445
* Specifies the cryptographic signature algorithm with which the newly generated credential will
4546
* be used, and thus also the type of asymmetric key pair to be generated, e.g., RSA or Elliptic
4647
* Curve.
48+
*
49+
* @since 0.2.0
4750
*/
4851
@NonNull private final COSEAlgorithmIdentifier alg;
4952

50-
/** Specifies the type of credential to be created. */
53+
/**
54+
* Specifies the type of credential to be created.
55+
*
56+
* @since 0.2.0
57+
*/
5158
@NonNull @Builder.Default
5259
private final PublicKeyCredentialType type = PublicKeyCredentialType.PUBLIC_KEY;
5360

@@ -61,55 +68,71 @@ private PublicKeyCredentialParameters(
6168
/**
6269
* Algorithm {@link COSEAlgorithmIdentifier#EdDSA} and type {@link
6370
* PublicKeyCredentialType#PUBLIC_KEY}.
71+
*
72+
* @since 1.4.0
6473
*/
6574
public static final PublicKeyCredentialParameters EdDSA =
6675
builder().alg(COSEAlgorithmIdentifier.EdDSA).build();
6776

6877
/**
6978
* Algorithm {@link COSEAlgorithmIdentifier#ES256} and type {@link
7079
* PublicKeyCredentialType#PUBLIC_KEY}.
80+
*
81+
* @since 0.3.0
7182
*/
7283
public static final PublicKeyCredentialParameters ES256 =
7384
builder().alg(COSEAlgorithmIdentifier.ES256).build();
7485

7586
/**
7687
* Algorithm {@link COSEAlgorithmIdentifier#ES384} and type {@link
7788
* PublicKeyCredentialType#PUBLIC_KEY}.
89+
*
90+
* @since 2.1.0
7891
*/
7992
public static final PublicKeyCredentialParameters ES384 =
8093
builder().alg(COSEAlgorithmIdentifier.ES384).build();
8194

8295
/**
8396
* Algorithm {@link COSEAlgorithmIdentifier#ES512} and type {@link
8497
* PublicKeyCredentialType#PUBLIC_KEY}.
98+
*
99+
* @since 2.1.0
85100
*/
86101
public static final PublicKeyCredentialParameters ES512 =
87102
builder().alg(COSEAlgorithmIdentifier.ES512).build();
88103

89104
/**
90105
* Algorithm {@link COSEAlgorithmIdentifier#RS1} and type {@link
91106
* PublicKeyCredentialType#PUBLIC_KEY}.
107+
*
108+
* @since 1.5.0
92109
*/
93110
public static final PublicKeyCredentialParameters RS1 =
94111
builder().alg(COSEAlgorithmIdentifier.RS1).build();
95112

96113
/**
97114
* Algorithm {@link COSEAlgorithmIdentifier#RS256} and type {@link
98115
* PublicKeyCredentialType#PUBLIC_KEY}.
116+
*
117+
* @since 0.3.0
99118
*/
100119
public static final PublicKeyCredentialParameters RS256 =
101120
builder().alg(COSEAlgorithmIdentifier.RS256).build();
102121

103122
/**
104123
* Algorithm {@link COSEAlgorithmIdentifier#RS384} and type {@link
105124
* PublicKeyCredentialType#PUBLIC_KEY}.
125+
*
126+
* @since 2.4.0
106127
*/
107128
public static final PublicKeyCredentialParameters RS384 =
108129
builder().alg(COSEAlgorithmIdentifier.RS384).build();
109130

110131
/**
111132
* Algorithm {@link COSEAlgorithmIdentifier#RS512} and type {@link
112133
* PublicKeyCredentialType#PUBLIC_KEY}.
134+
*
135+
* @since 2.4.0
113136
*/
114137
public static final PublicKeyCredentialParameters RS512 =
115138
builder().alg(COSEAlgorithmIdentifier.RS512).build();
@@ -127,6 +150,7 @@ public static class MandatoryStages {
127150
* {@link PublicKeyCredentialParametersBuilder#alg(COSEAlgorithmIdentifier) alg} is a required
128151
* parameter.
129152
*
153+
* @since 0.3.0
130154
* @see PublicKeyCredentialParametersBuilder#alg(COSEAlgorithmIdentifier)
131155
*/
132156
public PublicKeyCredentialParametersBuilder alg(COSEAlgorithmIdentifier alg) {

0 commit comments

Comments
 (0)