-
Notifications
You must be signed in to change notification settings - Fork 927
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[SDK-3159] JavaDoc updated #577
Conversation
1046401
to
e6565ce
Compare
Project coverage has decreased by 0.01% since we removed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great - I left a comment regarding your TODO. Once we address that, this is good to go 👍
@@ -19,6 +19,8 @@ | |||
* from a given Header and Payload content. | |||
* <p> | |||
* This class is thread-safe. | |||
* | |||
* TODO Poovam - Should we claim thread safety since KeyProvider implementation can cause signing differ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mean that an implementation of KeyProvider may not be thread-safe, rendering this class not thread-safe? If so, we can claim thread safety of this class, and also document that implementations of KeyProvider must be thread-safe.
*/ | ||
public static String ISSUED_AT = "iat"; | ||
|
||
/** | ||
* The "jti" (JWT ID) claim provides a unique identifier for the JWT. | ||
* Refer RFC 7529 <a href="https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7">Section 4.1.7</a> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 these are nice
default Verification withAnyOfAudience(String... audience) { | ||
throw new UnsupportedOperationException("withAnyOfAudience"); | ||
} | ||
Verification withAnyOfAudience(String... audience); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 thanks for removing the default implementation
Changes
We have updated the Java doc with relevant information and made a few required changes.
This includes