Conversation
✅ Deploy Preview for tolgee-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Bumps both packages together; the plugin and theme must share a version, otherwise API reference pages crash at runtime (p.getQualifierMessage is not a function) while the build stays green. Theme 4.x pulls postman-code-generators 2.x, which needs a browser polyfill for 'path' that the theme only adds in 4.8.0. Adds path-browserify and a small webpack fallback plugin until then. Regenerates api/ with the 4.7.1 plugin, which externalises params, request schemas and status codes into sidecar JSON files. The extra modules push the build past the default Node heap limit on Netlify, so netlify.toml raises it.
dkrizan
force-pushed
the
dkrizan/bump-openapi-docs-4-7-1
branch
from
September 2, 2026 13:25
54bab92 to
e96a04f
Compare
Member
Author
|
The first deploy preview failed with a Node out of memory error. The extra generated files push the build past the default heap limit on Netlify, so I added a netlify.toml that raises it to 4 GB. The preview builds and renders fine now. |
Member
Author
|
Closing. Main has the plugin and theme both on 4.5.1, in sync, and API pages render fine, so there is no bug to fix here. The bump also does not clear the Postman advisories - they are present on 4.7.1 too. Not worth touching 1600 generated files. #1137 stops the Dependabot noise instead. |
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.
What changed
docusaurus-plugin-openapi-docsanddocusaurus-theme-openapi-docsgo from 4.5.1 to 4.7.1, together.path-browserifyand a small webpack fallback plugin indocusaurus.config.ts.api/with the 4.7.1 plugin. The spec was not re-downloaded, so the only source of the diff is the plugin version.Why
The plugin and theme must share a version. Bumping only one of them (#1103, #1122) makes every API reference page crash in the browser while the build stays green.
Theme 4.x pulls
postman-code-generators2.x, which importspathin the browser bundle and breaks the build. Upstream fixes this in 4.8.0 (PaloAltoNetworks/docusaurus-openapi-docs#1353), which is not released yet. The fallback plugin can be removed once we are on 4.8.0.Replaces #1119. That PR moved to v5 and Docusaurus 3.10, which is a bigger change than we need right now.
About the diff size
The 4.7 plugin writes params, request schemas and status codes into three JSON files per endpoint, next to the
.api.mdx. This is not configurable, so any bump past 4.5 produces this shape. Everything underapi/is generated.Verified
npm run build,npm run eslint,npm run prettier-checkpass./api/revoke-permissionand/api/ai-playground-translatein a browser. Parameters, body schema, responses and code samples render, no console errors.