Skip to content

Commit c7c5ca9

Browse files
authored
Prepare release v4.6.0 (#1277)
1 parent d9275c0 commit c7c5ca9

File tree

8 files changed

+56
-13
lines changed

8 files changed

+56
-13
lines changed

CHANGELOG.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,46 @@
1+
## 4.6.0 (Jan 16, 2026)
2+
3+
High level enhancements
4+
5+
- Initial i18n (internationalization) support for translating UI labels
6+
- New `authPersistence` option to control credential storage (sessionStorage, localStorage, or disabled)
7+
- OpenAPI 3.1 `schema.examples` array support in example generation and API Explorer
8+
- New `showInfoPage` option to disable info page generation
9+
- New `maskCredentials` plugin option to mask sensitive data in generated docs
10+
- New `--schema-only` CLI flag for generating only schema documentation
11+
- Customizable `requestTimeout` in ThemeConfig for API requests
12+
13+
Other enhancements and bug fixes
14+
15+
- feat(theme): add initial i18n support ([#1210](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1210))
16+
- feat: translate additional labels ([#1221](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1221))
17+
- feat: implement authPersistence in ThemeConfig ([#1273](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1273))
18+
- feat(api-explorer): add OpenAPI 3.1 schema.examples support ([#1269](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1269))
19+
- feat: support schema.examples array in example generator ([#1270](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1270))
20+
- Support schema property examples (extract) ([#1198](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1198))
21+
- feat: add showInfoPage option to disable info page generation ([#1272](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1272))
22+
- Add maskCredentials as a pluginOption ([#1212](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1212))
23+
- feat: add CLI option for schema-only generation ([#1228](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1228))
24+
- Improve API request error handling and add support for customizing requestTimeout ([#1267](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1267))
25+
- feat: display format for oneOf primitive arms ([#1268](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1268))
26+
- feat: support const in example generation ([#1260](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1260))
27+
- 'multipart/form-data' body: Add posibility to render file array and form object example via LiveEditor ([#1266](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1266))
28+
- Support both curl and bash code tab highlight ([#1195](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1195))
29+
- fix: allow Send API Request button with proxy-only configuration ([#1274](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1274))
30+
- fix: handle undefined when outputDir doesn't contain docPath ([#1271](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1271))
31+
- fix: improve placeholder assignment in CodeSnippets component ([#1256](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1256))
32+
- bugfix: nested oneOf/anyOf inside allOf ([#1250](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1250))
33+
- Fix nested anyOf/oneOf schema rendering with lazy tabs ([#1248](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1248))
34+
- fix: properly encode parameters ([#1202](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1202))
35+
- Fix schema output missing when using allOf within array items ([#1197](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1197))
36+
- fix(webhooks): use event name when summary missing ([#1193](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1193))
37+
- Add allOf required spec and fix items branch ([#1190](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1190))
38+
- Fix incorrectly encoded heading ([#1149](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1149))
39+
- Improve error handling when spec isn't valid ([#1200](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1200))
40+
- refactor: use docusaurus sidebar types ([#1220](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1220))
41+
- docs: explain swizzling DocCard ([#1207](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1207))
42+
- docs: expand list of ignored vendor extensions ([#1184](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1184))
43+
144
## 4.5.1 (Jun 27, 2025)
245

346
High level enhancements

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Key Features:
4141

4242
| Docusaurus OpenAPI Docs | Docusaurus |
4343
| ----------------------- | --------------- |
44-
| 4.x.x (current) | `3.5.0 - 3.8.1` |
44+
| 4.x.x (current) | `3.5.0 - 3.9.2` |
4545
| 3.0.x (end-of-support) | `3.0.1 - 3.4.0` |
4646
| 2.2.3 (legacy) | `2.4.1 - 2.4.3` |
4747
| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` |
@@ -51,7 +51,7 @@ Key Features:
5151
Run the following to bootstrap a Docusaurus v3 site (classic theme) with `docusaurus-openapi-docs`:
5252

5353
```bash
54-
npx create-docusaurus@3.8.1 my-website --package-manager yarn
54+
npx create-docusaurus@3.9.2 my-website --package-manager yarn
5555
```
5656

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

demo/docs/intro.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Other ReDoc specific extensions such as `x-circular-ref`, `x-code-samples` (depr
7777

7878
| Docusaurus OpenAPI Docs | Docusaurus |
7979
| ----------------------- | --------------- |
80-
| 4.0.x (current) | `3.5.0 - 3.8.1` |
80+
| 4.x.x (current) | `3.5.0 - 3.9.2` |
8181
| 3.0.x (end-of-support) | `3.0.1 - 3.4.0` |
8282
| 2.2.3 (legacy) | `2.4.1 - 2.4.3` |
8383
| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` |
@@ -92,7 +92,7 @@ If you're building a Docusaurus site from scratch, the easiest way to get starte
9292
Run the following to bootstrap a Docusaurus v3 site (classic theme) with `docusaurus-openapi-docs`:
9393

9494
```bash
95-
npx create-docusaurus@3.8.1 my-website --package-manager yarn
95+
npx create-docusaurus@3.9.2 my-website --package-manager yarn
9696
```
9797

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

demo/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "demo",
3-
"version": "4.5.1",
3+
"version": "4.6.0",
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",
@@ -26,8 +26,8 @@
2626
"@docusaurus/plugin-google-gtag": "3.9.2",
2727
"@docusaurus/preset-classic": "3.9.2",
2828
"clsx": "^1.1.1",
29-
"docusaurus-plugin-openapi-docs": "^4.5.1",
30-
"docusaurus-theme-openapi-docs": "^4.5.1",
29+
"docusaurus-plugin-openapi-docs": "^4.6.0",
30+
"docusaurus-theme-openapi-docs": "^4.6.0",
3131
"prism-react-renderer": "^2.3.0",
3232
"react": "^19.0.0",
3333
"react-dom": "^19.0.0"

lerna.json

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

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Key Features:
4141

4242
| Docusaurus OpenAPI Docs | Docusaurus |
4343
| ----------------------- | --------------- |
44-
| 4.0.x (current) | `3.5.0 - 3.8.1` |
44+
| 4.x.x (current) | `3.5.0 - 3.9.2` |
4545
| 3.0.x (end-of-support) | `3.0.1 - 3.4.0` |
4646
| 2.2.3 (legacy) | `2.4.1 - 2.4.3` |
4747
| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` |
@@ -51,7 +51,7 @@ Key Features:
5151
Run the following to bootstrap a Docusaurus v3 site (classic theme) with `docusaurus-openapi-docs`:
5252

5353
```bash
54-
npx create-docusaurus@3.8.1 my-website --package-manager yarn
54+
npx create-docusaurus@3.9.2 my-website --package-manager yarn
5555
```
5656

5757
> 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.5.1",
4+
"version": "4.6.0",
55
"license": "MIT",
66
"keywords": [
77
"openapi",

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

Lines changed: 2 additions & 2 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.5.1",
4+
"version": "4.6.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.5.1",
41+
"docusaurus-plugin-openapi-docs": "^4.6.0",
4242
"docusaurus-plugin-sass": "^0.2.6",
4343
"eslint-plugin-prettier": "^5.5.1"
4444
},

0 commit comments

Comments
 (0)