docs: add request object doc#14126
Conversation
Signed-off-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds comprehensive Request Objects documentation and a short authorization-endpoint cross-reference: explains ChangesOpenID Connect Request Objects Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/janssen-server/auth-server/openid-features/request-objects.md`:
- Around line 160-161: Add step-by-step CLI and TUI guidance plus screenshots to
the "Configure global Request Object settings" section that currently only
references Janssen TUI / Config API; specifically, include an example CLI
sequence using the Janssen config-api client (showing the exact command(s) to
set request object properties), a TUI walkthrough labeled "Auth Server ->
Properties -> Request Objects" with 3 annotated screenshots (open list, edit
modal, save/confirm), and a short example JSON payload for the Config API call
to mirror the CLI/TUI change. Update the text around the existing "Janssen TUI"
and "Auth Server -> Properties" references to link to the new screenshots and
the Config API example so readers can follow either path.
- Line 194: Replace the camelCase server property name with the discovery claim
name: change any occurrences of "requireRequestUriRegistration" to the discovery
claim "require_request_uri_registration" in the request_uris table/description
(and the nearby occurrences noted around lines 219-222) so the doc consistently
references the runtime discovery metadata key used by clients and discovery
responses.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: f135f480-a167-4bed-a945-e4debf3b4327
📒 Files selected for processing (2)
docs/janssen-server/auth-server/endpoints/authorization.mddocs/janssen-server/auth-server/openid-features/request-objects.md
Signed-off-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
Prepare
Description
Target issue
closes #4731
Implementation Details
Test and Document the changes
Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with
docs:to indicate documentation changes or if the below checklist is not selected.Summary by CodeRabbit