Skip to content

fix(docs): autogenerate docs - #15028

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

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

Conversation

@mo-auto

@mo-auto mo-auto commented Sep 9, 2026

Copy link
Copy Markdown
Member

Auto generated docs
Closes #15029,

@mo-auto

mo-auto commented Sep 9, 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 Sep 9, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: c37681a2-579d-48b6-8a15-27710a60ecbf

📥 Commits

Reviewing files that changed from the base of the PR and between a580a20 and b2e94de.

📒 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 property order changed. metricsData now appears before performanceMetrics. Both properties retain their existing object structures.

Changes

FIDO2 schema documentation

Layer / File(s) Summary
Reorder metrics aggregation properties
jans-config-api/plugins/docs/fido2-plugin-swagger.yaml
The schema lists metricsData before performanceMetrics without changing their types or contents.

Priority: ⬇️ Low

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

Merge Risk: ⚪ Minimal · up to b2e94

This updates the displayed order of two FIDO2 metrics documentation properties without changing their structures or runtime behavior. No current merge-readiness risk remains.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description states that the documentation is auto-generated and references issue #15029, but it omits the required preparation checks, implementation details, test and documentation checklist, and… Complete the PR template. Add the required checklist selections, describe the implementation details, confirm static analysis and relevant tests, confirm documentation updates, and use a valid target issue entry such as "Closes #15029".
✅ 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 a documentation change that matches the pull request objective to update auto-generated Swagger documentation.
Full details: Description check

Explanation

The description states that the documentation is auto-generated and references issue #15029, but it omits the required preparation checks, implementation details, test and documentation checklist, and confirmation of the repository requirements.

  • 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 temporarily deployed to integration-tests September 9, 2026 02:10 — with GitHub Actions Inactive
@mo-auto
mo-auto temporarily deployed to integration-tests September 9, 2026 02:10 — with GitHub Actions Inactive
@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 Sep 9, 2026
@mo-auto

mo-auto commented Sep 9, 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

sonarqubecloud Bot commented Sep 9, 2026

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

1 participant