Skip to content

fix(docs): autogenerate docs - #14862

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

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

Conversation

@mo-auto

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

Copy link
Copy Markdown
Member

Auto generated docs
Closes #14863,

Summary by CodeRabbit

  • Documentation
    • Reordered fields in the FIDO2 performance metrics documentation for improved consistency.
    • No fields or functionality were added or removed.

@mo-auto

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

@mo-auto

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

@coderabbitai

coderabbitai Bot commented Aug 26, 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: 787e3287-2a23-46a5-83cb-332e4ab61764

📥 Commits

Reviewing files that changed from the base of the PR and between 7ee988a and a1b46bb.

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

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


📝 Walkthrough

Walkthrough

The Fido2MetricsAggregation schema reorders performanceMetrics and period. No properties were added or removed.

Changes

Fido2 metrics schema

Layer / File(s) Summary
Reorder metrics properties
jans-config-api/plugins/docs/fido2-plugin-swagger.yaml
The schema places performanceMetrics before metricsData and period after metricsData.

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

Merge Risk: ⚪ Minimal · up to a1b46

This PR makes a small, localized autogenerated documentation update, and no actionable merge-blocking risk remains beyond normal checks and review.

Suggested reviewers: pujavs, yurem, yuriyz

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description identifies the change and references issue #14863, but it omits the required template sections, implementation details, test checklist, documentation checklist, and preparation confirm… Complete the repository template. Add the target issue in the required format, describe the Swagger documentation changes, confirm applicable tests and static analysis, confirm documentation status, and select the required checklist items.
✅ 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. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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 an auto-generated documentation change and matches the Swagger documentation update.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Full details: Description check

Explanation

The description identifies the change and references issue #14863, but it omits the required template sections, implementation details, test checklist, documentation checklist, and preparation confirmations.

  • Fix all pre-merge checks with AI
✨ 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.

@mo-auto mo-auto 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 kind-bug Issue or PR is a bug in existing functionality labels Aug 26, 2026
@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 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