Repository navigation
Fix OpenAPI JSDoc annotations and add CI validation - #1624
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The annotation fix is valid and the CI validation is correctly scoped and documented.
0 open findings
What changed in this PR
Fixes invalid OpenAPI JSDoc annotations and adds continuous documentation validation.
Changes:
- Replaces unsupported optional-property syntax with valid JSDoc tags.
- Validates documentation generation in the Lyrical/Node 24 CI lane.
- Documents validation scope and deployment exclusions.
| File | Description |
|---|---|
lib/openapi.js |
Corrects capability parameter annotations. |
.github/workflows/linux-x64-build-and-test.yml |
Adds JSDoc generation validation. |
tools/jsdoc/README.md |
Documents CI validation behavior. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
coverage: 91.157% (+0.002%) from 91.155% — minggangw:fix-1623 into RobotWebTools:develop |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
npm run docsin the Linux x64 Lyrical/Node 24 lane for PRs and pushes.Fix: #1623