Skip to content

Commit dd7a98f

Browse files
sserrataclaude
andcommitted
Prepare release v5.0.0
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 267f100 commit dd7a98f

File tree

7 files changed

+123
-19
lines changed

7 files changed

+123
-19
lines changed

CHANGELOG.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,104 @@
1+
## 5.0.0 (2026-04-08)
2+
3+
**Breaking Change:** Minimum Docusaurus version is now `3.10.0`. Users on Docusaurus 3.5–3.9 must upgrade before updating to this release.
4+
5+
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.
6+
7+
#### :boom: Breaking Change
8+
9+
- Minimum Docusaurus peerDependency bumped from `^3.5.0` to `^3.10.0`
10+
- Updated internal Tabs API to use `useTabsContextValue` + `TabsProvider` context pattern
11+
12+
#### :rocket: New Feature
13+
14+
- feat(demo): modernized styles with swappable palettes and runtime theme switcher ([#1371](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1371))
15+
- feat(i18n): make QualifierMessage strings translatable ([#1364](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1364))
16+
- feat(theme): add requestCredentials option for API requests ([#1300](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1300))
17+
18+
#### :bug: Bug Fix
19+
20+
- fix: update Tabs API for Docusaurus 3.10.0 compatibility ([#1398](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1398))
21+
- fix(cli): pass pluginInstances to getPluginConfig to support non-array plugins (#1246) ([#1384](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1384))
22+
- fix(request-schema): render example/examples tabs for request bodies and callbacks ([#1370](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1370))
23+
- fix(explorer): respect encoding.contentType for multipart/form-data parts ([#1369](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1369))
24+
- fix(sidebars): use startsWith to extract basePath instead of split ([#1368](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1368))
25+
- fix(params): display const value in parameter description and Try It form ([#1367](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1367))
26+
- fix(explorer): encode RFC 3986 reserved chars in query parameter values ([#1366](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1366))
27+
- fix(license): support SPDX identifier field in OAS v3.1.0 License Object ([#1365](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1365))
28+
- fix: add React 19 / SSR compatibility guards ([#1363](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1363))
29+
- fix(theme): guard against unknown parameter `in` values to prevent crash ([#1360](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1360))
30+
- fix(plugin): generate unique sidebar keys for tagGroup items ([#1317](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1317))
31+
- fix(theme): improve accessibility of api explorer controls ([#1325](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1325))
32+
- fix(theme): add path-browserify webpack fallback for browser bundling ([#1344](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1344))
33+
- fix(theme): handle nested discriminators in allOf structures ([#1303](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1303))
34+
- fix: handle allOf with incompatible types ([#1308](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1308))
35+
- fix(plugin): support template-aware OpenAPI path binding ([#1311](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1311))
36+
- fix(theme): show dropdown for enum parameters wrapped in allOf ([#1301](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1301))
37+
- fix(theme): render code tag in Response placeholder message ([#1299](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1299))
38+
39+
#### :test_tube: Testing
40+
41+
- test(demo): add regression test for oneOf $ref to allOf-composed schemas in requestBody ([#1396](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1396))
42+
43+
#### :robot: Dependencies
44+
45+
- chore(deps): bump actions/checkout from 4.2.2 to 6.0.2 ([#1392](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1392))
46+
- chore(deps): bump actions/cache from 3.4.3 to 5.0.4 ([#1394](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1394))
47+
- chore(deps): bump actions/download-artifact from 4.2.1 to 8.0.1 ([#1393](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1393))
48+
- chore(deps): bump actions/setup-node from 2.5.2 to 6.3.0 ([#1391](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1391))
49+
- chore(deps): bump google-github-actions/auth from 2.1.12 to 3.0.0 ([#1390](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1390))
50+
- chore(deps): bump @redocly/openapi-core from 2.25.3 to 2.25.4 ([#1389](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1389))
51+
- chore(deps): bump @apidevtools/json-schema-ref-parser ([#1386](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1386))
52+
- chore(deps): bump sass-loader from 16.0.6 to 16.0.7 ([#1385](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1385))
53+
- chore(deps): bump ajv from 6.12.6 to 6.14.0 ([#1383](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1383))
54+
- chore(deps): bump lodash from 4.17.23 to 4.18.1 ([#1382](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1382))
55+
- chore(deps): upgrade eslint 7 → 8 and update related plugins
56+
- chore(deps): bump slugify from 1.6.6 to 1.6.9 ([#1381](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1381))
57+
- chore(deps): bump xml-formatter from 3.6.7 to 3.7.0 ([#1380](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1380))
58+
- chore(deps): bump sass from 1.97.2 to 1.98.0 ([#1374](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1374))
59+
- chore(deps): bump allof-merge from 0.6.7 to 0.6.8 ([#1373](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1373))
60+
- chore(deps): bump openapi-to-postmanv2 from ^5.0.0 to ^6.0.0 ([#1362](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1362))
61+
- chore(deps): upgrade @redocly/openapi-core from v1 to v2 ([#1361](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1361))
62+
- chore(deps): bump chalk from 4.1.2 to 5.6.2 ([#1357](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1357))
63+
- chore(deps): bump postman-collection from 5.2.0 to 5.3.0 ([#1358](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1358))
64+
- chore(deps): bump path-to-regexp from 0.1.12 to 0.1.13 ([#1354](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1354))
65+
- chore(deps): bump @apidevtools/json-schema-ref-parser ([#1352](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1352))
66+
- chore(deps): bump react-hook-form from 7.71.1 to 7.72.0
67+
- chore(deps): bump handlebars from 4.7.8 to 4.7.9 ([#1347](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1347))
68+
- chore(deps): bump fs-extra from 11.3.3 to 11.3.4 ([#1337](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1337))
69+
- chore(deps): bump clsx from 1.2.1 to 2.1.1 ([#1338](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1338))
70+
- chore(deps): bump the react group with 2 updates ([#1342](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1342))
71+
- chore(deps): bump immutable from 5.1.4 to 5.1.5 ([#1323](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1323))
72+
- chore(deps): bump svgo from 3.3.2 to 3.3.3 ([#1324](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1324))
73+
- chore(deps): bump flatted from 3.3.3 to 3.4.2 ([#1330](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1330))
74+
- chore(deps): bump qs from 6.14.1 to 6.14.2 ([#1310](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1310))
75+
76+
#### :wrench: Maintenance
77+
78+
- chore(deps-dev): bump fast-xml-parser from 5.5.9 to 5.5.10 ([#1388](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1388))
79+
- chore(deps-dev): bump @babel/core from 7.28.6 to 7.29.0 ([#1387](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1387))
80+
- chore(deps-dev): bump eslint-plugin-testing-library from 4.12.4 to 6.5.0 ([#1379](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1379))
81+
- chore(deps-dev): bump pixelmatch from 5.3.0 to 7.1.0 ([#1378](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1378))
82+
- chore(deps-dev): bump playwright from 1.58.2 to 1.59.1 ([#1377](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1377))
83+
- chore(deps-dev): bump fast-xml-parser from 5.5.7 to 5.5.9 ([#1376](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1376))
84+
- chore(deps-dev): bump prettier from 3.8.0 to 3.8.1 ([#1375](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1375))
85+
- chore(deps-dev): bump playwright from 1.57.0 to 1.58.2 ([#1372](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1372))
86+
- chore(deps-dev): bump @types/node from 17.0.45 to 25.5.0 ([#1356](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1356))
87+
- chore(deps-dev): bump start-server-and-test from 1.15.5 to 3.0.0 ([#1351](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1351))
88+
- chore(deps-dev): bump lerna from 8.2.4 to 9.0.7
89+
- chore(deps-dev): bump eslint-plugin-jest from 25.7.0 to 28.14.0
90+
- chore(deps-dev): bump eslint-plugin-jest-dom from 3.9.4 to 5.5.0 ([#1339](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1339))
91+
- chore(deps-dev): bump husky from 7.0.4 to 9.1.7 ([#1343](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1343))
92+
- chore(deps-dev): bump fast-xml-parser from 4.5.3 to 5.5.7 ([#1329](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1329))
93+
94+
#### Committers: 5
95+
96+
- dependabot[bot]
97+
- Emmanuel Ferdman
98+
- Emmanuel Roussel
99+
- Steven Serrata
100+
- vabrosimov
101+
1102
## 4.7.1 (2026-01-27)
2103

3104
Hotfix release for build error in v4.7.0.

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,18 @@ Key Features:
4141

4242
| Docusaurus OpenAPI Docs | Docusaurus |
4343
| ----------------------- | --------------- |
44-
| 4.x.x (current) | `3.5.0 - 3.9.2` |
44+
| 5.x.x (current) | `3.10.0+` |
45+
| 4.x.x (legacy) | `3.5.0 - 3.9.2` |
4546
| 3.0.x (end-of-support) | `3.0.1 - 3.4.0` |
46-
| 2.2.3 (legacy) | `2.4.1 - 2.4.3` |
47+
| 2.2.3 (end-of-support) | `2.4.1 - 2.4.3` |
4748
| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` |
4849

4950
## Bootstrapping from Template (new Docusaurus site)
5051

5152
Run the following to bootstrap a Docusaurus v3 site (classic theme) with `docusaurus-openapi-docs`:
5253

5354
```bash
54-
npx create-docusaurus@3.9.2 my-website --package-manager yarn
55+
npx create-docusaurus@3.10.0 my-website --package-manager yarn
5556
```
5657

5758
> When prompted to select a template choose `Git repository`.

demo/docs/intro.mdx

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,13 @@ Other ReDoc specific extensions such as `x-circular-ref`, `x-code-samples` (depr
7575

7676
## Compatibility Matrix
7777

78-
| Docusaurus OpenAPI Docs | Docusaurus |
79-
| ----------------------- | --------------- |
80-
| 4.x.x (current) | `3.5.0 - 3.9.2` |
81-
| 3.0.x (end-of-support) | `3.0.1 - 3.4.0` |
82-
| 2.2.3 (legacy) | `2.4.1 - 2.4.3` |
83-
| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` |
78+
| Docusaurus OpenAPI Docs | Docusaurus |
79+
| ----------------------- | ---------------- |
80+
| 5.x.x (current) | `3.10.0+` |
81+
| 4.x.x (legacy) | `3.5.0 - 3.9.2` |
82+
| 3.0.x (end-of-support) | `3.0.1 - 3.4.0` |
83+
| 2.2.3 (end-of-support) | `2.4.1 - 2.4.3` |
84+
| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` |
8485

8586

8687
:::tip
@@ -92,7 +93,7 @@ If you're building a Docusaurus site from scratch, the easiest way to get starte
9293
Run the following to bootstrap a Docusaurus v3 site (classic theme) with `docusaurus-openapi-docs`:
9394

9495
```bash
95-
npx create-docusaurus@3.9.2 my-website --package-manager yarn
96+
npx create-docusaurus@3.10.0 my-website --package-manager yarn
9697
```
9798

9899
> When prompted to select a template choose `Git repository`.

lerna.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"version": "4.7.1",
2+
"version": "5.0.0",
33
"npmClient": "yarn"
44
}

packages/docusaurus-plugin-openapi-docs/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,18 @@ Key Features:
4141

4242
| Docusaurus OpenAPI Docs | Docusaurus |
4343
| ----------------------- | --------------- |
44-
| 4.x.x (current) | `3.5.0 - 3.9.2` |
44+
| 5.x.x (current) | `3.10.0+` |
45+
| 4.x.x (legacy) | `3.5.0 - 3.9.2` |
4546
| 3.0.x (end-of-support) | `3.0.1 - 3.4.0` |
46-
| 2.2.3 (legacy) | `2.4.1 - 2.4.3` |
47+
| 2.2.3 (end-of-support) | `2.4.1 - 2.4.3` |
4748
| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` |
4849

4950
## Bootstrapping from Template (new Docusaurus site)
5051

5152
Run the following to bootstrap a Docusaurus v3 site (classic theme) with `docusaurus-openapi-docs`:
5253

5354
```bash
54-
npx create-docusaurus@3.9.2 my-website --package-manager yarn
55+
npx create-docusaurus@3.10.0 my-website --package-manager yarn
5556
```
5657

5758
> When prompted to select a template choose `Git repository`.

packages/docusaurus-plugin-openapi-docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "docusaurus-plugin-openapi-docs",
33
"description": "OpenAPI plugin for Docusaurus.",
4-
"version": "4.7.1",
4+
"version": "5.0.0",
55
"license": "MIT",
66
"keywords": [
77
"openapi",

packages/docusaurus-theme-openapi-docs/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "docusaurus-theme-openapi-docs",
33
"description": "OpenAPI theme for Docusaurus.",
4-
"version": "4.7.1",
4+
"version": "5.0.0",
55
"license": "MIT",
66
"keywords": [
77
"openapi",
@@ -38,7 +38,7 @@
3838
"@types/postman-collection": "^3.5.11",
3939
"@types/react-modal": "^3.16.3",
4040
"concurrently": "^9.2.0",
41-
"docusaurus-plugin-openapi-docs": "^4.7.1",
41+
"docusaurus-plugin-openapi-docs": "^5.0.0",
4242
"docusaurus-plugin-sass": "^0.2.6",
4343
"eslint-plugin-prettier": "^5.5.1"
4444
},
@@ -47,13 +47,13 @@
4747
"@reduxjs/toolkit": "^2.8.2",
4848
"allof-merge": "^0.6.6",
4949
"buffer": "^6.0.3",
50-
"path-browserify": "^1.0.1",
5150
"clsx": "^2.1.1",
5251
"copy-text-to-clipboard": "^3.2.0",
5352
"crypto-js": "^4.2.0",
5453
"file-saver": "^2.0.5",
5554
"lodash": "^4.17.21",
5655
"pako": "^2.1.0",
56+
"path-browserify": "^1.0.1",
5757
"postman-code-generators": "^2.0.0",
5858
"postman-collection": "^5.0.2",
5959
"prism-react-renderer": "^2.4.1",
@@ -74,7 +74,7 @@
7474
},
7575
"peerDependencies": {
7676
"@docusaurus/theme-common": "^3.10.0",
77-
"docusaurus-plugin-openapi-docs": "^4.0.0",
77+
"docusaurus-plugin-openapi-docs": "^5.0.0",
7878
"docusaurus-plugin-sass": "^0.2.3",
7979
"react": "^16.8.4 || ^17.0.0 || ^18.0.0 || ^19.0.0",
8080
"react-dom": "^16.8.4 || ^17.0.0 || ^18.0.0 || ^19.0.0"

0 commit comments

Comments
 (0)