docs: add JARM doc by ossdhaval · Pull Request #13969 · JanssenProject/jans (original) (raw)
📝 Walkthrough
Walkthrough
Replaces a placeholder with full JARM documentation: defines JARM behavior, supported response modes and shorthand, Janssen-specific configuration and client metadata, runtime signing/encryption rules, endpoint/key discovery details, FAPI validation rules, and usage guidance.
Changes
JARM Documentation
| Layer / File(s) | Summary |
|---|---|
| Introduction & response_mode mapping docs/janssen-server/auth-server/openid-features/jarm.md | Introduces JARM, supported response_mode values (including jwt shorthand), and Janssen’s default mapping from response_type to query.jwt vs fragment.jwt. |
| Server & client configuration docs/janssen-server/auth-server/openid-features/jarm.md | Adds authorization server capability properties and per-client metadata for signing and optional encryption; documents runtime selection of signed vs encrypted vs nested JWT responses. |
| Authorization endpoint, discovery & JWKS docs/janssen-server/auth-server/openid-features/jarm.md | Documents how to request JARM at the authorization endpoint, required OpenID configuration discovery claims indicating support, and the JWKS endpoint used to validate response JWS signatures. |
| Request parameters & response format docs/janssen-server/auth-server/openid-features/jarm.md | Specifies authorization request parameters including response_mode options, and the front-channel response format change to a single response= carrying standard authorization response data. |
| FAPI compatibility rules docs/janssen-server/auth-server/openid-features/jarm.md | Documents stricter validation when fapiCompatibility is enabled: force response_mode=jwt for response_type=code and reject response_mode=query. |
| Use cases & related links docs/janssen-server/auth-server/openid-features/jarm.md | Adds guidance on JARM use cases and links to related documentation (authorization endpoint, PAR, server configuration properties). |
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~10 minutes
Suggested labels
comp-jans-auth-server
Suggested reviewers
- SafinWasi 🚥 Pre-merge checks | ✅ 5 ✅ Passed checks (5 passed)
| Check name | Status | Explanation |
|---|---|---|
| Title check | ✅ Passed | The title 'docs: add JARM doc' is concise and clearly describes the main change: adding documentation for JARM. |
| Description check | ✅ Passed | The description follows the template structure with target issue #4734 linked, PR guidelines and license acknowledged, and proper docs prefix confirmation. |
| Linked Issues check | ✅ Passed | The PR successfully addresses issue #4734 by replacing placeholder JARM documentation with comprehensive content covering definition, configuration, usage, FAPI compatibility, and metadata. |
| Out of Scope Changes check | ✅ Passed | All changes are scoped to JARM documentation updates in a single markdown file; no unrelated code modifications are present. |
| Docstring Coverage | ✅ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches 🧪 Generate unit tests (beta)
- Create PR with unit tests
- Commit unit tests in branch
docs-add-JARM-docs
Tip
💬 Introducing Slack Agent: The best way for teams to turn conversations into code.
Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
- Generate code and open pull requests
- Plan features and break down work
- Investigate incidents and troubleshoot customer tickets together
- Automate recurring tasks and respond to alerts with triggers
- Summarize progress and report instantly
Built for teams:
- Shared memory across your entire org—no repeating context
- Per-thread sandboxes to safely plan and execute work
- Governance built-in—scoped access, auditability, and budget controls
One agent for your entire SDLC. Right inside Slack.
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.
❤️ Share
Comment @coderabbitai help to get the list of available commands and usage tips.