Prepare release v0.3.0 (#98)

cloud-annotations · Dec 16, 2021 · 378bcd7 · 378bcd7
1 parent 88efcf6
commit 378bcd7
Show file tree

Hide file tree

Showing 7 changed files with 78 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,70 @@
+## 0.3.0 (Dec 16, 2021)
+
+High level enhancements
+
+- Docusaurus beta.13 support (Thanks @Josh-Cena!)
+
+  ```js
+  // Be sure to update @docusaurus/core:
+  "dependencies": {
+    "@docusaurus/core": "2.0.0-beta.13",
+    // ...
+  }
+  ```
+
+- The OpenAPI `info` stanza will now generate an "Introduction" page
+
+  ```yaml
+  openapi: 3.0.3
+  info:
+    title: Swagger Petstore
+    version: 1.0.0
+    description: |
+      This is a sample server Petstore server.
+      You can find out more about Swagger at
+      [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).
+      For this sample, you can use the api key `special-key` to test the authorization filters.
+  ```
+
+- Request bodies will now render JSON Schema with the use of `allOf` keywords
+
+  ```yaml
+  requestBody:
+    content:
+      description: Example request
+      application/json:
+        schema:
+          allOf:
+            - $ref: "#/components/schema/Example1"
+            - $ref: "#/components/schema/Example2"
+  ```
+
+- Enum options will now be displayed in schema tables
+  <table>
+  <tbody>
+  <tr>
+  <td>
+
+  `status` string
+
+  Enum: `"available"`, `"pending"`, `"sold"`
+
+  Pet status in the store
+
+  </td>
+  </tr>
+  </tbody>
+  </table>
+
+Other enhancements and bug fixes
+
+- Initial proxy code ([#97](https://github.com/cloud-annotations/docusaurus-plugin-openapi/pull/97))
+- Add support for an introduction page ([#94](https://github.com/cloud-annotations/docusaurus-plugin-openapi/pull/94))
+- Add `allOf` JSON schema support ([#96](https://github.com/cloud-annotations/docusaurus-plugin-openapi/pull/96))
+- Display enum values in tables ([#93](https://github.com/cloud-annotations/docusaurus-plugin-openapi/pull/93))
+- Initial plugin refactor ([#86](https://github.com/cloud-annotations/docusaurus-plugin-openapi/pull/86))
+- Upgrade to Docusaurus beta.13 ([#88](https://github.com/cloud-annotations/docusaurus-plugin-openapi/pull/88))
+
 ## 0.2.3 (Dec 11, 2021)
 
 Enhancements and bug fixes

diff --git a/demo/package.json b/demo/package.json
@@ -1,6 +1,6 @@
 {
   "name": "demo",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -18,7 +18,7 @@
     "@mdx-js/react": "^1.6.21",
     "@svgr/webpack": "^5.5.0",
     "clsx": "^1.1.1",
-    "docusaurus-preset-openapi": "^0.2.3",
+    "docusaurus-preset-openapi": "^0.3.0",
     "file-loader": "^6.2.0",
     "prism-react-renderer": "^1.2.1",
     "react": "^17.0.1",

diff --git a/lerna.json b/lerna.json
@@ -1,5 +1,5 @@
 {
-  "version": "0.2.3",
+  "version": "0.3.0",
   "npmClient": "yarn",
   "useWorkspaces": true
 }
diff --git a/packages/docusaurus-plugin-openapi/package.json b/packages/docusaurus-plugin-openapi/package.json
@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public"

diff --git a/packages/docusaurus-plugin-proxy/package.json b/packages/docusaurus-plugin-proxy/package.json
@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-proxy",
   "description": "A dev server proxy for Docusaurus.",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public"

diff --git a/packages/docusaurus-preset-openapi/package.json b/packages/docusaurus-preset-openapi/package.json
@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-preset-openapi",
   "description": "OpenAPI preset for Docusaurus.",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -41,9 +41,9 @@
     "@docusaurus/preset-classic": "2.0.0-beta.13",
     "@docusaurus/theme-classic": "2.0.0-beta.13",
     "@docusaurus/theme-search-algolia": "2.0.0-beta.13",
-    "docusaurus-plugin-openapi": "^0.2.3",
-    "docusaurus-plugin-proxy": "^0.2.3",
-    "docusaurus-theme-openapi": "^0.2.3"
+    "docusaurus-plugin-openapi": "^0.3.0",
+    "docusaurus-plugin-proxy": "^0.3.0",
+    "docusaurus-theme-openapi": "^0.3.0"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",

diff --git a/packages/docusaurus-theme-openapi/package.json b/packages/docusaurus-theme-openapi/package.json
@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -37,7 +37,7 @@
     "@monaco-editor/react": "^4.3.1",
     "buffer": "^6.0.3",
     "clsx": "^1.1.1",
-    "docusaurus-plugin-openapi": "^0.2.3",
+    "docusaurus-plugin-openapi": "^0.3.0",
     "immer": "^9.0.6",
     "lodash": "^4.17.20",
     "postman-code-generators": "^1.0.0",