Skip to content

Commit 74c5c52

Browse files
authored
Prepare release v1.4.0 (#313)
* Update docs/README * Prepare release v1.4.0
1 parent 1803001 commit 74c5c52

File tree

8 files changed

+23
-7
lines changed

8 files changed

+23
-7
lines changed

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
## 1.4.0 (Oct 26, 2022)
2+
3+
High level enhancements
4+
5+
- Support for downloading OpenAPI specification file
6+
7+
Other enhancements and bug fixes
8+
9+
- [Bug] Wrap API docs in BrowserOnly ([#310](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/310))
10+
- Extend regex to ignore <= and >= ([#309](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/309))
11+
- [Enhancement] Introduce support for downloading OpenAPI spec ([#307](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/307))
12+
- Update package.json
13+
114
## 1.3.2 (Oct 19, 2022)
215

316
High level enhancements

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
133133
| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or directory of multiple OpenAPI specification files. |
134134
| `ouputDir` | `string` | `null` | Desired output path for generated MDX files. |
135135
| `template` | `string` | `null` | _Optional:_ Customize MDX content with a desired template. |
136+
| `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading OpenAPI specification. (requires `info` section/doc) |
136137
| `sidebarOptions` | `object` | `null` | _Optional:_ Set of options for sidebar configuration. See below for a list of supported options. |
137138
| `version` | `string` | `null` | _Optional:_ Version assigned to single or micro-spec API specified in `specPath`. |
138139
| `label` | `string` | `null` | _Optional:_ Version label used when generating version selector dropdown menu. |

demo/docs/intro.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,7 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
295295
| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or directory of multiple OpenAPI specification files. |
296296
| `ouputDir` | `string` | `null` | Desired output path for generated MDX files. |
297297
| `template` | `string` | `null` | _Optional:_ Customize MDX content with a desired template. |
298+
| `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading OpenAPI specification. (requires `info` section/doc) |
298299
| `sidebarOptions` | `object` | `null` | _Optional:_ Set of options for sidebar configuration. See below for a list of supported options. |
299300
| `version` | `string` | `null` | _Optional:_ Version assigned to single or micro-spec API specified in `specPath`. |
300301
| `label` | `string` | `null` | _Optional:_ Version label used when generating version selector dropdown menu. |

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": "1.3.2",
3+
"version": "1.4.0",
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",
@@ -27,8 +27,8 @@
2727
"@docusaurus/preset-classic": "^2.0.1",
2828
"@mdx-js/react": "^1.6.22",
2929
"clsx": "^1.1.1",
30-
"docusaurus-plugin-openapi-docs": "^1.3.2",
31-
"docusaurus-theme-openapi-docs": "^1.3.2",
30+
"docusaurus-plugin-openapi-docs": "^1.4.0",
31+
"docusaurus-theme-openapi-docs": "^1.4.0",
3232
"prism-react-renderer": "^1.3.1",
3333
"react": "^17.0.2",
3434
"react-dom": "^17.0.2"

lerna.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"version": "1.3.2",
2+
"version": "1.4.0",
33
"npmClient": "yarn",
44
"useWorkspaces": true
55
}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
122122
| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or directory of multiple OpenAPI specification files. |
123123
| `ouputDir` | `string` | `null` | Desired output path for generated MDX files. |
124124
| `template` | `string` | `null` | _Optional:_ Customize MDX content with a desired template. |
125+
| `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading OpenAPI specification. (requires `info` section/doc) |
125126
| `sidebarOptions` | `object` | `null` | _Optional:_ Set of options for sidebar configuration. See below for a list of supported options. |
126127
| `version` | `string` | `null` | _Optional:_ Version assigned to single or micro-spec API specified in `specPath`. |
127128
| `label` | `string` | `null` | _Optional:_ Version label used when generating version selector dropdown menu. |

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": "1.3.2",
4+
"version": "1.4.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": "1.3.2",
4+
"version": "1.4.0",
55
"license": "MIT",
66
"keywords": [
77
"openapi",
@@ -51,7 +51,7 @@
5151
"buffer": "^6.0.3",
5252
"clsx": "^1.1.1",
5353
"crypto-js": "^4.1.1",
54-
"docusaurus-plugin-openapi-docs": "^1.3.2",
54+
"docusaurus-plugin-openapi-docs": "^1.4.0",
5555
"file-saver": "^2.0.5",
5656
"immer": "^9.0.7",
5757
"lodash": "^4.17.20",

0 commit comments

Comments
 (0)