Skip to content

fix(docs): autogenerate docs - #14823

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

fix(docs): autogenerate docs#14823
moabu merged 2 commits into
mainfrom
cn-jans-update-auto-generated-docs

Conversation

@mo-auto

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

Copy link
Copy Markdown
Member

Auto generated docs
Closes #14824,

Summary by CodeRabbit

  • Documentation
    • Updated the FIDO2 metrics API schema documentation by repositioning the performanceMetrics property for improved consistency.
    • No changes were made to the property’s structure or supported values.

@mo-auto

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

mo-auto commented Aug 20, 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 20, 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: e4a051d6-979a-4742-9cf7-1aa967bfc644

📥 Commits

Reviewing files that changed from the base of the PR and between 5364f9e and d08be1a.

📒 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 Swagger definition moves performanceMetrics within the Fido2MetricsAggregation schema. Its object type and additional-property structure remain unchanged.

Changes

FIDO2 schema update

Layer / File(s) Summary
Reorder performanceMetrics in Fido2MetricsAggregation
jans-config-api/plugins/docs/fido2-plugin-swagger.yaml
Moves the unchanged performanceMetrics property from before period to after registrationSuccesses.

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

Merge Risk: ⚪ Minimal · up to d08be

This localized documentation-only change has no actionable merge-blocking risk and is merge-ready after normal checks and review.

Possibly related PRs

Suggested labels: comp-jans-fido2

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 documentation change and target issue, but it omits the required preparation, implementation, testing, and checklist details. Complete the template sections, including implementation details, test and documentation checks, preparation confirmations, and the required documentation-impact checklist.
✅ 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 an automatically generated documentation change, which matches the Swagger documentation update.
✨ 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 the comp-jans-fido2 Component affected by issue or PR label Aug 20, 2026
@moabu
moabu had a problem deploying to integration-tests August 20, 2026 10:12 — with GitHub Actions Failure
@moabu
moabu had a problem deploying to integration-tests August 20, 2026 10:12 — with GitHub Actions Failure
@moabu
moabu merged commit 1cf9c76 into main Aug 20, 2026
11 of 13 checks passed
@moabu
moabu deleted the cn-jans-update-auto-generated-docs branch August 20, 2026 10:15
@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

2 participants