Skip to content

DOCS-3131: Upgrade swagger-ui-react to 5.x - #3154

Merged
ctauchen merged 2 commits into
tigera:mainfrom
ctauchen:dependabot-5-swagger-ui-5
Oct 22, 2026
Merged

ctauchen merged 2 commits into
tigera:mainfrom
ctauchen:dependabot-5-swagger-ui-5

Conversation

@ctauchen

@ctauchen ctauchen commented Oct 22, 2026 •

Copy link
Copy Markdown
Collaborator

Upgrades swagger-ui-react from 4.19 to 5.34. It no longer pins old dompurify, js-yaml and patch-package versions, so the three resolutions that worked around those pins are removed.

https://tigera.atlassian.net/browse/DOCS-3131

Preview: https://deploy-preview-3154--tigera.netlify.app/calico/latest/reference/rest-api-reference/

  • Part 5 of 5, stacked on DOCS-3131: Upgrade crawlee and remove unused dependencies #3153. Merge in order.
  • static/css/swagger-ui.css is now the 5.34 stylesheet, with the existing header and the .info .title colour override reapplied. The old file came from 4.14.
  • .yarnrc.yml declares three imports that swagger-ui-react 5 and its dependencies use without declaring. The strict pnpm linker breaks the build without them.
  • Scarf telemetry is disabled with scarfSettings, and its postinstall is blocked with dependenciesMeta.
  • Local clean build: the HTML for all 2982 pages matches main. llms.txt output is unchanged, and no rest-api-reference.md twins are generated.
  • All 261 operations render. 5.x virtualizes the list, so only visible operations are in the DOM, and it adds an OAS 2.0 badge.
  • To rebuild the lockfile after a rebase: yarn install.

Copilot AI lite review requested due to automatic review settings October 22, 2026 10:21
@ctauchen
ctauchen requested a review from a team as a code owner October 22, 2026 10:21

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No unresolved review issues were identified, and the changes were assessed as approval-ready.

No open issues 🎉

What changed in this PR

Upgrades swagger-ui-react from 4.19 to 5.34, refreshes related dependency configuration, and removes obsolete Mermaid and dependency workarounds.

Changes:

  • Upgrades Swagger UI and updates dependency resolutions.
  • Adds package extensions for strict pnpm-linker compatibility.
  • Disables Scarf telemetry and postinstall behavior.
  • Removes unused Mermaid configuration and dependencies.
File Description
package.json Updates dependencies, resolutions, and Scarf configuration.
docusaurus.config.js Removes unused Mermaid configuration.
.yarnrc.yml Adds package extensions required by Swagger UI dependencies.

Review effort: Lite

@netlify

netlify Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview succeeded!

Built without sensitive environment variables

Name Link
🔨 Latest commit bd9a8f1
🔍 Latest deploy log https://app.netlify.com/projects/tigera/deploys/6ad9fbde044abadc5a95ba2d
😎 Deploy Preview https://deploy-preview-3154--tigera.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 73 (🟢 up 2 from production)
Accessibility: 98 (no change from production)
Best Practices: 92 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for calico-docs-preview-next ready!

Name Link
🔨 Latest commit bd9a8f1
🔍 Latest deploy log https://app.netlify.com/projects/calico-docs-preview-next/deploys/6ad9fbded4ae4b7b67336048
😎 Deploy Preview https://deploy-preview-3154--calico-docs-preview-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@ctauchen
ctauchen force-pushed the dependabot-5-swagger-ui-5 branch from 59a4110 to bd9a8f1 Compare October 22, 2026 12:04
@ctauchen
ctauchen merged commit bb59417 into tigera:main Oct 22, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants