ENG-49: Restore privacy-center Swagger UI#8190
Merged
Merged
Conversation
swagger-ui-react now supports React 19 (>=5.30), so re-enable the dev-only /docs page. Remove the duplicate admin-ui Swagger setup that pointed at privacy-center's pages/api folder. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Dependency ReviewThe following issues were found:
Scanned Files
|
|
lucanovera
approved these changes
May 14, 2026
Contributor
lucanovera
left a comment
lucanovera
left a comment
There was a problem hiding this comment.
Thanks for cleaning up this tech debt!
Confirmed swagger is working in dev mode. Not in production builds and completely removed from admin-ui. Approved!
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
2 participants
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.
Ticket ENG-49
Description Of Changes
The privacy-center Swagger UI page at
clients/privacy-center/app/docs/page.tsxwas disabled during the React 19 upgrade becauseswagger-ui-reactlacked React 19 peer-dep support.swagger-ui-react@5.32.6now declaresreact: ">=16.8.0 <20", so React 19 is compatible. This PR re-enables the page.While we were in there, the admin-ui had a duplicate "Fides JS docs" page (
/fides-js-docs) whosenext-swagger-docconfig pointed at../privacy-center/pages/apianyway, so it was rendering exactly the same schema. Removed it along with its route, nav entry, and itsswagger-ui-react/@types/swagger-ui-react/next-swagger-docdependencies.Code Changes
swagger-ui-react@^5.32.6and@types/swagger-ui-react@^5.18.0toclients/privacy-center/package.json.SwaggerUIimport + CSS import +<SwaggerUI url="/api/openapi.json" />render inclients/privacy-center/app/docs/page.tsx; removed the<h1>Not available</h1>placeholder./docsand/api/openapi.jsonURLs inclients/privacy-center/README.md.clients/admin-ui/src/pages/fides-js-docs.tsxandclients/admin-ui/src/pages/api/openapi.json.ts.FIDES_JS_DOCSroute export and the "Fides JS docs" nav entry from admin-ui.swagger-ui-react,@types/swagger-ui-react, andnext-swagger-docfromclients/admin-ui/package.json.clients/package-lock.json.Steps to Confirm
clients/privacy-center, runnpm run dev(port 3001).http://localhost:3001/docs— the Swagger UI should render with "Fides Privacy Center API" and the endpoints defined inpages/api/*JSDoc blocks. No console errors.http://localhost:3001/api/openapi.json— JSON schema returned.NODE_ENV=production npm run build && npm start) and visit/docs— should 404.clients/admin-ui, runnpm run dev(port 3000). Open the developer nav — there should be no "Fides JS docs" entry. Visiting/fides-js-docsdirectly should 404.Pre-Merge Checklist
CHANGELOG.mdupdatedmaindowngrade()migration is correct and works