docusaurus-theme-openapi-docs 0.0.0-1000

package/lib/theme/ParamsItem/_ParamsItem.scss

@@ -0,0 +1,54 @@
+.openapi-params__list-item {
+  margin: 0 0 0 1rem !important;
+  position: relative;
+  padding-left: 1rem;
+  border-left: thin solid var(--openapi-tree-line-color) !important;
+  margin-top: unset !important;
+
+  // Horizonal line styling for param attributes
+  &::before {
+    position: absolute;
+    top: 5px;
+    left: 0;
+    width: 0.7rem;
+    /* width of horizontal line */
+    height: 0.5rem;
+    /* vertical position of line */
+    vertical-align: top;
+    border-bottom: thin solid var(--openapi-tree-line-color);
+    content: "";
+    display: inline-block;
+  }
+
+  &:hover {
+    .openapi-schema__property {
+      color: var(--ifm-color-primary);
+    }
+  }
+}
+
+.openapi-schema__type {
+  opacity: 0.6;
+  padding-left: 0.3rem;
+}
+
+.openapi-schema__required {
+  display: inline-flex;
+  align-items: center;
+  font-size: 10.5px;
+  font-weight: bold;
+  color: var(--openapi-required);
+  margin-left: 1%;
+  background-color: transparent;
+  text-transform: uppercase;
+}
+
+.openapi-schema__divider {
+  flex-grow: 1;
+  border-bottom: thin solid var(--ifm-toc-border-color);
+  margin: 10px;
+}
+
+.openapi-schema__container {
+  display: flex;
+}

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

@@ -0,0 +1,25 @@
+import React from "react";
+interface Map<T> {
+    [key: string]: T;
+}
+export interface ExampleObject {
+    summary?: string;
+    description?: string;
+    value?: any;
+    externalValue?: string;
+}
+export interface Props {
+    className: string;
+    param: {
+        description: string;
+        example: any;
+        examples: Map<ExampleObject>;
+        name: string;
+        required: boolean;
+        deprecated: boolean;
+        schema: any;
+        enumDescriptions?: [string, string][];
+    };
+}
+declare function ParamsItem({ param, ...rest }: Props): React.JSX.Element;
+export default ParamsItem;

package/lib/theme/ParamsItem/index.js

@@ -0,0 +1,218 @@
+"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 });
+const react_1 = __importDefault(require("react"));
+const Markdown_1 = __importDefault(require("@theme/Markdown"));
+const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
+const TabItem_1 = __importDefault(require("@theme/TabItem"));
+/* eslint-disable import/no-extraneous-dependencies*/
+const clsx_1 = __importDefault(require("clsx"));
+const schema_1 = require("../../markdown/schema");
+const utils_1 = require("../../markdown/utils");
+const getEnumDescriptionMarkdown = (enumDescriptions) => {
+  if (enumDescriptions?.length) {
+    return `| Enum Value | Description |
+| ---- | ----- |
+${enumDescriptions
+  .map((desc) => {
+    return `| ${desc[0]} | ${desc[1]} | `.replaceAll("\n", "<br/>");
+  })
+  .join("\n")}
+    `;
+  }
+  return "";
+};
+function ParamsItem({ param, ...rest }) {
+  const {
+    description,
+    example,
+    examples,
+    name,
+    required,
+    deprecated,
+    enumDescriptions,
+  } = param;
+  let schema = param.schema;
+  let defaultValue;
+  if (!schema) {
+    schema = { type: "any" };
+  }
+  if (!schema.type) {
+    schema.type = "any";
+  }
+  if (schema) {
+    if (schema.items) {
+      defaultValue = schema.items.default;
+    } else {
+      defaultValue = schema.default;
+    }
+  }
+  const renderSchemaName = (0, utils_1.guard)(schema, (schema) =>
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__type" },
+      " ",
+      (0, schema_1.getSchemaName)(schema)
+    )
+  );
+  const renderSchemaRequired = (0, utils_1.guard)(required, () =>
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__required" },
+      "required"
+    )
+  );
+  const renderDeprecated = (0, utils_1.guard)(deprecated, () =>
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__deprecated" },
+      "deprecated"
+    )
+  );
+  const renderQualifier = (0, utils_1.guard)(
+    (0, schema_1.getQualifierMessage)(schema),
+    (qualifier) =>
+      react_1.default.createElement(Markdown_1.default, null, qualifier)
+  );
+  const renderDescription = (0, utils_1.guard)(description, (description) =>
+    react_1.default.createElement(Markdown_1.default, null, description)
+  );
+  const renderEnumDescriptions = (0, utils_1.guard)(
+    getEnumDescriptionMarkdown(enumDescriptions),
+    (value) => {
+      return react_1.default.createElement(
+        "div",
+        { style: { marginTop: ".5rem" } },
+        react_1.default.createElement(Markdown_1.default, null, value)
+      );
+    }
+  );
+  function renderDefaultValue() {
+    if (defaultValue !== undefined) {
+      if (typeof defaultValue === "string") {
+        return react_1.default.createElement(
+          "div",
+          null,
+          react_1.default.createElement("strong", null, "Default value: "),
+          react_1.default.createElement(
+            "span",
+            null,
+            react_1.default.createElement("code", null, defaultValue)
+          )
+        );
+      }
+      return react_1.default.createElement(
+        "div",
+        null,
+        react_1.default.createElement("strong", null, "Default value: "),
+        react_1.default.createElement(
+          "span",
+          null,
+          react_1.default.createElement(
+            "code",
+            null,
+            JSON.stringify(defaultValue)
+          )
+        )
+      );
+    }
+    return undefined;
+  }
+  const renderExample = (0, utils_1.guard)(
+    (0, utils_1.toString)(example),
+    (example) =>
+      react_1.default.createElement(
+        "div",
+        null,
+        react_1.default.createElement("strong", null, "Example: "),
+        example
+      )
+  );
+  const renderExamples = (0, utils_1.guard)(examples, (examples) => {
+    const exampleEntries = Object.entries(examples);
+    return react_1.default.createElement(
+      react_1.default.Fragment,
+      null,
+      react_1.default.createElement("strong", null, "Examples:"),
+      react_1.default.createElement(
+        SchemaTabs_1.default,
+        null,
+        exampleEntries.map(([exampleName, exampleProperties]) =>
+          // @ts-ignore
+          react_1.default.createElement(
+            TabItem_1.default,
+            { value: exampleName, label: exampleName },
+            exampleProperties.summary &&
+              react_1.default.createElement(
+                "p",
+                null,
+                exampleProperties.summary
+              ),
+            exampleProperties.description &&
+              react_1.default.createElement(
+                "p",
+                null,
+                react_1.default.createElement("strong", null, "Description: "),
+                react_1.default.createElement(
+                  "span",
+                  null,
+                  exampleProperties.description
+                )
+              ),
+            react_1.default.createElement(
+              "p",
+              null,
+              react_1.default.createElement("strong", null, "Example: "),
+              react_1.default.createElement(
+                "code",
+                null,
+                exampleProperties.value
+              )
+            )
+          )
+        )
+      )
+    );
+  });
+  return react_1.default.createElement(
+    "div",
+    { className: "openapi-params__list-item" },
+    react_1.default.createElement(
+      "span",
+      { className: "openapi-schema__container" },
+      react_1.default.createElement(
+        "strong",
+        {
+          className: (0, clsx_1.default)("openapi-schema__property", {
+            "openapi-schema__strikethrough": deprecated,
+          }),
+        },
+        name
+      ),
+      renderSchemaName,
+      (required || deprecated) &&
+        react_1.default.createElement("span", {
+          className: "openapi-schema__divider",
+        }),
+      renderSchemaRequired,
+      renderDeprecated
+    ),
+    renderQualifier,
+    renderDescription,
+    renderEnumDescriptions,
+    renderDefaultValue(),
+    renderExample,
+    renderExamples
+  );
+}
+exports.default = ParamsItem;

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,194 @@
+"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 });
+const react_1 = __importDefault(require("react"));
+const BrowserOnly_1 = __importDefault(require("@docusaurus/BrowserOnly"));
+const Details_1 = __importDefault(require("@theme/Details"));
+const Markdown_1 = __importDefault(require("@theme/Markdown"));
+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 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" } },
+                    react_1.default.createElement(
+                      Markdown_1.default,
+                      null,
+                      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" } },
+              react_1.default.createElement(
+                Markdown_1.default,
+                null,
+                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",
+      }),
+    },
+    () => {
+      return react_1.default.createElement(RequestSchemaComponent, {
+        ...props,
+      });
+    }
+  );
+};
+exports.default = RequestSchema;

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

@@ -0,0 +1,18 @@
+import React from "react";
+export declare function json2xml(o: Record<string, any>, tab: string): string;
+interface ResponseExamplesProps {
+    responseExamples: any;
+    mimeType: string;
+}
+export declare const ResponseExamples: React.FC<ResponseExamplesProps>;
+interface ResponseExampleProps {
+    responseExample: any;
+    mimeType: string;
+}
+export declare const ResponseExample: React.FC<ResponseExampleProps>;
+interface ExampleFromSchemaProps {
+    schema: any;
+    mimeType: string;
+}
+export declare const ExampleFromSchema: React.FC<ExampleFromSchemaProps>;
+export {};