Skip to content

Commit 808e4a2

Browse files
sserratasserrata
authored
Prepare release v4.4.0 (#1138)
1 parent 7a4666c commit 808e4a2

File tree

8 files changed

+81
-49
lines changed

8 files changed

+81
-49
lines changed

‎CHANGELOG.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1+
## 4.4.0 (May 2, 2025)
2+
3+
High level enhancements
4+
5+
- Extend template support to info, tag and schema docs
6+
- Add support for Server-Sent Events (SSE) to API Explorer
7+
- Various bug fixes
8+
9+
Other enhancements and bug fixes
10+
11+
- conditionally apply info template ([#1137](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1137))
12+
- Fixes for enums with no type and anyof/oneof schemas ([#1136](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1136))
13+
- fix: add discriminator empty subschema and safeguard check in DiscriminatorNode ([#1133](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1133))
14+
- feat: add support to info, and tag, and schema custom tamplates ([#1122](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1122))
15+
- Pin GitHub Actions ([#1131](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1131))
16+
- fix linter errors
17+
- Pin github actions ([#1124](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1124))
18+
- Update deploy-preview.yml
19+
- Update deploy-live.yml
20+
- Pin github actions ([#1118](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1118))
21+
- add httpbin.org spec to examples ([#1117](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1117))
22+
- Add support for Server-Sent Events (SSE) in API Explorer and configuration ([#1041](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1041))
23+
124
## 4.3.7 (Mar 12, 2025)
225

326
Bug fixes

‎README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<div align="center">
88

9-
OpenAPI plugin for generating API reference docs in Docusaurus v3 (compatible with [Docusaurus Faster](https://github.com/facebook/docusaurus/issues/10556).
9+
OpenAPI plugin for generating API reference docs in Docusaurus v3 (compatible with [Docusaurus Faster](https://github.com/facebook/docusaurus/issues/10556)).
1010

1111
<img src="https://img.shields.io/badge/dynamic/json?style=for-the-badge&logo=meta&color=blueviolet&label=Docusaurus&query=dependencies%5B%22%40docusaurus%2Fcore%22%5D&url=https%3A%2F%2Fraw.githubusercontent.com%2FPaloAltoNetworks%2Fdocusaurus-openapi-docs%2Fmain%2Fdemo%2Fpackage.json" />
1212
<br/><br/>
@@ -155,22 +155,25 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
155155

156156
`config` can be configured with the following options:
157157

158-
| Name | Type | Default | Description |
159-
| -------------------- | --------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
160-
| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or directory of multiple OpenAPI specification files. |
161-
| `ouputDir` | `string` | `null` | Desired output path for generated MDX and sidebar files. |
162-
| `proxy` | `string` | `null` | _Optional:_ Proxy URL to prepend to base URL when performing API requests from browser. |
163-
| `template` | `string` | `null` | _Optional:_ Customize MDX content with a desired template. |
164-
| `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading OpenAPI specification. (requires `info` section/doc) |
165-
| `hideSendButton` | `boolean` | `null` | _Optional:_ If set to `true`, hides the "Send API Request" button in API demo panel |
166-
| `showExtensions` | `boolean` | `null` | _Optional:_ If set to `true`, renders operation-level vendor-extensions in description. |
167-
| `sidebarOptions` | `object` | `null` | _Optional:_ Set of options for sidebar configuration. See below for a list of supported options. |
168-
| `version` | `string` | `null` | _Optional:_ Version assigned to single or micro-spec API specified in `specPath`. |
169-
| `label` | `string` | `null` | _Optional:_ Version label used when generating version selector dropdown menu. |
170-
| `baseUrl` | `string` | `null` | _Optional:_ Version base URL used when generating version selector dropdown menu. |
171-
| `versions` | `object` | `null` | _Optional:_ Set of options for versioning configuration. See below for a list of supported options. |
172-
| `markdownGenerators` | `object` | `null` | _Optional:_ Customize MDX content with a set of options for specifying markdown generator functions. See below for a list of supported options. |
173-
| `showSchemas` | `boolean` | `null` | _Optional:_ If set to `true`, generates schema pages and adds them to the sidebar. |
158+
| Name | Type | Default | Description |
159+
| -------------------- | --------- | ------- | --------------------------------------------------------------------------------------------------------------------------- |
160+
| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or directory of multiple OpenAPI specification files. |
161+
| `outputDir` | `string` | `null` | Desired output path for generated MDX and sidebar files. |
162+
| `proxy` | `string` | `null` | _Optional:_ Proxy URL to prepend to base URL when performing API requests from browser. |
163+
| `template` | `string` | `null` | _Optional:_ Customize MDX content with a desired template. |
164+
| `infoTemplate` | `string` | `null` | _Optional:_ Customize MDX content for **info** pages only. |
165+
| `tagTemplate` | `string` | `null` | _Optional:_ Customize MDX content for **tag** pages only. |
166+
| `schemaTemplate` | `string` | `null` | _Optional:_ Customize MDX content for **schema** pages only. |
167+
| `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading OpenAPI specification. (requires `info` section/doc) |
168+
| `hideSendButton` | `boolean` | `null` | _Optional:_ If set to `true`, hides the “Send API Request” button in the API demo panel. |
169+
| `showExtensions` | `boolean` | `null` | _Optional:_ If set to `true`, renders operation‑level vendor‑extensions in descriptions. |
170+
| `sidebarOptions` | `object` | `null` | _Optional:_ Set of options for sidebar configuration. See below for a list of supported options. |
171+
| `version` | `string` | `null` | _Optional:_ Version assigned to a single or micro‑spec API specified in `specPath`. |
172+
| `label` | `string` | `null` | _Optional:_ Version label used when generating the version‑selector dropdown menu. |
173+
| `baseUrl` | `string` | `null` | _Optional:_ Base URL for versioned docs in the version‑selector dropdown. |
174+
| `versions` | `object` | `null` | _Optional:_ Options for versioning configuration. See below for a list of supported options. |
175+
| `markdownGenerators` | `object` | `null` | _Optional:_ Customize MDX content via generator functions. See below for a list of supported options. |
176+
| `showSchemas` | `boolean` | `null` | _Optional:_ If set to `true`, generates standalone schema pages and adds them to the sidebar. |
174177

175178
### sidebarOptions
176179

‎demo/docs/intro.mdx

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -186,19 +186,22 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
186186
| Name | Type | Default | Description |
187187
| -------------------- | --------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
188188
| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or directory of multiple OpenAPI specification files. |
189-
| `ouputDir` | `string` | `null` | Desired output path for generated MDX and sidebar files. |
189+
| `outputDir` | `string` | `null` | Desired output path for generated MDX and sidebar files. |
190190
| `proxy` | `string` | `null` | _Optional:_ Proxy URL to prepend to base URL when performing API requests from browser. |
191191
| `template` | `string` | `null` | _Optional:_ Customize MDX content with a desired template. |
192+
| `infoTemplate` | `string` | `null` | _Optional:_ Customize MDX content for **info** pages only. |
193+
| `tagTemplate` | `string` | `null` | _Optional:_ Customize MDX content for **tag** pages only. |
194+
| `schemaTemplate` | `string` | `null` | _Optional:_ Customize MDX content for **schema** pages only. |
192195
| `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading OpenAPI specification. (requires `info` section/doc) |
193-
| `hideSendButton` | `boolean` | `null` | _Optional:_ If set to `true`, hides the "Send API Request" button in API demo panel |
194-
| `showExtensions` | `boolean` | `null` | _Optional:_ If set to `true`, renders operation-level vendor-extensions in description. |
196+
| `hideSendButton` | `boolean` | `null` | _Optional:_ If set to `true`, hides the “Send API Request” button in the API demo panel. |
197+
| `showExtensions` | `boolean` | `null` | _Optional:_ If set to `true`, renders operation‑level vendor‑extensions in descriptions. |
195198
| `sidebarOptions` | `object` | `null` | _Optional:_ Set of options for sidebar configuration. See below for a list of supported options. |
196-
| `version` | `string` | `null` | _Optional:_ Version assigned to single or micro-spec API specified in `specPath`. |
197-
| `label` | `string` | `null` | _Optional:_ Version label used when generating version selector dropdown menu. |
198-
| `baseUrl` | `string` | `null` | _Optional:_ Version base URL used when generating version selector dropdown menu. |
199-
| `versions` | `object` | `null` | _Optional:_ Set of options for versioning configuration. See below for a list of supported options. |
200-
| `markdownGenerators` | `object` | `null` | _Optional:_ Customize MDX content with a set of options for specifying markdown generator functions. See [markdownGenerators](#markdowngenerators) for a list of supported options. |
201-
| `showSchemas` | `boolean` | `null` | _Optional:_ If set to `true`, generates schema pages and adds them to the sidebar. |
199+
| `version` | `string` | `null` | _Optional:_ Version assigned to a single or micro‑spec API specified in `specPath`. |
200+
| `label` | `string` | `null` | _Optional:_ Version label used when generating the version‑selector dropdown menu. |
201+
| `baseUrl` | `string` | `null` | _Optional:_ Base URL for versioned docs in the version‑selector dropdown. |
202+
| `versions` | `object` | `null` | _Optional:_ Options for versioning configuration. See below for a list of supported options. |
203+
| `markdownGenerators` | `object` | `null` | _Optional:_ Customize MDX content via generator functions. See below for a list of supported options. |
204+
| `showSchemas` | `boolean` | `null` | _Optional:_ If set to `true`, generates standalone schema pages and adds them to the sidebar. |
202205

203206
### sidebarOptions
204207

‎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.3.7",
3+
"version": "4.4.0",
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",
@@ -26,8 +26,8 @@
2626
"@docusaurus/plugin-google-gtag": "3.7.0",
2727
"@docusaurus/preset-classic": "3.7.0",
2828
"clsx": "^1.1.1",
29-
"docusaurus-plugin-openapi-docs": "^4.3.7",
30-
"docusaurus-theme-openapi-docs": "^4.3.7",
29+
"docusaurus-plugin-openapi-docs": "^4.4.0",
30+
"docusaurus-theme-openapi-docs": "^4.4.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.3.7",
2+
"version": "4.4.0",
33
"npmClient": "yarn"
44
}

0 commit comments

Comments
 (0)