docusaurus-theme-openapi-docs 4.1.0 → 4.2.0

package/lib/theme/ApiExplorer/CodeSnippets/index.js

@@ -224,7 +224,7 @@ function CodeSnippets({ postman, codeSamples }) {
   ]);
   // no dependencies was intentionlly set for this particular hook. it's safe as long as if conditions are set
   (0, react_1.useEffect)(function onSelectedVariantUpdate() {
-    if (selectedVariant && selectedVariant !== language.variant) {
+    if (selectedVariant && selectedVariant !== language?.variant) {
       const postmanRequest = (0, buildPostmanRequest_1.default)(postman, {
         queryParams,
         pathParams,
@@ -254,6 +254,7 @@ function CodeSnippets({ postman, codeSamples }) {
   // eslint-disable-next-line react-hooks/exhaustive-deps
   (0, react_1.useEffect)(function onSelectedSampleUpdate() {
     if (
+      language &&
       language.samples &&
       language.samplesSources &&
       selectedSample &&

package/lib/theme/ApiExplorer/CodeTabs/_CodeTabs.scss

@@ -436,6 +436,56 @@ body[class="ReactModal__Body--open"] {
   }
 }
 
+.openapi-tabs__code-item--http {
+  color: var(--ifm-color-gray-500);
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  position: relative;
+
+  &::after {
+    content: "";
+    display: inline-block;
+    width: 32px; /* Explicitly setting width to 32 pixels */
+    height: 32px; /* Explicitly setting height to 32 pixels */
+    background-image: url("data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMzIiIGhlaWdodD0iMzIiIHZpZXdCb3g9IjAgMCAzMiAzMiIgZmlsbD0ibm9uZSIgc3Ryb2tlPSJjdXJyZW50Q29sb3IiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+PHBhdGggZD0iTTEyIDIyTDggMTZMMTIgMTBNMjAgMjJMMjQgMTZMIDIwIDEwIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiLz48L3N2Zz4=");
+    background-size: contain;
+    background-repeat: no-repeat;
+    background-position: center; /* Center the SVG */
+    margin-top: 0.5rem;
+  }
+
+  &.active {
+    box-shadow: 0 0 0 3px var(--opeanpi-code-tab-shadow-color-http);
+    border-color: var(--openapi-code-tab-border-color-http);
+  }
+}
+
+.openapi-tabs__code-item--shell {
+  color: var(--ifm-color-gray-500);
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  position: relative;
+
+  &::after {
+    content: "";
+    display: inline-block;
+    width: 32px; /* Explicitly setting width to 32 pixels */
+    height: 32px; /* Explicitly setting height to 32 pixels */
+    background-image: url("data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMzIiIGhlaWdodD0iMzIiIHZpZXdCb3g9IjAgMCAzMiAzMiIgZmlsbD0ibm9uZSIgc3Ryb2tlPSJjdXJyZW50Q29sb3IiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+PHBhdGggZD0iTTEyIDIyTDggMTZMMTIgMTBNMjAgMjJMMjQgMTZMIDIwIDEwIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiLz48L3N2Zz4=");
+    background-size: contain;
+    background-repeat: no-repeat;
+    background-position: center; /* Center the SVG */
+    margin-top: 0.5rem;
+  }
+
+  &.active {
+    box-shadow: 0 0 0 3px var(--opeanpi-code-tab-shadow-color-shell);
+    border-color: var(--openapi-code-tab-border-color-shell);
+  }
+}
+
 @media only screen and (min-width: 768px) and (max-width: 996px) {
   .openapi-tabs__code-list {
     justify-content: space-around;

package/lib/theme/ApiItem/Layout/index.js

@@ -53,6 +53,7 @@ function DocItemLayout({ children }) {
   const { metadata } = (0, client_1.useDoc)();
   const { frontMatter } = (0, client_1.useDoc)();
   const api = frontMatter.api;
+  const schema = frontMatter.schema;
   return react_1.default.createElement(
     "div",
     { className: "row" },
@@ -86,7 +87,7 @@ function DocItemLayout({ children }) {
               {
                 className: (0, clsx_1.default)(
                   "col",
-                  api ? "col--7" : "col--12"
+                  api || schema ? "col--7" : "col--12"
                 ),
               },
               react_1.default.createElement(Footer_1.default, null)
@@ -99,7 +100,10 @@ function DocItemLayout({ children }) {
           react_1.default.createElement(
             "div",
             {
-              className: (0, clsx_1.default)("col", api ? "col--7" : "col--12"),
+              className: (0, clsx_1.default)(
+                "col",
+                api || schema ? "col--7" : "col--12"
+              ),
             },
             react_1.default.createElement(Paginator_1.default, null)
           )

package/lib/theme/ApiItem/index.js

@@ -26,7 +26,9 @@ const useIsBrowser_1 = __importDefault(require("@docusaurus/useIsBrowser"));
 const slice_1 = require("@theme/ApiExplorer/Authorization/slice");
 const persistanceMiddleware_1 = require("@theme/ApiExplorer/persistanceMiddleware");
 const Layout_1 = __importDefault(require("@theme/ApiItem/Layout"));
+const CodeBlock_1 = __importDefault(require("@theme/CodeBlock"));
 const Metadata_1 = __importDefault(require("@theme/DocItem/Metadata"));
+const SkeletonLoader_1 = __importDefault(require("@theme/SkeletonLoader"));
 const clsx_1 = __importDefault(require("clsx"));
 const react_redux_1 = require("react-redux");
 const store_1 = require("./store");
@@ -42,6 +44,7 @@ function ApiItem(props) {
   const { info_path: infoPath } = frontMatter;
   let { api } = frontMatter;
   const { schema } = frontMatter;
+  const { sample } = frontMatter;
   // decompress and parse
   if (api) {
     try {
@@ -149,9 +152,8 @@ function ApiItem(props) {
                   BrowserOnly_1.default,
                   {
                     fallback: react_1.default.createElement(
-                      "div",
-                      null,
-                      "Loading..."
+                      SkeletonLoader_1.default,
+                      { size: "lg" }
                     ),
                   },
                   () => {
@@ -183,8 +185,17 @@ function ApiItem(props) {
             { className: (0, clsx_1.default)("row", "theme-api-markdown") },
             react_1.default.createElement(
               "div",
-              { className: "col col--12" },
+              { className: "col col--7 openapi-left-panel__container schema" },
               react_1.default.createElement(MDXComponent, null)
+            ),
+            react_1.default.createElement(
+              "div",
+              { className: "col col--5 openapi-right-panel__container" },
+              react_1.default.createElement(
+                CodeBlock_1.default,
+                { language: "json", title: `${frontMatter.title}` },
+                JSON.stringify(sample, null, 2)
+              )
             )
           )
         )

package/lib/theme/ApiTabs/_ApiTabs.scss

@@ -6,7 +6,6 @@
  * ========================================================================== */
 .openapi-tabs__container {
   margin-left: -1px;
-  margin-bottom: var(--ifm-leading);
 }
 
 .openapi-tabs__response-header {

package/lib/theme/ArrayBrackets/index.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+export declare const OpeningArrayBracket: () => React.JSX.Element;
+export declare const ClosingArrayBracket: () => React.JSX.Element;

package/lib/theme/ArrayBrackets/index.js

@@ -0,0 +1,50 @@
+"use strict";
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClosingArrayBracket = exports.OpeningArrayBracket = void 0;
+const react_1 = __importDefault(require("react"));
+const OpeningArrayBracket = () =>
+  react_1.default.createElement(
+    "li",
+    null,
+    react_1.default.createElement(
+      "div",
+      {
+        style: {
+          fontSize: "var(--ifm-code-font-size)",
+          opacity: 0.6,
+          marginLeft: "-.5rem",
+          paddingBottom: ".5rem",
+        },
+      },
+      "Array ["
+    )
+  );
+exports.OpeningArrayBracket = OpeningArrayBracket;
+const ClosingArrayBracket = () =>
+  react_1.default.createElement(
+    "li",
+    null,
+    react_1.default.createElement(
+      "div",
+      {
+        style: {
+          fontSize: "var(--ifm-code-font-size)",
+          opacity: 0.6,
+          marginLeft: "-.5rem",
+        },
+      },
+      "]"
+    )
+  );
+exports.ClosingArrayBracket = ClosingArrayBracket;

package/lib/theme/ParamsDetails/index.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+interface Props {
+    parameters: any[];
+}
+declare const ParamsDetails: React.FC<Props>;
+export default ParamsDetails;

package/lib/theme/ParamsDetails/index.js

@@ -0,0 +1,134 @@
+"use strict";
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (
+          !desc ||
+          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
+        ) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __setModuleDefault =
+  (this && this.__setModuleDefault) ||
+  (Object.create
+    ? function (o, v) {
+        Object.defineProperty(o, "default", { enumerable: true, value: v });
+      }
+    : function (o, v) {
+        o["default"] = v;
+      });
+var __importStar =
+  (this && this.__importStar) ||
+  function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null)
+      for (var k in mod)
+        if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
+          __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+  };
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importStar(require("react"));
+const BrowserOnly_1 = __importDefault(require("@docusaurus/BrowserOnly"));
+const Details_1 = __importDefault(require("@theme/Details"));
+const ParamsItem_1 = __importDefault(require("@theme/ParamsItem"));
+const SkeletonLoader_1 = __importDefault(require("@theme/SkeletonLoader"));
+const ParamsDetailsComponent = ({ parameters }) => {
+  const types = ["path", "query", "header", "cookie"];
+  return react_1.default.createElement(
+    react_1.default.Fragment,
+    null,
+    types.map((type) => {
+      const params = parameters?.filter((param) => param?.in === type);
+      if (!params || params.length === 0) {
+        return null;
+      }
+      const summaryElement = react_1.default.createElement(
+        "summary",
+        null,
+        react_1.default.createElement(
+          "h3",
+          { className: "openapi-markdown__details-summary-header-params" },
+          `${type.charAt(0).toUpperCase() + type.slice(1)} Parameters`
+        )
+      );
+      return react_1.default.createElement(
+        Details_1.default,
+        {
+          key: type,
+          className: "openapi-markdown__details",
+          style: { marginBottom: "1rem" },
+          "data-collapsed": false,
+          open: true,
+          summary: summaryElement,
+        },
+        react_1.default.createElement(
+          "ul",
+          null,
+          params.map((param, index) =>
+            react_1.default.createElement(ParamsItem_1.default, {
+              key: index,
+              className: "paramsItem",
+              param: {
+                ...param,
+                enumDescriptions: Object.entries(
+                  param?.schema?.["x-enumDescriptions"] ??
+                    param?.schema?.items?.["x-enumDescriptions"] ??
+                    {}
+                ),
+              },
+            })
+          )
+        )
+      );
+    })
+  );
+};
+const ParamsDetails = (props) => {
+  return react_1.default.createElement(
+    BrowserOnly_1.default,
+    {
+      fallback: react_1.default.createElement(SkeletonLoader_1.default, {
+        size: "sm",
+      }),
+    },
+    () => {
+      const LazyComponent = react_1.default.lazy(() =>
+        Promise.resolve({ default: ParamsDetailsComponent })
+      );
+      return react_1.default.createElement(
+        react_1.Suspense,
+        { fallback: null },
+        react_1.default.createElement(LazyComponent, { ...props })
+      );
+    }
+  );
+};
+exports.default = ParamsDetails;

package/lib/theme/ParamsItem/index.d.ts

@@ -9,6 +9,7 @@ export interface ExampleObject {
     externalValue?: string;
 }
 export interface Props {
+    className: string;
     param: {
         description: string;
         example: any;

package/lib/theme/ParamsItem/index.js

@@ -94,7 +94,7 @@ function ParamsItem({ param, ...rest }) {
   );
   const renderDescription = (0, utils_1.guard)(description, (description) =>
     react_1.default.createElement(
-      "div",
+      react_1.default.Fragment,
       null,
       react_1.default.createElement(react_markdown_1.default, {
         children: (0, createDescription_1.createDescription)(description),
@@ -124,11 +124,15 @@ function ParamsItem({ param, ...rest }) {
   const renderEnumDescriptions = (0, utils_1.guard)(
     getEnumDescriptionMarkdown(enumDescriptions),
     (value) => {
-      return react_1.default.createElement(react_markdown_1.default, {
-        rehypePlugins: [rehype_raw_1.default],
-        remarkPlugins: [remark_gfm_1.default],
-        children: value,
-      });
+      return react_1.default.createElement(
+        "div",
+        { style: { marginTop: ".5rem" } },
+        react_1.default.createElement(react_markdown_1.default, {
+          rehypePlugins: [rehype_raw_1.default],
+          remarkPlugins: [remark_gfm_1.default],
+          children: value,
+        })
+      );
     }
   );
   function renderDefaultValue() {

package/lib/theme/RequestSchema/index.d.ts

@@ -0,0 +1,15 @@
+import React from "react";
+import { MediaTypeObject } from "docusaurus-plugin-openapi-docs/lib/openapi/types";
+interface Props {
+    style?: React.CSSProperties;
+    title: string;
+    body: {
+        content?: {
+            [key: string]: MediaTypeObject;
+        };
+        description?: string;
+        required?: string[] | boolean;
+    };
+}
+declare const RequestSchema: React.FC<Props>;
+export default RequestSchema;

package/lib/theme/RequestSchema/index.js

@@ -0,0 +1,235 @@
+"use strict";
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (
+          !desc ||
+          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
+        ) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __setModuleDefault =
+  (this && this.__setModuleDefault) ||
+  (Object.create
+    ? function (o, v) {
+        Object.defineProperty(o, "default", { enumerable: true, value: v });
+      }
+    : function (o, v) {
+        o["default"] = v;
+      });
+var __importStar =
+  (this && this.__importStar) ||
+  function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null)
+      for (var k in mod)
+        if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
+          __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+  };
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importStar(require("react"));
+const BrowserOnly_1 = __importDefault(require("@docusaurus/BrowserOnly"));
+const Details_1 = __importDefault(require("@theme/Details"));
+const MimeTabs_1 = __importDefault(require("@theme/MimeTabs")); // Assume these components exist
+const Schema_1 = __importDefault(require("@theme/Schema"));
+const SkeletonLoader_1 = __importDefault(require("@theme/SkeletonLoader"));
+const TabItem_1 = __importDefault(require("@theme/TabItem"));
+const createDescription_1 = require("docusaurus-plugin-openapi-docs/lib/markdown/createDescription");
+const RequestSchemaComponent = ({ title, body, style }) => {
+  if (
+    body === undefined ||
+    body.content === undefined ||
+    Object.keys(body).length === 0 ||
+    Object.keys(body.content).length === 0
+  ) {
+    return null;
+  }
+  const mimeTypes = Object.keys(body.content);
+  if (mimeTypes.length > 1) {
+    return react_1.default.createElement(
+      MimeTabs_1.default,
+      { className: "openapi-tabs__mime", schemaType: "request" },
+      mimeTypes.map((mimeType) => {
+        const firstBody = body.content[mimeType].schema;
+        if (
+          firstBody === undefined ||
+          (firstBody.properties &&
+            Object.keys(firstBody.properties).length === 0)
+        ) {
+          return null;
+        }
+        return (
+          // @ts-ignore
+          react_1.default.createElement(
+            TabItem_1.default,
+            { key: mimeType, label: mimeType, value: mimeType },
+            react_1.default.createElement(
+              Details_1.default,
+              {
+                className: "openapi-markdown__details mime",
+                "data-collapsed": false,
+                open: true,
+                style: style,
+                summary: react_1.default.createElement(
+                  react_1.default.Fragment,
+                  null,
+                  react_1.default.createElement(
+                    "summary",
+                    null,
+                    react_1.default.createElement(
+                      "h3",
+                      {
+                        className:
+                          "openapi-markdown__details-summary-header-body",
+                      },
+                      title,
+                      body.required === true &&
+                        react_1.default.createElement(
+                          "span",
+                          { className: "openapi-schema__required" },
+                          "required"
+                        )
+                    )
+                  )
+                ),
+              },
+              react_1.default.createElement(
+                "div",
+                { style: { textAlign: "left", marginLeft: "1rem" } },
+                body.description &&
+                  react_1.default.createElement(
+                    "div",
+                    { style: { marginTop: "1rem", marginBottom: "1rem" } },
+                    (0, createDescription_1.createDescription)(body.description)
+                  )
+              ),
+              react_1.default.createElement(
+                "ul",
+                { style: { marginLeft: "1rem" } },
+                react_1.default.createElement(Schema_1.default, {
+                  schema: firstBody,
+                  schemaType: "request",
+                })
+              )
+            )
+          )
+        );
+      })
+    );
+  }
+  const randomFirstKey = mimeTypes[0];
+  const firstBody =
+    body.content[randomFirstKey].schema ?? body.content[randomFirstKey];
+  if (firstBody === undefined) {
+    return null;
+  }
+  return react_1.default.createElement(
+    MimeTabs_1.default,
+    { className: "openapi-tabs__mime", schemaType: "request" },
+    react_1.default.createElement(
+      TabItem_1.default,
+      { label: randomFirstKey, value: `${randomFirstKey}-schema` },
+      react_1.default.createElement(
+        Details_1.default,
+        {
+          className: "openapi-markdown__details mime",
+          "data-collapsed": false,
+          open: true,
+          style: style,
+          summary: react_1.default.createElement(
+            react_1.default.Fragment,
+            null,
+            react_1.default.createElement(
+              "summary",
+              null,
+              react_1.default.createElement(
+                "h3",
+                { className: "openapi-markdown__details-summary-header-body" },
+                title,
+                firstBody.type === "array" &&
+                  react_1.default.createElement(
+                    "span",
+                    { style: { opacity: "0.6" } },
+                    " array"
+                  ),
+                body.required &&
+                  react_1.default.createElement(
+                    "strong",
+                    { className: "openapi-schema__required" },
+                    "required"
+                  )
+              )
+            )
+          ),
+        },
+        react_1.default.createElement(
+          "div",
+          { style: { textAlign: "left", marginLeft: "1rem" } },
+          body.description &&
+            react_1.default.createElement(
+              "div",
+              { style: { marginTop: "1rem", marginBottom: "1rem" } },
+              (0, createDescription_1.createDescription)(body.description)
+            )
+        ),
+        react_1.default.createElement(
+          "ul",
+          { style: { marginLeft: "1rem" } },
+          react_1.default.createElement(Schema_1.default, {
+            schema: firstBody,
+            schemaType: "request",
+          })
+        )
+      )
+    )
+  );
+};
+const RequestSchema = (props) => {
+  return react_1.default.createElement(
+    BrowserOnly_1.default,
+    {
+      fallback: react_1.default.createElement(SkeletonLoader_1.default, {
+        size: "sm",
+      }),
+    },
+    () => {
+      const LazyComponent = react_1.default.lazy(() =>
+        Promise.resolve({ default: RequestSchemaComponent })
+      );
+      return react_1.default.createElement(
+        react_1.Suspense,
+        { fallback: null },
+        react_1.default.createElement(LazyComponent, { ...props })
+      );
+    }
+  );
+};
+exports.default = RequestSchema;