v5.0.0

5.0.0

Breaking Change: Minimum Docusaurus version is now 3.10.0. Users on Docusaurus 3.5–3.9 must upgrade before updating to this release.

This release adapts to the Tabs context API refactor in Docusaurus 3.10.0, upgrades core dependencies (@redocly/openapi-core v1→v2,
openapi-to-postmanv2 v5→v6), and includes numerous bug fixes, new features, and dependency updates.

💥 Breaking Change

• Minimum Docusaurus peerDependency bumped from ^3.5.0 to ^3.10.0
• Updated internal Tabs API to use useTabsContextValue + TabsProvider context pattern

🚀 New Feature

• feat(demo): modernized styles with swappable palettes and runtime theme switcher
  (#1371)
• feat(i18n): make QualifierMessage strings translatable (#1364)
• feat(theme): add requestCredentials option for API requests (#1300)

🐛 Bug Fix

• fix: update Tabs API for Docusaurus 3.10.0 compatibility (#1398)
• fix(cli): pass pluginInstances to getPluginConfig to support non-array plugins
  (#1384)
• fix(request-schema): render example/examples tabs for request bodies and callbacks
  (#1370)
• fix(explorer): respect encoding.contentType for multipart/form-data parts
  (#1369)
• fix(sidebars): use startsWith to extract basePath instead of split
  (#1368)
• fix(params): display const value in parameter description and Try It form
  (#1367)
• fix(explorer): encode RFC 3986 reserved chars in query parameter values
  (#1366)
• fix(license): support SPDX identifier field in OAS v3.1.0 License Object
  (#1365)
• fix: add React 19 / SSR compatibility guards (#1363)
• fix(theme): guard against unknown parameter in values to prevent crash
  (#1360)
• fix(plugin): generate unique sidebar keys for tagGroup items (#1317)
• fix(theme): improve accessibility of api explorer controls (#1325)
• fix(theme): add path-browserify webpack fallback for browser bundling
  (#1344)
• fix(theme): handle nested discriminators in allOf structures (#1303)
• fix: handle allOf with incompatible types (#1308)
• fix(plugin): support template-aware OpenAPI path binding (#1311)
• fix(theme): show dropdown for enum parameters wrapped in allOf (#1301)
• fix(theme): render code tag in Response placeholder message (#1299)

🧪 Testing

• test(demo): add regression test for oneOf $ref to allOf-composed schemas in requestBody
  (#1396)

🤖 Dependencies

• chore(deps): upgrade @redocly/openapi-core from v1 to v2 (#1361)
• chore(deps): bump openapi-to-postmanv2 from ^5.0.0 to ^6.0.0 (#1362)
• chore(deps): bump postman-collection from 5.2.0 to 5.3.0 (#1358)
• chore(deps): bump @redocly/openapi-core from 2.25.3 to 2.25.4 (#1389)
• chore(deps): bump @apidevtools/json-schema-ref-parser (#1352,
  #1386)
• chore(deps): bump lodash from 4.17.23 to 4.18.1 (#1382)
• chore(deps): bump ajv from 6.12.6 to 6.14.0 (#1383)
• chore(deps): bump clsx from 1.2.1 to 2.1.1 (#1338)
• chore(deps): bump chalk from 4.1.2 to 5.6.2 (#1357)
• chore(deps): bump allof-merge from 0.6.7 to 0.6.8 (#1373)
• chore(deps): bump sass from 1.97.2 to 1.98.0 (#1374)
• chore(deps): bump sass-loader from 16.0.6 to 16.0.7 (#1385)
• chore(deps): bump xml-formatter from 3.6.7 to 3.7.0 (#1380)
• chore(deps): bump slugify from 1.6.6 to 1.6.9 (#1381)
• chore(deps): bump react-hook-form from 7.71.1 to 7.72.0 (#1350)
• chore(deps): bump handlebars from 4.7.8 to 4.7.9 (#1347)
• chore(deps): bump fs-extra from 11.3.3 to 11.3.4 (#1337)
• chore(deps): bump path-to-regexp from 0.1.12 to 0.1.13 (https://github.com/PaloAltoNetworks/docusaurus-openapi-d...

v4.7.1

v4.7.1

Major performance improvement: The new externalJsonProps option (enabled by default) dramatically reduces build times and bundle sizes by externalizing large JSON props from MDX files.

• New externalJsonProps plugin option significantly improves build performance
• Sticky positioning for the API Explorer right panel improves UX on long API pages
• Dynamic request body updates when switching anyOf/oneOf tabs

Note: v4.7.0 had a build error affecting downstream projects. Please use v4.7.1 instead.

🚀 New Feature

• feat(plugin): add externalJsonProps option (enabled by default) to improve build performance (#1279)
• feat(theme): add sticky positioning to API Explorer right panel (#1288)
• feat: dynamically update request body when anyOf/oneOf tab changes (#1287)

🐛 Bug Fix

• fix(theme): use import type for plugin type imports (#1292)
• fix: render inline enum values in anyOf schemas (#1286)
• fix: generate correct examples for different request content types (#1284)

🏠 Refactoring

• refactor: change plugin and theme types.ts to types.d.ts (#1281)
• refactor: externalize using create() and drop size threshold requirement (#1280)

📝 Documentation

• docs: sync README and intro.mdx with plugin docs

🤖 Dependencies

• chore(deps): bump lodash from 4.17.21 to 4.17.23 (#1282)

Committers: 3

• dependabot[bot]
• Ollie Monk
• Steven Serrata

v4.6.0

What's Changed

• docs: document supported/unsupported vendor extensions by @sserrata in #1184
• Perform visual diff following deploy preview by @sserrata in #1185
• Increase visual diff concurrency by @sserrata in #1187
• Codex/create visual and html diff report by @sserrata in #1191
• Add allOf required spec and fix items branch by @sserrata in #1190
• fix(webhooks): use event name when summary missing by @sserrata in #1193
• Support both curl and bash code tab highlight by @sserrata in #1195
• Fix response schema output not rendering when using allOf within array items by @raldred in #1197
• Update GitHub Actions by @james-otten-pan in #1201
• Codex/update packages and run tests by @blindaa121 in #1196
• fix: properly encode parameters by @michaelandresen in #1202
• docs: explain swizzling DocCard by @sserrata in #1207
• Improve error handling when spec isn't valid by @Dianoga in #1200
• Additional hardening measures for GitHub Actions workflows by @sserrata in #1209
• Add maskCredentials as a pluginOption by @Devon-White in #1212
• feat(theme): add initial i18n support by @sserrata in #1210
• feat: translate additional labels by @sserrata in #1221
• refactor: use docusaurus sidebar types by @sserrata in #1220
• Fix nested anyOf/oneOf schema rendering with lazy tabs by @sserrata in #1248
• bugfix: nested oneOf/anyOf inside allOf by @sserrata in #1250
• Use --frozen-lockfile in yarn install commands by @james-otten-pan in #1262
• Refactor environment variable usage in workflow by @james-otten-pan in #1259
• feat: support const in example generation by @markrzen in #1260
• fix(theme): use matching auth scheme name in code snippet placeholders by @Revisto in #1256
• Improve API request error handling and add support for customizing requestTimeout by @sserrata in #1267
• feat: add CLI option for schema-only generation by @sserrata in #1228
• feat: display format for oneOf primitive arms by @sserrata in #1268
• Fix incorrectly encoded heading by @smeng9 in #1149
• feat(api-explorer): add OpenAPI 3.1 schema.examples support by @sserrata in #1269
• Support schema property examples (extract) by @dsuket in #1198
• feat: support schema.examples array in example generator by @sserrata in #1270
• fix: handle undefined when outputDir doesn't contain docPath by @sserrata in #1271
• feat: add showInfoPage option to disable info page generation by @sserrata in #1272
• feat: implement authPersistence in ThemeConfig by @sserrata in #1273
• Add posibility to render file array and object example for 'multipart/form-data' by @v50553490-cyber in #1266
• upgade demo to v3.9.2 by @sserrata in #1276
• fix: allow Send API Request button with proxy-only configuration by @emmanuel-ferdman in #1274
• Prepare release v4.6.0 by @sserrata in #1277

New Contributors

• @raldred made their first contribution in #1197
• @michaelandresen made their first contribution in #1202
• @Dianoga made their first contribution in #1200
• @Devon-White made their first contribution in #1212
• @Revisto made their first contribution in #1256
• @smeng9 made their first contribution in #1149
• @v50553490-cyber made their first contribution in #1266
• @emmanuel-ferdman made their first contribution in #1274

Full Changelog: v4.5.1...v4.6.0

v4.5.1

What's Changed

• Add AGENTS guidelines by @sserrata in #1179
• Fix Postman request initialization by @sserrata in #1181
• Prepare release v4.5.1 by @sserrata in #1182

Full Changelog: v4.5.0...v4.5.1

v4.5.0

What's Changed

• feat: support const for OAS 3.1.1 by @markrzen in #1143
• [UI Enhancement] Add type and format to schema field by @blindaa121 in #1148
• [UI] Add support for apiKey in query and cookie param by @blindaa121 in #1151
• Support null type by @dsuket in #1155
• Support allOf, anyOf, and oneOf schemas with properties in array item by @dsuket in #1156
• [Enhancement] Add vendor extension support for positioning sidebar items by @blindaa121 in #1160
• chore: restrict workflows to main repo by @sserrata in #1169
• docs: fix typos and tables by @sserrata in #1170
• Change the tab label of anyOf/oneOf by @dsuket in #1167
• refactor: refactor request and response example by @dsuket in #1161
• refactor: change ResponseSamples to CodeSamples by @dsuket in #1162
• refactor(theme): clean up type definitions by @sserrata in #1172
• refactor: replace Map type with Record by @sserrata in #1173
• fix types for plugin openapi by @sserrata in #1174
• chore: add typings and remove placeholders by @sserrata in #1175
• chore(demo): upgrade Docusaurus to v3.8.1 by @sserrata in #1176
• docs: update compatibility for docusaurus 3.8.1 by @sserrata in #1177
• Prepare release v4.5.0 by @sserrata in #1178

New Contributors

• @markrzen made their first contribution in #1143
• @dsuket made their first contribution in #1155

Full Changelog: v4.4.0...v4.5.0

v4.4.0

What's Changed

• Add support for Server-Sent Events (SSE) in API Explorer and configuration by @dvaJi in #1041
• Add httpbin.org spec to examples by @sserrata in #1117
• Pin GitHub Actions by @james-otten-pan in #1118
• Pin GitHub Actions by @james-otten-pan in #1124
• Pin GitHub Actions by @james-otten-pan in #1131
• feat: add support to info, and tag, and schema custom tamplates by @fernandoseguim in #1122
• fix: handle discriminator subschemas that only inherit via allOf without own properties by @amalv in #1133
• Bug fixes for enums with no type and anyof/oneof schemas by @sserrata in #1136
• Conditionally apply info template by @sserrata in #1137
• Prepare release v4.4.0 by @sserrata in #1138

New Contributors

• @dvaJi made their first contribution in #1041
• @james-otten-pan made their first contribution in #1118
• @fernandoseguim made their first contribution in #1122
• @amalv made their first contribution in #1133

Full Changelog: v4.3.7...v4.4.0

v4.3.7

What's Changed

• [Bug Fix] Properly handle empty Discriminator Tab children by @blindaa121 in #1108

Full Changelog: v4.3.6...v4.3.7

v4.3.6

What's Changed

• downloadUrl option is now available to all API entities, previously only "info" pages by @robbieaverill in #1094
• [Bug Fix]: Cannot read properties of undefined (reading 'endsWith') by @blindaa121 in #1091
• Remove URL plugin and fallback from webpack config by @sserrata in #1098
• [Bug Fix] Render fragment for empty Discriminator Tabs children by @blindaa121 in #1099
• Don't double encode application/json requestBody examples by @iain-smartretail in #1100

New Contributors

• @iain-smartretail made their first contribution in #1100

Full Changelog: v4.3.5...v4.3.6

v4.3.5

What's Changed

• fix: remove node.js dependency in browser by @himself65 in #1081
• fix: Zero values for minimum or maximum were not rendered by @c4phesua in #1087
• add missing buffer and url modules by @sserrata in #1089
• Prepare release v4.3.5 by @sserrata in #1090

New Contributors

• @himself65 made their first contribution in #1081
• @c4phesua made their first contribution in #1087

Full Changelog: v4.3.4...v4.3.5

v4.3.4

What's Changed

• Expand support for parameter serialization by @blindaa121 in #1078
• Prepare release v4.3.4 by @sserrata in #1083

Full Changelog: v4.3.3...v4.3.4