Repository navigation
Conversation
✅ Deploy Preview for netdata-docusaurus ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configuration
⛔ Files ignored due to path filters (4)
📒 Files selected for processing (12)
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe Swagger UI dependency declarations and vendored distribution metadata now use version 5.33.1. The update adds license notices and changes the provenance test to expect the new version. ChangesSwagger UI version update
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~8 minutes Change: Other Merge Risk: ⚪ Minimal · up to The PR refreshes Swagger UI to 5.33.1, with the checked version metadata and asset hashes aligned. No actionable user-facing regression was established; the focused test could not run in this dependency-missing checkout. Architecture SummaryArchitecture risk: 🔵 Low · up to The change affects 3 systems. Changed systems: Architecture concerns Review detailsSystems and components
Before / after behavior
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
No issues found across 16 files
Confidence score: 5/5
- Automated review surfaced no issues in the provided summaries.
- No files require special attention.
Architecture diagram
sequenceDiagram
participant Dev as Developer
participant CI as CI Pipeline
participant Yarn as Yarn (Node 22)
participant Vendor as Vendor Writer
participant NPM as npm Registry
participant Test as Vitest/Node Tests
participant Build as Production Build
participant Static as Static Assets (21 files)
participant Browser as Browser/Rendered API Page
Note over Dev,NPM: Dependency Refresh Flow
Dev->>package.json: Update swagger-ui and swagger-ui-dist versions
Dev->>Yarn: Run install with frozen lockfile
Yarn->>NPM: Fetch swagger-ui-dist@5.33.1 tarball
NPM-->>Yarn: Return package + integrity hashes
Yarn->>Vendor: Trigger vendor writer for static assets
Vendor->>NPM: Read locked package manifest
NPM-->>Vendor: 21 asset files + SRI hashes
Vendor->>Static: Write swagger-ui-bundle.js, CSS, LICENSE, maps
Vendor->>Static: Write swagger-ui-vendor.json with locked version/checksums
Note over Test,Build: Verification Pipeline
Test->>Static: Verify 21 assets against manifest hashes
Test->>Vendor: Check provenance contract
Test-->>CI: 490 Vitest + 99 Node checks pass
Build->>Build: Generate 2,032 HTML pages
Build->>Static: Embed static API docs
CI->>Build: Run redirect/internal link/indexability checks
Build-->>CI: Zero static-gate findings
Note over Browser,Static: Runtime Serving (Unchanged Behavior)
Browser->>Static: Request API documentation page
Static-->>Browser: Serve swagger-ui-bundle.js + CSS
Browser->>Browser: Initialize Swagger UI with custom API init
Browser->>Browser: Render 72 operations (desktop/mobile)
Browser->>Browser: Expand operation for testing
Browser->>Browser: Block provider mutations
Note over CI,NPM: Known Remaining Items
alt sprintf-js has no upstream fix
CI->>NPM: No available patched version
else Unrelated parent holds under SEO SOW-0038
CI-->>CI: Track separately
end
Update both declared Swagger UI packages to 5.33.1 and regenerate the complete browser-served distribution through the existing vendor writer. The manifest verifies all 21 assets against the locked upstream package; the custom API initializer and approved OAuth title overlay remain unchanged. Also refresh compatible brace-expansion leaves to 1.1.21 and 5.0.12 within their existing parent ranges, without overrides.
Validation:
The dependency audit is not entirely clean. sprintf-js has no published upstream fix, and other unrelated supported-parent holds remain tracked under SEO SOW-0038. Yarn brace remediation does not claim to alter prebuilt browser bytes. Published license whitespace is retained verbatim to preserve the upstream distribution contract.
This delivers the package and served assets together, superseding the incomplete intent of #3081 and #3082. No runtime, renderer, route, content or indexing policy change is included.
Summary by cubic
Refreshes the verified Swagger UI distribution from 5.32.14 to 5.33.1, regenerating all 21 browser-served assets against the locked
swagger-ui-dist@5.33.1package. The custom API initializer and OAuth title overlay remain unchanged, and no runtime, renderer, route, content, or indexing policy changes are included.Notes
brace-expansionleaves refresh to 1.1.21 and 5.0.12 within existing parent ranges; Yarn brace remediation does not alter prebuilt browser bytes.sprintf-jshas no published upstream fix; unrelated supported-parent holds remain tracked under SEO SOW-0038.Written for commit 325a6ce. Summary will update on new commits.
Summary by CodeRabbit