Skip to content

fix(docs): autogenerate docs - #14790

Open
mo-auto wants to merge 1 commit into
mainfrom
cn-jans-update-auto-generated-docs
Open

fix(docs): autogenerate docs#14790
mo-auto wants to merge 1 commit into
mainfrom
cn-jans-update-auto-generated-docs

Conversation

@mo-auto

@mo-auto mo-auto commented Aug 15, 2026

Copy link
Copy Markdown
Member

Auto generated docs
Closes #14791,

@mo-auto

mo-auto commented Aug 15, 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 Aug 15, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 221499fa-dc06-46a9-b586-0393ba7c57db

📥 Commits

Reviewing files that changed from the base of the PR and between 66fb82e and 2c52b46.

📒 Files selected for processing (2)
  • jans-config-api/docs/jans-config-api-swagger.yaml
  • jans-config-api/plugins/docs/fido2-plugin-swagger.yaml

📝 Walkthrough

Walkthrough

The Swagger documentation reorders existing schema properties in the Jans Config API and FIDO2 plugin definitions. No property definitions or exported entities change.

Changes

Swagger schema updates

Layer / File(s) Summary
Config access property order
jans-config-api/docs/jans-config-api-swagger.yaml
Places adminCanAccess before userCanAccess without changing either definition.
FIDO2 metrics property order
jans-config-api/plugins/docs/fido2-plugin-swagger.yaml
Moves performanceMetrics after lastUpdated and before period. Its definition remains unchanged.

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

Merge Risk: ⚪ Minimal · up to 2c52b

This is a localized documentation-only change, and no actionable merge-blocking risk remains beyond normal checks and review.

Possibly related PRs

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

Suggested reviewers: yuriyz, yurem, pujavs

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description states that the docs were auto-generated and references issue #14791, but it omits the required implementation details and checklist sections. Add the required template sections, describe the Swagger changes, and complete the preparation and test/documentation checklists.
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly identifies the main change: auto-generated documentation updates.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cn-jans-update-auto-generated-docs

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 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 comp-jans-fido2 Component affected by issue or PR labels Aug 15, 2026
@mo-auto mo-auto added the kind-bug Issue or PR is a bug in existing functionality label Aug 15, 2026
@mo-auto

mo-auto commented Aug 15, 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.

@sonarqubecloud

Copy link
Copy Markdown

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

1 participant