Skip to content

fix(docs): autogenerate docs - #15508

Merged
moabu merged 2 commits into
mainfrom
cn-jans-update-auto-generated-docs
Nov 1, 2026
Merged

moabu merged 2 commits into
mainfrom
cn-jans-update-auto-generated-docs

Conversation

@mo-auto

@mo-auto mo-auto commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

Auto generated docs
Closes #15509,

Summary by CodeRabbit

  • Documentation
    • Updated the API reference to reflect the current ordering of token details and FIDO2 metrics fields; their existing definitions and types are unchanged.
    • Added documented application configuration options for enabling security headers and applying them to responses based on URI contents.
    • Specified JAVA as the default crypto provider in the lock plugin schema.

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review for a one-time review, or @claude review always to subscribe this PR to a review on every future push.

Tip: disable this comment in your organization's Code Review settings.

@mo-auto

mo-auto commented Oct 27, 2026 •

Copy link
Copy Markdown
Member Author

✅ 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 Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • Resume reviews
  • Trigger review

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 03e3d526-cc43-423a-a8e2-b7e094d90ee2
Commits

Reviewing files that changed from the base of the PR and between 180f1f5 and d1cdf5f.

Files selected for processing: 1
  • jans-config-api/plugins/docs/fido2-plugin-swagger.yaml

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Walkthrough

The Config API Swagger schema adds two security header properties and reorders properties in two schemas. The FIDO2 plugin Swagger schema reorders metrics properties. The lock plugin Swagger schema sets JAVA as the default for cryptoProvider.

Changes: Swagger schema updates

Layer / File(s) Summary
Update Config API schemas
jans-config-api/docs/jans-config-api-swagger.yaml
AppConfiguration adds securityHeadersEnabled and applySecurityHeadersIfUriContainsAny. JansAttribute and TokenEntity properties are reordered; their types remain unchanged.
Reorder FIDO2 metrics properties
jans-config-api/plugins/docs/fido2-plugin-swagger.yaml
Fido2MetricsAggregation properties are reordered. Their definitions remain unchanged.
Set crypto provider default
jans-config-api/plugins/docs/lock-plugin-swagger.yaml
TraceConfiguration.cryptoProvider now declares JAVA as its default.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Possibly related PRs

  • JanssenProject/jans#15476: This PR also updates generated Swagger declarations, including FIDO2 metrics properties and the cryptoProvider default.
  • JanssenProject/jans#15499: This PR overlaps the JansAttribute, TokenEntity, and TraceConfiguration.cryptoProvider declarations.
  • JanssenProject/jans#15515: This PR adds runtime AppConfiguration properties that this PR documents in the Swagger schema.

Suggested labels: comp-jans-config-api, comp-docs, area-documentation, comp-jans-fido2, comp-jans-lock

Merge Risk: Minimal · previous review d1cdf

The Swagger updates are consistent with the implemented configuration behavior and introduce no verified merge-blocking risk.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Description check Warning The description states that the documentation was autogenerated and references issue #15509. It omits the required preparation checklist, implementation details, test results, documentation checklist,… Complete the PR description template. Add the target issue in the required format, implementation details, test and static analysis results, documentation impact, and all applicable checklist selections.
Passed Passed checks: 4 passed
Check name Status Explanation
Title check Passed The title clearly identifies the main change: autogenerated documentation updates.
Linked Issues check Passed Issue #15509 is open and directly linked. The issue only states that PR #15508 lacked an open issue reference. It defines no coding requirement or acceptance criterion. No linked-issue coding requirem…
Out of Scope Changes check Passed The changes are limited to autogenerated Swagger documentation. They reorder schema properties, add two AppConfiguration properties, and set the TraceConfiguration.cryptoProvider default to JAVA…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Full details: Linked Issues check

Explanation

Issue #15509 is open and directly linked. The issue only states that PR #15508 lacked an open issue reference. It defines no coding requirement or acceptance criterion. No linked-issue coding requirement applies.

Full details: Out of Scope Changes check

Explanation

The changes are limited to autogenerated Swagger documentation. They reorder schema properties, add two AppConfiguration properties, and set the TraceConfiguration.cryptoProvider default to JAVA. These changes match the current PR intent, Auto generated docs. No unrelated change is shown.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Full details: Description check

Explanation

The description states that the documentation was autogenerated and references issue #15509. It omits the required preparation checklist, implementation details, test results, documentation checklist, and confirmation of the final PR checks.

Resolution

Complete the PR description template. Add the target issue in the required format, implementation details, test and static analysis results, documentation impact, and all applicable checklist selections.

Finishing Touches
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@mo-auto

mo-auto commented Oct 27, 2026

Copy link
Copy Markdown
Member Author

Error: Hi @mo-auto, You did not reference an open issue in your PR. I attempted to create an issue for you.
Please update that issues' title and body and make sure I correctly referenced it in the above PRs body.

@mo-auto
mo-auto deployed to integration-tests October 27, 2026 10:26 — with GitHub Actions Active
@mo-auto
mo-auto deployed to integration-tests October 27, 2026 10:26 — with GitHub Actions Active
@coderabbitai coderabbitai Bot added area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs comp-jans-config-api Component affected by issue or PR labels Oct 27, 2026
@mo-auto mo-auto added the kind-bug Issue or PR is a bug in existing functionality label Oct 27, 2026
coderabbitai[bot]
coderabbitai Bot previously approved these changes Oct 27, 2026
@mo-auto
mo-auto force-pushed the cn-jans-update-auto-generated-docs branch from f5596bf to e728fbc Compare October 28, 2026 03:16
@mo-auto
mo-auto deployed to integration-tests October 28, 2026 03:18 — with GitHub Actions Active
@mo-auto
mo-auto deployed to integration-tests October 28, 2026 03:18 — with GitHub Actions Active
@coderabbitai coderabbitai Bot added the comp-jans-fido2 Component affected by issue or PR label Oct 28, 2026
coderabbitai[bot]
coderabbitai Bot previously approved these changes Oct 28, 2026
coderabbitai[bot]
coderabbitai Bot previously approved these changes Oct 30, 2026
coderabbitai[bot]
coderabbitai Bot previously approved these changes Oct 31, 2026
@moabu
moabu merged commit e67b0fa into main Nov 1, 2026
9 of 10 checks passed
@moabu
moabu deleted the cn-jans-update-auto-generated-docs branch November 1, 2026 09:24
@moabu
moabu had a problem deploying to integration-tests November 1, 2026 09:26 — with GitHub Actions Failure
@moabu
moabu had a problem deploying to integration-tests November 1, 2026 09:26 — with GitHub Actions Failure
@sonarqubecloud

sonarqubecloud Bot commented Nov 1, 2026

Copy link
Copy Markdown

This branch had an error being deployed

1 failed deployment
integration-tests — 418b33af Deployed Nov 1, 2026 by moabu via integration (MYSQL) #1404
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-config-api Component affected by issue or PR comp-jans-fido2 Component affected by issue or PR comp-jans-lock kind-bug Issue or PR is a bug in existing functionality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix: fix(docs): autogenerate docs -autocreated

2 participants