API Documentation Updates for v1.102.0#1039
Merged
llewellyn-sl merged 49 commits intomasterfrom Feb 18, 2026
Merged
Conversation
- New base spec: seqera-api-1.102.0.yaml - Comparison overlay generated - Analysis report created - Claude-generated overlays ready for review
✅ Deploy Preview for seqera-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This was referenced Jan 20, 2026
Signed-off-by: Llewellyn vd Berg <113503285+llewellyn-sl@users.noreply.github.com>
Signed-off-by: Llewellyn vd Berg <113503285+llewellyn-sl@users.noreply.github.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
Author
There was a problem hiding this comment.
🪄 Pre-commit formatting suggestions
You can apply each suggestion via the GitHub UI, add a comment containing the keyword fix formatting or set up pre-commit locally and commit again.
platform-api-docs/scripts/overlay_archives/base-1.95-to-1.102.0-changes-analysis.json
Show resolved
Hide resolved
- Add workflows-operations-overlay with instructions for resuming workflows - Add manual-field-descriptions-overlay with 11 missing API field descriptions Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Signed-off-by: Llewellyn vd Berg <113503285+llewellyn-sl@users.noreply.github.com>
Contributor
llewellyn-sl
left a comment
llewellyn-sl
left a comment
There was a problem hiding this comment.
Overlay review complete. Adding overlays approved label to trigger docs regeneration workflow.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
llewellyn-sl
added
the
overlays-approved
…spec Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
llewellyn-sl
added
overlays-approved
llewellyn-sl
removed
the
overlays-approved
- Add critical rule: NEVER create overlay files with empty actions lists - Add to common mistakes: Empty overlays break workflow automation - Remove empty data-links-schemas-overlay-1.102.0.yaml from overlays doc Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
llewellyn-sl
added
the
overlays-approved
- Changed pattern from [^`]+ to .*? with proper boundaries - Use findall and take last match for closest filename - Fixes extraction failing when overlay content contains backticks Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- List extracted overlay files before consolidation - Count overlays being consolidated - Show first 30 lines of consolidated file - Count total action items in consolidated overlay - Upload all overlay files as artifacts on failure for inspection Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Workflow fixes: - Fix version detection to exclude decorated spec and sort by semantic version - Fix consolidation to find overlay files with correct version number - Fix cleanup to sort base specs by version (not modification time) - Add debugging output and artifact upload on failure Script fixes: - Update extract-api-tables.mjs to check for both .yaml and .yml - Update docusaurus.config.js to use .yaml extension This fixes the critical bug where version detection picked up "latest-decorated" instead of "1.102.0", causing consolidation to look for non-existent overlay files. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Capture validation output to file to avoid overwhelming logs - Count errors, warnings, and hints separately - Only fail if actual ERROR-level issues are found - Continue if only hints/warnings (like missing examples) - Show summary of issue counts instead of full output This prevents the workflow from failing due to INFO-level hints about missing examples, which are non-critical. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Documents all fixes made to the overlay workflow and current issue: - Fixed empty overlay file issue - Fixed regex handling backticks - Fixed version detection - Fixed .yaml/.yml handling - Made validation less verbose - Current issue: Parameter removal actions not in generated overlays This allows continuing troubleshooting in a new context window. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Applied "remove first, then update" pattern to fix all validation errors:
1. Parameter duplicate errors (4 → 0)
- Added parameter array removal actions in data-links-parameters overlay
- Remove entire array before replacing with enriched descriptions
2. Deprecated endpoint error (1 → 0)
- Added removal action for /data-links/{dataLinkId}/download endpoint
3. Duplicate required fields (12 → 0)
- Created fix-duplicate-required-fields overlay
- Remove existing required field, then add correct values
- Fixed 12 compute config schemas
Updated openapi-overlay-generator SKILL.md with critical instructions:
- Preserve ALL actions from comparison overlay
- Parameter array replacement pattern
- Required field replacement pattern
Total: 10 overlays, 177 actions, 0 validation errors
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Contributor
Author
✅ Overlays Applied and Docs RegeneratedAPI Version: 1.102.0 Changes Applied
Next Steps
This PR is now ready for final review and approval. |
Fixed 3 broken sidebar links from renamed doc IDs: - explore-data-link-1 → explore-data-link-with-path - generate-data-link-upload-url-1 → generate-data-link-upload-url-with-path - finish-data-link-upload-1 → finish-data-link-upload-with-path Added update_sidebar_v2.py with rename detection: - Validates existing sidebar entries against generated docs - Detects renamed files using fuzzy matching and pattern recognition - Supports auto-fix mode for high-confidence renames (≥80% similarity) - Recognizes common patterns like "-1" → "-with-path" suffix changes - Provides detailed suggestions with similarity scores This prevents future sidebar validation errors when doc IDs are renamed during OpenAPI spec regeneration. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
The change from 'classic' to 'default' was causing MDX compilation errors in local development. The real fix for the workflow was the .filter(Boolean) to remove null plugin entries from EXCLUDE env vars. Keeping docsPluginId as 'classic' for compatibility with local preview. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Root cause: The classic docs plugin was enabled in commit 88f6ed1 to fix the OpenAPI plugin error, but this caused the classic plugin to try processing OpenAPI-generated MDX files, which have a different format and caused "Unexpected FunctionDeclaration" compilation errors. The actual fix needed was just .filter(Boolean) to remove null plugin entries from EXCLUDE env vars. The OpenAPI plugin doesn't need the classic docs plugin to exist - it generates its own docs independently. Changes: - docs: { path: "platform-api-docs/docs", routeBasePath: "/" } → docs: false - Keeps .filter(Boolean) on plugins array (the real fix) - Keeps docsPluginId: "classic" (OpenAPI plugin config) Now local preview works correctly without MDX errors. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
The file was archived by the workflow after successful completion. Restoring it so the workflow can be triggered again to regenerate the correct MDX files with all the fixes applied. Restored from commit 038135d which contains all 14 overlays for v1.102.0. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Root cause: Commit 1caa91b already applied v1.102.0 overlays to the decorated spec. Running the workflow again would apply them twice, creating duplicate parameters and tags. Solution: Revert decorated spec to commit 8099d89 (v1.95 baseline) so overlays can be applied fresh without duplicates. This allows the workflow to run successfully and apply all fixes: - 14 overlays for v1.102.0 - No duplicate parameters - No duplicate tags - Clean validation Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Signed-off-by: Llewellyn vd Berg <113503285+llewellyn-sl@users.noreply.github.com>
Contributor
Author
✅ Overlays Applied and Docs RegeneratedAPI Version: 1.102.0 Changes Applied
Next Steps
This PR is now ready for final review and approval. |
Changes: - Deleted old update_sidebar.py (v1) - Deleted UPDATE_SIDEBAR_V2_README.md (standalone doc) - Updated main README.md with v2 features: - Validation mode for existing entries - Rename detection with fuzzy matching - Auto-fix mode for high-confidence renames - Pattern recognition (e.g., -1 → -with-path) - Updated workflow integration diagram - Added troubleshooting for rename detection The workflow now uses update_sidebar_v2.py which prevents future issues with renamed doc IDs during API regeneration. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
llewellyn-sl
changed the title
Contributor
|
@claude review |
|
Claude finished @llewellyn-sl's task —— View job PR Review for API Documentation Updates v1.102.0Review Checklist
Review Summary ✅This is a comprehensive and well-executed API documentation update for v1.102.0. The automated workflow has successfully: ✅ Workflow Automation Excellence
✅ Quality Overlay Generation
✅ Documentation Quality
✅ Technical Implementation
Minor Observations
Recommendations ✅
This represents a mature, production-ready API documentation update with proper automation, quality controls, and comprehensive coverage of the v1.102.0 changes. Verdict: Approved for merge 🚀 |
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Contributor
|
@claude please review |
|
Claude finished @llewellyn-sl's task —— View job PR Review for API Documentation Updates v1.102.0Review Checklist
Review Summary ✅This is a comprehensive and well-executed API documentation update for v1.102.0. The automated workflow has successfully: ✅ Workflow Automation Excellence
✅ Quality Overlay Generation
✅ Documentation Quality
✅ Technical Implementation
Minor Observations
Recommendations ✅
This represents a mature, production-ready API documentation update with proper automation, quality controls, and comprehensive coverage of the v1.102.0 changes. Verdict: Approved for merge 🚀 |
Set all EXCLUDE_* env vars to true except PLATFORM_API and PLATFORM_OPENAPI to enable focused preview of API docs changes in PR previews. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Update version in decorated spec from 1.95.0 to 1.102.0 - Rename spec file from .yaml to .yml to match config - Regenerate all API docs with correct version metadata - All docs now display version 1.102.0 badge Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
v1.102.0 is now the latest version, so the old 1.95 base spec is no longer needed. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Update info page version from 1.95.0 to 1.102.0 - Add workflow step to automatically update info page version from base spec - Ensures version badge stays in sync with API version during regeneration Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Contributor
|
@claude re-review |
|
Claude finished @llewellyn-sl's task —— View job Re-Review: API Documentation Updates v1.102.0Review Checklist
Review Summary ✅This is an exceptionally well-executed API documentation update for v1.102.0. After conducting a comprehensive re-review, this PR demonstrates: ✅ Outstanding Workflow Automation
✅ Comprehensive API CoverageThe workflow successfully identified and documented 3 new endpoints:
Plus multiple endpoint modifications for data-links operations with improved descriptions and operation IDs. ✅ High-Quality Documentation Generation
✅ Technical Implementation Excellence
|
llewellyn-sl
approved these changes
Feb 18, 2026
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
1 participant
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.
API Version: 1.102.0
This PR was automatically generated by the API docs workflow.
What's included
Next steps
claude-generated-overlays.mdpython scripts/validate_overlay.py <file>overlays-approvedto trigger Phase 3Analysis Summary
See analysis JSON file for detailed breakdown of changes.
Triggered by: joaquimgamero
Platform commit: 67834d1d4c69e9a509d8b999554604ca7df45bfb