Test upgrading @docusaurus/core and docusaurus-openapi-docs to v3

.gitignore

@@ -24,4 +24,5 @@ products/**/*.api.mdx
 products/**/*.info.mdx
 products/**/*.tag.mdx
 products/**/sidebar.js
+products/**/sidebar.ts
 products/**/versions.json

docusaurus.config.js → docusaurus.config.ts

@@ -1,10 +1,12 @@
+import Mermaid from "@theme/Mermaid";
+
 /**
  * Copyright (c) 2017-present, Facebook, Inc.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
+let baseUrl
 if (process.env.CI_MERGE_REQUEST_IID) {
   if (process.env.CI_PROJECT_DIR == "dev") {
     baseUrl = "/";
@@ -18,6 +20,9 @@ if (process.env.CI_MERGE_REQUEST_IID) {
 }
 
 const config = {
+  future: {
+    experimental_faster: (process.env.DOCUSAURUS_FASTER ?? "true") === "true",
+  },
   title: "Develop with Palo Alto Networks",
   tagline:
     "Explore our API Doc, Quickstarts, and Blog or dive right in and play in our sandbox. We have all the tools you needs to make the next big security innovation. SDKs in your favorite languages, detailed walk-throughs for sample apps, and all the resources you’ll need to flourish.",
@@ -28,16 +33,16 @@ const config = {
   favicon: "img/PANW_Parent_Glyph_Red.svg",
   organizationName: "PaloAltoNetworks",
   projectName: "pan.dev",
-  markdown: { format: "detect" },
+  markdown: { format: "detect", mermaid: true },
   themeConfig: {
     prism: {
-      additionalLanguages: ["csharp", "php", "hcl"],
+      additionalLanguages: ["csharp", "php", "hcl", "json", "bash"],
     },
     languageTabs: [
       {
         highlight: "bash",
         language: "curl",
-        logoClass: "bash",
+        logoClass: "curl",
       },
       {
         highlight: "python",
@@ -603,9 +608,6 @@ const config = {
       copyright: `Copyright © ${new Date().getFullYear()} Palo Alto Networks, Inc.`,
     },
   },
-  markdown: {
-    mermaid: true,
-  },
   themes: ["docusaurus-theme-openapi-docs", "@docusaurus/theme-mermaid"],
   presets: [
     [
@@ -872,7 +874,7 @@ const config = {
         id: "default",
         routeBasePath: "/",
         path: "products",
-        sidebarPath: "./sidebars.js",
+        sidebarPath: "./sidebars.ts",
         editUrl: "https://github.com/PaloAltoNetworks/pan.dev/tree/master",
         include: ["**/*.{md,mdx}"],
         docItemComponent: "@theme/ApiItem",
@@ -896,28 +898,6 @@ const config = {
   onBrokenLinks: "warn",
   onBrokenMarkdownLinks: "warn",
   trailingSlash: true,
-  webpack: {
-    jsLoader: (isServer) => ({
-      loader: require.resolve("swc-loader"),
-      options: {
-        jsc: {
-          parser: {
-            syntax: "typescript",
-            tsx: true,
-          },
-          target: "es2019",
-          transform: {
-            react: {
-              runtime: "automatic",
-            },
-          },
-        },
-        module: {
-          type: isServer ? "commonjs" : "es6",
-        },
-      },
-    }),
-  },
   customFields: {
     firebaseApiKey: process.env.REACT_APP_FIREBASE_APIKEY,
     recaptchaApiKey: process.env.REACT_APP_RECAPTCHA_APIKEY,
@@ -929,7 +909,7 @@ const config = {
 Takes in list of products to filter based on directory, outputs list of globby include for the doc plugin
 */
 function docsPluginInclude(filters) {
-  include = [];
+  let include = [] as any;
   filters.forEach((product) => {
     let product_include = product + "/**/*.{md,mdx}";
     include.push(product_include);
@@ -941,7 +921,7 @@ async function createConfig() {
   let filters =
     process.env.PRODUCTS_INCLUDE && process.env.PRODUCTS_INCLUDE.split(",");
   if (filters) {
-    config.plugins[4][1].include = docsPluginInclude(filters);
+    config.plugins[4][1]["include"] = docsPluginInclude(filters);
   }
   return config;
 }

openapi-specs/cspm/CDEMMicroServices.json

@@ -1067,95 +1067,6 @@
         ]
       }
     },
-    "/asm/api/v1/asset/{asset_id}": {
-      "get": {
-        "tags": [
-          "Discovery and Exposure Management"
-        ],
-        "summary": "Get Asset Details by ID",
-        "description": "Get asset overview or details by asset id.",
-        "operationId": "get-asset-details",
-        "parameters": [
-          {
-            "name": "asset_id",
-            "in": "path",
-            "description": "Asset ID",
-            "required": true,
-            "schema": {
-              "type": "string",
-              "format": "uuid"
-            }
-          },
-          {
-            "name": "snapshot_date",
-            "in": "query",
-            "description": "Snapshot date",
-            "required": true,
-            "schema": {
-              "type": "integer",
-              "format": "int64"
-            }
-          },
-          {
-            "name": "asset_type",
-            "in": "query",
-            "description": "Asset type",
-            "required": false,
-            "schema": {
-              "type": "string"
-            }
-          },
-          {
-            "name": "manage_type",
-            "in": "query",
-            "description": "Manage type",
-            "required": false,
-            "schema": {
-              "type": "string",
-              "default": "UNMANAGED"
-            }
-          },
-          {
-            "name": "all_asset_details",
-            "in": "query",
-            "description": "Set it true to fetch all asset details.",
-            "required": false,
-            "schema": {
-              "type": "boolean",
-              "default": false
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "Ok",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "string"
-                }
-              }
-            }
-          },
-          "404": {
-            "description": "Data not found",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ErrorResponse"
-                }
-              }
-            }
-          }
-        },
-        "x-public": "true",
-        "security": [
-          {
-            "x-redlock-auth": []
-          }
-        ]
-      }
-    },
     "/asm/api/v1/asset/{asset_id}/vulnerability": {
       "get": {
         "tags": [

package.json

@@ -43,24 +43,25 @@
   },
   "dependencies": {
     "@docsearch/react": "^3.3.0",
-    "@docusaurus/core": "2.4.3",
-    "@docusaurus/plugin-client-redirects": "2.4.3",
-    "@docusaurus/preset-classic": "2.4.3",
-    "@docusaurus/theme-classic": "2.4.3",
-    "@docusaurus/theme-mermaid": "2.4.3",
+    "@docusaurus/core": "3.6.1",
+    "@docusaurus/faster": "3.6.1",
+    "@docusaurus/plugin-client-redirects": "3.6.1",
+    "@docusaurus/preset-classic": "3.6.1",
+    "@docusaurus/theme-classic": "3.6.1",
+    "@docusaurus/theme-mermaid": "3.6.1",
     "algoliasearch": "^4.14.2",
     "clsx": "^1.2.1",
-    "docusaurus-plugin-openapi-docs": "2.2.3",
+    "docusaurus-plugin-openapi-docs": "0.0.0-949",
     "docusaurus-plugin-sass": "^0.2.2",
-    "docusaurus-theme-openapi-docs": "2.2.3",
+    "docusaurus-theme-openapi-docs": "0.0.0-949",
     "fast-xml-parser": "^4.0.10",
-    "firebase": "^9.14.0",
+    "firebase": "^10.12.0",
     "plugin-sitemap-coveo": "./plugin-sitemap-coveo",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "react-responsive": "^9.0.0",
-    "react-slick": "^0.29.0",
-    "sass": "^1.54.1",
+    "react-responsive": "^10.0.0",
+    "react-slick": "^0.30.2",
+    "sass": "^1.77.8",
     "slick-carousel": "^1.8.1",
     "stackdriver-errors-js": "^0.12.0"
   },
@@ -77,13 +78,11 @@
     ]
   },
   "devDependencies": {
-    "@swc/core": "^1.7.14",
     "cross-env": "^7.0.3",
     "husky": "^8.0.2",
     "lint-staged": "^13.0.3",
     "prettier": "2.7.1",
     "rimraf": "^3.0.2",
-    "run-script-os": "^1.1.6",
-    "swc-loader": "^0.2.6"
+    "run-script-os": "^1.1.6"
   }
 }

products/expedition/docs/creating_credentials.mdx

@@ -23,28 +23,6 @@ image: /expedition/img/expedition.png
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 import Link from "@docusaurus/Link";
-export function SetLanguage(lang) {
-  if (typeof window !== "undefined") {
-    localStorage.setItem("defaultLanguage", lang);
-    window.location.reload();
-  }
-}
-
-**Choose language for code snippet**
-
-<a className="button button--primary" onClick={() => SetLanguage("python")}>
-  Python
-</a>
-&nbsp;
-<a className="button button--info" onClick={() => SetLanguage("php")}>
-  Php
-</a>
-&nbsp;
-<a className="button button--danger" onClick={() => SetLanguage("go")}>
-  Go
-</a>
-<br />
-<br />
 
 In this section we present a workflow example to migrate a third party vendor configuration into a PANOS configuration.
 
@@ -74,9 +52,10 @@ API syntax for generate API key:
 
 | Method | EndPoint                                                   | Parameters                        | Example Value                                                      |
 | ------ | ---------------------------------------------------------- | --------------------------------- | ------------------------------------------------------------------ |
-| POST   | <small>`https://localhost/api/v1/generate_api_key`</small> | <small>username, password</small> | <small>{**"username"**:"admin", **"password"**:"paloalto"}</small> |
+| POST   | <small>`https://localhost/api/v1/generate_api_key`</small> | <small>username, password</small> | <small>\{**"username"**:"admin", **"password"**:"paloalto"}</small> |
 
-<Tabs defaultValue={typeof window !== 'undefined' && localStorage.getItem('defaultLanguage') ? localStorage.getItem('defaultLanguage') : 'python'}
+<Tabs 
+groupId="expedition-language"
 values={[
 { label: 'Python', value: 'python', },
 { label: 'Php', value: 'php', },

products/expedition/docs/managing_expedition_agent.mdx

@@ -23,28 +23,7 @@ image: /expedition/img/expedition.png
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 import Link from "@docusaurus/Link";
-export function SetLanguage(lang) {
-  if (typeof window !== "undefined") {
-    localStorage.setItem("defaultLanguage", lang);
-    window.location.reload();
-  }
-}
-
-**Choose language for code snippet**
-
-<a className="button button--primary" onClick={() => SetLanguage("python")}>
-  Python
-</a>
-&nbsp;
-<a className="button button--info" onClick={() => SetLanguage("php")}>
-  Php
-</a>
-&nbsp;
-<a className="button button--danger" onClick={() => SetLanguage("go")}>
-  Go
-</a>
-<br />
-<br />
+
 
 In this section we describe the Expedition's agent and the calls that we can execute to change its status.
 
@@ -59,7 +38,7 @@ The calls comply with the following structure:
 
 | Method  | EndPoint                                                 | Parameters                                           |
 | ------- | -------------------------------------------------------- | ---------------------------------------------------- |
-| GET     | <small>`https://localhost/api/v1/agent/<action>`</small> | <small>action : { start \| stop \| restart }</small> |
+| GET     | <small>`https://localhost/api/v1/agent/<action>`</small> | <small>action : \{ start \| stop \| restart }</small> |
 | Example | <small>`https://localhost/api/v1/agent/restart`</small>  | <small></small>                                      |
 
 ### Starting the Agent
@@ -68,7 +47,8 @@ Starting the agent would require having an authenticated session. If stopped, th
 In the provided code, SSL certificate verification is bypassed, so it would run with the defaults Expedition installation in case no SSL certificates have been generated
 to certify the HTTPS service.
 
-<Tabs defaultValue={typeof window !== 'undefined' && localStorage.getItem('defaultLanguage') ? localStorage.getItem('defaultLanguage') : 'python'}
+<Tabs
+groupId="expedition-language"
 values={[
 { label: 'Python', value: 'python', },
 { label: 'Php', value: 'php', },
@@ -122,7 +102,8 @@ curl_close($curl);
 Likewise, stopping the agent is simply done with a validated HTTPS GET request to the `stop` route.
 Currently, there is no validation on the tasks that an agent may be executing during the stop action, so keep in mind that undergoing execution may become incomplete.
 
-<Tabs defaultValue={typeof window !== 'undefined' && localStorage.getItem('defaultLanguage') ? localStorage.getItem('defaultLanguage') : 'python'}
+<Tabs
+groupId="expedition-language"
 values={[
 { label: 'Python', value: 'python', },
 { label: 'Php', value: 'php', },
@@ -175,7 +156,8 @@ curl_close($curl);
 And to restart, we will require the `restart` route. If the agent is started, `restart` will stop the agent and start it again. If already stopped, the agent will get started.
 Currently, there is no validation on the tasks that an agent may be executing during the restart action, so keep in mind that undergoing execution may become incomplete.
 
-<Tabs defaultValue={typeof window !== 'undefined' && localStorage.getItem('defaultLanguage') ? localStorage.getItem('defaultLanguage') : 'python'}
+<Tabs
+groupId="expedition-language"
 values={[
 { label: 'Python', value: 'python', },
 { label: 'Php', value: 'php', },