[V3] OpenAPI 3.0 Preview

.github/workflows/canary-beta-release.yml

@@ -3,7 +3,7 @@ name: Canary Beta Release
 on:
   push:
     branches:
-      - v2.0.0
+      - v3.0.0
     paths:
       - packages/**
 
@@ -14,7 +14,7 @@ jobs:
   publish-canary:
     name: Publish Canary Beta
     runs-on: ubuntu-latest
-    if: ${{ github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' && github.ref == 'refs/heads/v2.0.0' && github.event_name == 'push' }}
+    if: ${{ github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' && github.ref == 'refs/heads/v3.0.0' && github.event_name == 'push' }}
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -30,7 +30,7 @@ jobs:
           git config --global user.name "Steven Serrata"
           git config --global user.email "sserrata@paloaltonetworks.com"
           git fetch
-          git checkout v2.0.0
+          git checkout v3.0.0
           echo "//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}" >> .npmrc
         env:
           NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

.github/workflows/codeql-analysis.yml

@@ -2,7 +2,7 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [main, v2.0.0]
+    branches: [main, v3.0.0]
 
 jobs:
   analyze:

.github/workflows/deploy-preview.yml

@@ -2,7 +2,7 @@ name: "Deploy Preview"
 
 on:
   pull_request_target:
-    branches: [main, v2.0.0]
+    branches: [main, v3.0.0]
 
 jobs:
   precheck:

.github/workflows/pr-title-check.yaml

@@ -4,7 +4,7 @@ on:
   pull_request:
     branches:
       - main
-      - v2.0.0
+      - v3.0.0
     types:
       - opened
       - synchronize

.github/workflows/release-beta.yaml

@@ -3,7 +3,7 @@ name: Release Beta
 on:
   push:
     branches:
-      - v2.0.0
+      - v3.0.0
 
 env:
   FORCE_COLOR: true

.github/workflows/validate.yaml

@@ -4,7 +4,7 @@ on:
   push:
     branches: [main]
   pull_request:
-    branches: [main, v2.0.0]
+    branches: [main, v3.0.0]
 
 env:
   FORCE_COLOR: true

.gitignore

@@ -137,6 +137,6 @@ dist
 demo/**/*.api.mdx
 demo/**/*.info.mdx
 demo/**/*.tag.mdx
-demo/**/sidebar.js
+demo/**/sidebar.ts
 demo/**/versions.json
 

.prettierrc.json

@@ -1 +1,3 @@
-{}
+{
+  "trailingComma": "es5"
+}

.vscode/settings.json

@@ -20,5 +20,10 @@
     "editor.codeActionsOnSave": {
       "source.fixAll.eslint": true
     }
+  },
+  "[javascript][typescript][typescriptreact]": {
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": "explicit"
+    }
   }
 }

CHANGELOG.md

@@ -1,3 +1,41 @@
+## 3.0.0-beta.3 (Dec 13, 2023)
+
+High level enhancements
+
+- Improve Docusaurus 3 compatibility
+- Upgrade to Docusaurus 3.0.1
+
+Other enhancements and bug fixes
+
+- upgrade prettier
+- install prettier plugin ([#681](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/681))
+- [V3] Improved Docusaurus 3 compatibility ([#677](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/677))
+- Prepare release v3.0.0-beta.2 ([#668](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/668))
+- Port v2 changes/fixes into v3 ([#667](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/667))
+
+## 3.0.0-beta.2 (Dec 1, 2023)
+
+High level enhancements
+
+- Port recent v2 changes/fixes into v3 ([#667](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/667))
+
+## 3.0.0-beta.1 (Nov 17, 2023)
+
+High level enhancements
+
+- First beta release for v3.0.0
+
+Other enhancements and bug fixes
+
+- update v2.0.0 refs to v3.0.0
+- update createSchema snapshot
+- support v3.0.0 canary releases
+- bump version to 3.0.0-beta.0
+- re-enable all API docs
+- convert contact info to markdown, update lessThan regex and escape description
+- initial refactor
+- Update README.md
+
 ## 2.0.0 (Nov 13, 2023)
 
 High level enhancements

demo/docs/versioning.md → demo/docs/versioning.mdx

@@ -78,7 +78,7 @@ Import:
 
 ```javascript
 const {
-  versionSelector,
+  versionSelector
 } = require("docusaurus-plugin-openapi-docs/lib/sidebars/utils"); // imports utility
 const petstoreVersions = require("./docs/petstore/versions.json"); // imports Petstore versions.json
 ```
@@ -102,7 +102,7 @@ Import:
 
 ```javascript
 const {
-  versionCrumb,
+  versionCrumb
 } = require("docusaurus-plugin-openapi-docs/lib/sidebars/utils");
 ```