docs(oauth): refresh token API docs, Slate, and client-auth notes#3842
Open
fhanik wants to merge 1 commit intocloudfoundry:developfrom
Open
docs(oauth): refresh token API docs, Slate, and client-auth notes#3842fhanik wants to merge 1 commit intocloudfoundry:developfrom
fhanik wants to merge 1 commit intocloudfoundry:developfrom
Conversation
- Align REST doc tests with Host-based zone resolution and dynamic SAML issuer - Restore and clarify client basic auth usage in documented requests where applicable - Split and expand JWT bearer grant REST docs (secret vs private_key_jwt patterns) - Restructure Slate token section (headings, snippets, user token grant wording) - Document ClientDetailsAuthenticationProvider behavior for /oauth/token vs /oauth/token/alias/... - Add unit coverage for private_key_jwt on the OAuth token alias path
cf-foundation-community-automation
bot
moved this to Inbox
in Foundational Infrastructure Working Group
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the OAuth token and JWT bearer grant REST documentation (Spring REST Docs) and the Slate HTML sources so published API docs match current behavior. It also adds JavaDoc on ClientDetailsAuthenticationProvider explaining how the request path (/oauth/token vs /oauth/token/alias/...) affects client authentication, with a unit test guarding private_key_jwt on the alias path.
Changes
TokenEndpointDocs: Rework documented requests/snippets for token grants (zone resolution, SAML issuer, client authentication styles, clearer separation of examples).
JwtBearerGrantEndpointDocs / related mock tests: Align JWT bearer documentation and tests with distinct client authentication examples where appropriate.
AbstractTokenMockMvcTests: Shared adjustments to support the updated doc tests.
index.html.md.erb: Slate token section structure, snippet references, and copy aligned with the REST doc output.
ClientDetailsAuthenticationProvider: Document alias token path behavior for operators and maintainers.
README.md / uaa/slate/Gemfile.lock: Tested with Ruby 3.3.5 and 3.3.8 (consistent with uaa/slate/.ruby-version) for generateDocs.