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

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

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

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

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

What's Changed

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

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

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

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

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

What's Changed

• Prevent default behavior when adding params items by @sserrata in #1073
• Add react 19 to plugin peer dependencies by @sserrata in #1074
• Prepare release v4.3.3 by @sserrata in #1075

Full Changelog: v4.3.2...v4.3.3