Skip to content

docs: add client schema doc - #14672

Open
ossdhaval wants to merge 6 commits into
mainfrom
docs-client-schema
Open

docs: add client schema doc#14672
ossdhaval wants to merge 6 commits into
mainfrom
docs-client-schema

Conversation

@ossdhaval

@ossdhaval ossdhaval commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

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

  • Static code analysis has been run locally and issues have been fixed
  • Relevant unit and integration tests have been added/updated
  • Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

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.

  • I confirm that there is no impact on the docs due to the code changes in this PR.

Summary by CodeRabbit

  • Documentation
    • Replaced placeholder client schema documentation with a comprehensive overview.
    • Added reference tables covering standard, specification-specific, localized, and Janssen-specific client metadata.
    • Added instructions for managing client metadata using Jans TUI and Jans CLI.

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>
@ossdhaval
ossdhaval requested a review from manojs1978 July 31, 2026 08:27
@ossdhaval ossdhaval self-assigned this Jul 31, 2026
@ossdhaval ossdhaval added kind-bug Issue or PR is a bug in existing functionality area-documentation Documentation needs to change as part of issue or PR comp-jans-auth-server Component affected by issue or PR comp-docs Touching folder /docs labels Jul 31, 2026
@mo-auto

mo-auto commented Jul 31, 2026

Copy link
Copy Markdown
Member

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The 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.

Changes

Client schema documentation

Layer / File(s) Summary
Define client metadata reference
docs/janssen-server/auth-server/client-management/client-schema.md
Adds an overview of supported OAuth 2.0 and OpenID Connect metadata, Janssen-specific extensions, and a reference table of client properties.
Document metadata updates
docs/janssen-server/auth-server/client-management/client-schema.md
Explains how to manage client metadata through Jans TUI and Jans CLI and removes the former in-progress content.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: manojs1978

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The documentation covers schema metadata and TUI/CLI management, but the summary does not show feature flags, recommended values, use cases, or screenshots required by #4863. Add Janssen Server feature flags, recommended values, use cases, and applicable screenshots, and include a brief definition with a direct specification link.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation change for the client schema.
Description check ✅ Passed The description explains the documentation scope and links the target issue, but several checklist items remain unchecked.
Out of Scope Changes check ✅ Passed The changes are limited to client schema documentation and align with the scope of issue #4863.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-client-schema

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 65c00ff and 827eca7.

📒 Files selected for processing (1)
  • docs/janssen-server/auth-server/client-management/client-schema.md

Comment thread docs/janssen-server/auth-server/client-management/client-schema.md
Comment thread docs/janssen-server/auth-server/client-management/client-schema.md
Comment thread docs/janssen-server/auth-server/client-management/client-schema.md
Comment thread docs/janssen-server/auth-server/client-management/client-schema.md Outdated
Comment thread docs/janssen-server/auth-server/client-management/client-schema.md Outdated
Comment thread docs/janssen-server/auth-server/client-management/client-schema.md Outdated
Signed-off-by: Dhaval Desai <343411+ossdhaval@users.noreply.github.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 win

Add requireAuthTime to the supported schema table.

This table claims to list Janssen-supported client schema properties, but it omits requireAuthTime between defaultMaxAge and defaultAcrValues while using that wire name order elsewhere. Add the Janssen property with its require_auth_time mapping.

🤖 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

📥 Commits

Reviewing files that changed from the base of the PR and between 827eca7 and c7d6eae.

📒 Files selected for processing (1)
  • docs/janssen-server/auth-server/client-management/client-schema.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs comp-jans-auth-server Component affected by issue or PR kind-bug Issue or PR is a bug in existing functionality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(client mgmt): create documentation for client schema

2 participants