Document RegisteredClient.ClientSettings#18614
Document RegisteredClient.ClientSettings#18614bloomsei wants to merge 1 commit intospring-projects:mainfrom
Conversation
| ClientSettings.builder() | ||
| .requireProofKey() <1> | ||
| .requireAuthorizationConsent() <2> | ||
| .jwkSetUrl() <3> | ||
| .tokenEndpointAuthenticationSigningAlgorithm() <4> | ||
| .x509CertificateSubjectDN() <5> | ||
| .build(); |
There was a problem hiding this comment.
I know this does not match the rest of this documentation page. To match it, I would have had to describe ClientSettings and not its builder. However, that would then describe methods like isRequireProofKey, which is not very helpful for the users.
Personally, as I user I would more expect configuration options to be described as what I would use in my application.yml/.properties rather than configuration classes themselves, but that would be even further away from the rest of the configuration.
I am happy to adopt another way of documenting this, if you tell me what to prefer in this case.
There was a problem hiding this comment.
@bloomsei Can you change the format to match the code sample in Configuring Authorization Server Settings
There was a problem hiding this comment.
I followed the code sample that you specified and used the example values from your tests. The other option would be to use the variables like Configuring Client Authentication, but I find this provides useful additional information. I hope this fits, otherwise happy to go into another direction.
Thank you for reviewing!
There was a problem hiding this comment.
Apologies @bloomsei but I lead you down the wrong path when I asked you to follow the Authorization Server settings code sample. To be consistent with the rest of the page, I think describing the accessors makes the most sense, given that there are no typed members since it's backed by a Map.
I went ahead and made the change in a polish commit. This is now merged. Thanks for the updates!
Added documentation to describe the possible client configuration options when setting up an Oauth2 Authorization Server. Signed-off-by: Elayne Bloom <5840349+bloomsei@users.noreply.github.com>
e880a11 to
d05ff9c
Compare
Added documentation to describe the possible client configuration options using
ClientSettingswhen setting up an Oauth2 Authorization Server.This change was discussed in: gh-18304