docs: add client schema doc - #14672
Conversation
Signed-off-by: Dhaval Desai <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: Dhaval Desai <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: Dhaval Desai <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: Dhaval Desai <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. |
📝 WalkthroughWalkthroughThe client schema documentation now includes an overview, a metadata reference table, Janssen-specific properties, specification links, and instructions for managing client metadata through Jans TUI and Jans CLI. ChangesClient schema documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ 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: 6
🤖 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/client-management/client-schema.md`:
- Line 103: Update the TUI capability description to say it supports “deleting
clients” instead of “removing client metadata properties,” matching the
documented client-level operations; leave the adding and modifying wording
unchanged.
- Around line 99-105: Update the “Update Client Metadata” section to include a
“Using Jans CLI” subsection or link to the existing CLI documentation, covering
the Client schema and create, update, patch, and delete operations. Keep the
existing “Using Jans TUI” guidance unchanged.
- Around line 18-22: Expand the client metadata table in “Client Metadata
Supported by Janssen Server” with configuration guidance for each listed
property group, including type, default, allowed values, recommended values, and
use cases, or link each group to the corresponding sections in
client-configuration.md. Ensure every property group has accessible guidance
rather than only its description and specification origin.
- Around line 28-31: Expand the redirect URI documentation beside
applicationType to summarize the validation rules: web clients require HTTPS and
a non-blank host, with HTTP restricted to localhost or 127.0.0.1, while native
clients support Janssen’s any-scheme behavior. Link or reference RFC 8252 and
explicitly distinguish these Janssen native-client rules from web-client
restrictions so the URI policies are not treated as interchangeable.
- Line 105: Add exactly one trailing newline at the end of the client-schema
documentation file, without changing its content or formatting.
- Around line 24-25: Update the client schema table to document Janssen JSON
types and wire-format mappings for the affected rows, including scopes and
localized fields. Specify that scopes uses an array of scope DNs while RFC 7591
scope is a space-separated string, and describe the conversion of localized
object fields to OpenID Connect members using the #<language-tag> naming form.
Apply the same clarification to the additionally referenced rows.
🪄 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 Plus
Run ID: e1ce7031-2dcd-4b5b-ab30-7f43aa3c8e4b
📒 Files selected for processing (1)
docs/janssen-server/auth-server/client-management/client-schema.md
Signed-off-by: Dhaval Desai <343411+ossdhaval@users.noreply.github.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/janssen-server/auth-server/client-management/client-schema.md (1)
53-54: 🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick winAdd
requireAuthTimeto the supported schema table.This table claims to list Janssen-supported client schema properties, but it omits
requireAuthTimebetweendefaultMaxAgeanddefaultAcrValueswhile using that wire name order elsewhere. Add the Janssen property with itsrequire_auth_timemapping.🤖 Prompt for 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. In `@docs/janssen-server/auth-server/client-management/client-schema.md` around lines 53 - 54, Add the missing requireAuthTime entry to the supported client schema table between defaultMaxAge and defaultAcrValues, documenting its mapping to the require_auth_time wire property.
🤖 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.
Outside diff comments:
In `@docs/janssen-server/auth-server/client-management/client-schema.md`:
- Around line 53-54: Add the missing requireAuthTime entry to the supported
client schema table between defaultMaxAge and defaultAcrValues, documenting its
mapping to the require_auth_time wire property.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: d9aed36d-3014-4eaa-a448-543c0b5fc5b6
📒 Files selected for processing (1)
docs/janssen-server/auth-server/client-management/client-schema.md
Prepare
Description
Add documentation for the Janssen Server Client Schema, including standard metadata, Janssen-specific properties, specification references, and TUI guidance.
Target issue
closes #4863
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