Skip to content

Commit 378bcd7

Browse files
authored
Prepare release v0.3.0 (#98)
1 parent 88efcf6 commit 378bcd7

File tree

7 files changed

+78
-11
lines changed

7 files changed

+78
-11
lines changed

CHANGELOG.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,70 @@
1+
## 0.3.0 (Dec 16, 2021)
2+
3+
High level enhancements
4+
5+
- Docusaurus beta.13 support (Thanks @Josh-Cena!)
6+
7+
```js
8+
// Be sure to update @docusaurus/core:
9+
"dependencies": {
10+
"@docusaurus/core": "2.0.0-beta.13",
11+
// ...
12+
}
13+
```
14+
15+
- The OpenAPI `info` stanza will now generate an "Introduction" page
16+
17+
```yaml
18+
openapi: 3.0.3
19+
info:
20+
title: Swagger Petstore
21+
version: 1.0.0
22+
description: |
23+
This is a sample server Petstore server.
24+
You can find out more about Swagger at
25+
[http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).
26+
For this sample, you can use the api key `special-key` to test the authorization filters.
27+
```
28+
29+
- Request bodies will now render JSON Schema with the use of `allOf` keywords
30+
31+
```yaml
32+
requestBody:
33+
content:
34+
description: Example request
35+
application/json:
36+
schema:
37+
allOf:
38+
- $ref: "#/components/schema/Example1"
39+
- $ref: "#/components/schema/Example2"
40+
```
41+
42+
- Enum options will now be displayed in schema tables
43+
<table>
44+
<tbody>
45+
<tr>
46+
<td>
47+
48+
`status` string
49+
50+
Enum: `"available"`, `"pending"`, `"sold"`
51+
52+
Pet status in the store
53+
54+
</td>
55+
</tr>
56+
</tbody>
57+
</table>
58+
59+
Other enhancements and bug fixes
60+
61+
- Initial proxy code ([#97](https://github.com/cloud-annotations/docusaurus-plugin-openapi/pull/97))
62+
- Add support for an introduction page ([#94](https://github.com/cloud-annotations/docusaurus-plugin-openapi/pull/94))
63+
- Add `allOf` JSON schema support ([#96](https://github.com/cloud-annotations/docusaurus-plugin-openapi/pull/96))
64+
- Display enum values in tables ([#93](https://github.com/cloud-annotations/docusaurus-plugin-openapi/pull/93))
65+
- Initial plugin refactor ([#86](https://github.com/cloud-annotations/docusaurus-plugin-openapi/pull/86))
66+
- Upgrade to Docusaurus beta.13 ([#88](https://github.com/cloud-annotations/docusaurus-plugin-openapi/pull/88))
67+
168
## 0.2.3 (Dec 11, 2021)
269

370
Enhancements and bug fixes

demo/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "demo",
3-
"version": "0.2.3",
3+
"version": "0.3.0",
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",
@@ -18,7 +18,7 @@
1818
"@mdx-js/react": "^1.6.21",
1919
"@svgr/webpack": "^5.5.0",
2020
"clsx": "^1.1.1",
21-
"docusaurus-preset-openapi": "^0.2.3",
21+
"docusaurus-preset-openapi": "^0.3.0",
2222
"file-loader": "^6.2.0",
2323
"prism-react-renderer": "^1.2.1",
2424
"react": "^17.0.1",

lerna.json

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

packages/docusaurus-plugin-openapi/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",
33
"description": "OpenAPI plugin for Docusaurus.",
4-
"version": "0.2.3",
4+
"version": "0.3.0",
55
"license": "MIT",
66
"publishConfig": {
77
"access": "public"

packages/docusaurus-plugin-proxy/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-proxy",
33
"description": "A dev server proxy for Docusaurus.",
4-
"version": "0.2.3",
4+
"version": "0.3.0",
55
"license": "MIT",
66
"publishConfig": {
77
"access": "public"

packages/docusaurus-preset-openapi/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "docusaurus-preset-openapi",
33
"description": "OpenAPI preset for Docusaurus.",
4-
"version": "0.2.3",
4+
"version": "0.3.0",
55
"license": "MIT",
66
"keywords": [
77
"openapi",
@@ -41,9 +41,9 @@
4141
"@docusaurus/preset-classic": "2.0.0-beta.13",
4242
"@docusaurus/theme-classic": "2.0.0-beta.13",
4343
"@docusaurus/theme-search-algolia": "2.0.0-beta.13",
44-
"docusaurus-plugin-openapi": "^0.2.3",
45-
"docusaurus-plugin-proxy": "^0.2.3",
46-
"docusaurus-theme-openapi": "^0.2.3"
44+
"docusaurus-plugin-openapi": "^0.3.0",
45+
"docusaurus-plugin-proxy": "^0.3.0",
46+
"docusaurus-theme-openapi": "^0.3.0"
4747
},
4848
"peerDependencies": {
4949
"react": "^16.8.4 || ^17.0.0",

packages/docusaurus-theme-openapi/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",
33
"description": "OpenAPI theme for Docusaurus.",
4-
"version": "0.2.3",
4+
"version": "0.3.0",
55
"license": "MIT",
66
"publishConfig": {
77
"access": "public"
@@ -37,7 +37,7 @@
3737
"@monaco-editor/react": "^4.3.1",
3838
"buffer": "^6.0.3",
3939
"clsx": "^1.1.1",
40-
"docusaurus-plugin-openapi": "^0.2.3",
40+
"docusaurus-plugin-openapi": "^0.3.0",
4141
"immer": "^9.0.6",
4242
"lodash": "^4.17.20",
4343
"postman-code-generators": "^1.0.0",

0 commit comments

Comments
 (0)