docusaurus-theme-openapi-docs 0.0.0-803 → 0.0.0-822

package/lib/theme/ApiExplorer/Request/_Request.scss

@@ -114,6 +114,11 @@
   }
 }
 
+.openapi-security__summary-container {
+  background: var(--ifm-pre-background);
+  border-radius: var(--ifm-pre-border-radius);
+}
+
 // Prevent auto zoom on mobile iOS devices when focusing on input elmenents
 @media screen and (-webkit-min-device-pixel-ratio: 0) and (max-device-width: 1024px) {
   .prism-code,

package/lib/theme/ApiExplorer/index.js

@@ -17,12 +17,18 @@ const CodeSnippets_1 = __importDefault(
 );
 const Request_1 = __importDefault(require("@theme/ApiExplorer/Request"));
 const Response_1 = __importDefault(require("@theme/ApiExplorer/Response"));
+const SecuritySchemes_1 = __importDefault(
+  require("@theme/ApiExplorer/SecuritySchemes")
+);
 const postman_collection_1 = __importDefault(require("postman-collection"));
 function ApiExplorer({ item, infoPath }) {
   const postman = new postman_collection_1.default.Request(item.postman);
   return react_1.default.createElement(
     react_1.default.Fragment,
     null,
+    react_1.default.createElement(SecuritySchemes_1.default, {
+      infoPath: infoPath,
+    }),
     item.method !== "event" &&
       react_1.default.createElement(CodeSnippets_1.default, {
         postman: postman,

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

@@ -17,7 +17,8 @@ export interface Props {
         required: boolean;
         deprecated: boolean;
         schema: any;
+        enumDescriptions?: [string, string][];
     };
 }
-declare function ParamsItem({ param: { description, example, examples, name, required, schema, deprecated }, }: Props): React.JSX.Element;
+declare function ParamsItem({ param, ...rest }: Props): React.JSX.Element;
 export default ParamsItem;

package/lib/theme/ParamsItem/index.js

@@ -19,15 +19,45 @@ const TabItem_1 = __importDefault(require("@theme/TabItem"));
 const clsx_1 = __importDefault(require("clsx"));
 const react_markdown_1 = __importDefault(require("react-markdown"));
 const rehype_raw_1 = __importDefault(require("rehype-raw"));
+const remark_gfm_1 = __importDefault(require("remark-gfm"));
 const createDescription_1 = require("../../markdown/createDescription");
 const schema_1 = require("../../markdown/schema");
 const utils_1 = require("../../markdown/utils");
-function ParamsItem({
-  param: { description, example, examples, name, required, schema, deprecated },
-}) {
+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) {
     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",
@@ -91,21 +121,47 @@ function ParamsItem({
       })
     )
   );
-  const renderDefaultValue = (0, utils_1.guard)(
-    schema && schema.items
-      ? schema.items.default
-      : schema
-        ? schema.default
-        : undefined,
-    (value) =>
-      react_1.default.createElement(
+  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,
+      });
+    }
+  );
+  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(react_markdown_1.default, {
-          children: `**Default value:** \`${value}\``,
-        })
-      )
-  );
+        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) =>
@@ -186,8 +242,9 @@ function ParamsItem({
       renderDeprecated
     ),
     renderSchema,
-    renderDefaultValue,
     renderDescription,
+    renderEnumDescriptions,
+    renderDefaultValue(),
     renderExample,
     renderExamples
   );

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

@@ -9,4 +9,4 @@ export interface Props {
     schema: any;
     discriminator: boolean;
 }
-export default function SchemaItem({ children: collapsibleSchemaContent, collapsible, name, qualifierMessage, required, schemaName, schema, }: Props): React.JSX.Element;
+export default function SchemaItem(props: Props): React.JSX.Element;

package/lib/theme/SchemaItem/index.js

@@ -16,24 +16,47 @@ const CodeBlock_1 = __importDefault(require("@theme/CodeBlock"));
 const clsx_1 = __importDefault(require("clsx"));
 const react_markdown_1 = __importDefault(require("react-markdown"));
 const rehype_raw_1 = __importDefault(require("rehype-raw"));
+const remark_gfm_1 = __importDefault(require("remark-gfm"));
 const createDescription_1 = require("../../markdown/createDescription");
 const utils_1 = require("../../markdown/utils");
-function SchemaItem({
-  children: collapsibleSchemaContent,
-  collapsible,
-  name,
-  qualifierMessage,
-  required,
-  schemaName,
-  schema,
-}) {
+const transformEnumDescriptions = (enumDescriptions) => {
+  if (enumDescriptions) {
+    return Object.entries(enumDescriptions);
+  }
+  return [];
+};
+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 SchemaItem(props) {
+  const {
+    children: collapsibleSchemaContent,
+    collapsible,
+    name,
+    qualifierMessage,
+    required,
+    schemaName,
+    schema,
+  } = props;
   let deprecated;
   let schemaDescription;
   let defaultValue;
   let nullable;
+  let enumDescriptions = [];
   if (schema) {
     deprecated = schema.deprecated;
     schemaDescription = schema.description;
+    enumDescriptions = transformEnumDescriptions(schema["x-enumDescriptions"]);
     defaultValue = schema.default;
     nullable = schema.nullable;
   }
@@ -60,6 +83,16 @@ function SchemaItem({
       "nullable"
     )
   );
+  const renderEnumDescriptions = (0, utils_1.guard)(
+    getEnumDescriptionMarkdown(enumDescriptions),
+    (value) => {
+      return react_1.default.createElement(react_markdown_1.default, {
+        remarkPlugins: [remark_gfm_1.default],
+        rehypePlugins: [rehype_raw_1.default],
+        children: value,
+      });
+    }
+  );
   const renderSchemaDescription = (0, utils_1.guard)(
     schemaDescription,
     (description) =>
@@ -103,15 +136,37 @@ function SchemaItem({
         })
       )
   );
-  const renderDefaultValue = (0, utils_1.guard)(defaultValue, (value) =>
-    react_1.default.createElement(
-      "div",
-      { className: "" },
-      react_1.default.createElement(react_markdown_1.default, {
-        children: `**Default value:** \`${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 schemaContent = react_1.default.createElement(
     "div",
     null,
@@ -141,9 +196,10 @@ function SchemaItem({
       renderRequired,
       renderDeprecated
     ),
-    renderQualifierMessage,
-    renderDefaultValue,
     renderSchemaDescription,
+    renderEnumDescriptions,
+    renderQualifierMessage,
+    renderDefaultValue(),
     collapsibleSchemaContent ?? collapsibleSchemaContent
   );
   return react_1.default.createElement(

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.0.0-803",
+  "version": "0.0.0-822",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -42,7 +42,7 @@
     "clsx": "^1.1.1",
     "copy-text-to-clipboard": "^3.1.0",
     "crypto-js": "^4.1.1",
-    "docusaurus-plugin-openapi-docs": "0.0.0-803",
+    "docusaurus-plugin-openapi-docs": "0.0.0-822",
     "docusaurus-plugin-sass": "^0.2.3",
     "file-saver": "^2.0.5",
     "lodash": "^4.17.20",
@@ -57,6 +57,7 @@
     "react-modal": "^3.15.1",
     "react-redux": "^7.2.0",
     "rehype-raw": "^6.1.1",
+    "remark-gfm": "3.0.1",
     "sass": "^1.58.1",
     "sass-loader": "^13.3.2",
     "webpack": "^5.61.0",
@@ -69,5 +70,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "e2ff586260fa651fbd0a39efc9413699f88942e7"
+  "gitHead": "45cf7902efde96e5b560f34d68113cfccda9f174"
 }

package/src/theme/ApiExplorer/Request/_Request.scss

@@ -114,6 +114,11 @@
   }
 }
 
+.openapi-security__summary-container {
+  background: var(--ifm-pre-background);
+  border-radius: var(--ifm-pre-border-radius);
+}
+
 // Prevent auto zoom on mobile iOS devices when focusing on input elmenents
 @media screen and (-webkit-min-device-pixel-ratio: 0) and (max-device-width: 1024px) {
   .prism-code,

package/src/theme/ApiExplorer/index.tsx

@@ -10,6 +10,7 @@ import React from "react";
 import CodeSnippets from "@theme/ApiExplorer/CodeSnippets";
 import Request from "@theme/ApiExplorer/Request";
 import Response from "@theme/ApiExplorer/Response";
+import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
 import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
 import sdk from "postman-collection";
 
@@ -24,6 +25,7 @@ function ApiExplorer({
 
   return (
     <>
+      <SecuritySchemes infoPath={infoPath} />
       {item.method !== "event" && (
         <CodeSnippets
           postman={postman}

package/src/theme/ParamsItem/index.tsx

@@ -14,6 +14,7 @@ import TabItem from "@theme/TabItem";
 import clsx from "clsx";
 import ReactMarkdown from "react-markdown";
 import rehypeRaw from "rehype-raw";
+import remarkGfm from "remark-gfm";
 
 import { createDescription } from "../../markdown/createDescription";
 import { getQualifierMessage, getSchemaName } from "../../markdown/schema";
@@ -39,15 +40,49 @@ export interface Props {
     required: boolean;
     deprecated: boolean;
     schema: any;
+    enumDescriptions?: [string, string][];
   };
 }
 
-function ParamsItem({
-  param: { description, example, examples, name, required, schema, deprecated },
-}: Props) {
+const getEnumDescriptionMarkdown = (enumDescriptions?: [string, string][]) => {
+  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 }: Props) {
+  const {
+    description,
+    example,
+    examples,
+    name,
+    required,
+    deprecated,
+    enumDescriptions,
+  } = param;
+
+  let schema = param.schema;
+  let defaultValue: string | undefined;
+
   if (!schema || !schema?.type) {
     schema = { type: "any" };
   }
+  if (schema) {
+    if (schema.items) {
+      defaultValue = schema.items.default;
+    } else {
+      defaultValue = schema.default;
+    }
+  }
 
   const renderSchemaName = guard(schema, (schema) => (
     <span className="openapi-schema__type"> {getSchemaName(schema)}</span>
@@ -91,19 +126,43 @@ function ParamsItem({
     </div>
   ));
 
-  const renderDefaultValue = guard(
-    schema && schema.items
-      ? schema.items.default
-      : schema
-        ? schema.default
-        : undefined,
-    (value) => (
-      <div>
-        <ReactMarkdown children={`**Default value:** \`${value}\``} />
-      </div>
-    )
+  const renderEnumDescriptions = guard(
+    getEnumDescriptionMarkdown(enumDescriptions),
+    (value) => {
+      return (
+        <ReactMarkdown
+          rehypePlugins={[rehypeRaw]}
+          remarkPlugins={[remarkGfm]}
+          children={value}
+        />
+      );
+    }
   );
 
+  function renderDefaultValue() {
+    if (defaultValue !== undefined) {
+      if (typeof defaultValue === "string") {
+        return (
+          <div>
+            <strong>Default value: </strong>
+            <span>
+              <code>{defaultValue}</code>
+            </span>
+          </div>
+        );
+      }
+      return (
+        <div>
+          <strong>Default value: </strong>
+          <span>
+            <code>{JSON.stringify(defaultValue)}</code>
+          </span>
+        </div>
+      );
+    }
+    return undefined;
+  }
+
   const renderExample = guard(toString(example), (example) => (
     <div>
       <strong>Example: </strong>
@@ -156,8 +215,9 @@ function ParamsItem({
         {renderDeprecated}
       </span>
       {renderSchema}
-      {renderDefaultValue}
       {renderDescription}
+      {renderEnumDescriptions}
+      {renderDefaultValue()}
       {renderExample}
       {renderExamples}
     </div>

package/src/theme/SchemaItem/index.tsx

@@ -11,6 +11,7 @@ import CodeBlock from "@theme/CodeBlock";
 import clsx from "clsx";
 import ReactMarkdown from "react-markdown";
 import rehypeRaw from "rehype-raw";
+import remarkGfm from "remark-gfm";
 
 import { createDescription } from "../../markdown/createDescription";
 import { guard } from "../../markdown/utils";
@@ -27,22 +28,51 @@ export interface Props {
   discriminator: boolean;
 }
 
-export default function SchemaItem({
-  children: collapsibleSchemaContent,
-  collapsible,
-  name,
-  qualifierMessage,
-  required,
-  schemaName,
-  schema,
-}: Props) {
+const transformEnumDescriptions = (
+  enumDescriptions?: Record<string, string>
+) => {
+  if (enumDescriptions) {
+    return Object.entries(enumDescriptions);
+  }
+
+  return [];
+};
+
+const getEnumDescriptionMarkdown = (enumDescriptions?: [string, string][]) => {
+  if (enumDescriptions?.length) {
+    return `| Enum Value | Description |
+| ---- | ----- |
+${enumDescriptions
+  .map((desc) => {
+    return `| ${desc[0]} | ${desc[1]} | `.replaceAll("\n", "<br/>");
+  })
+  .join("\n")}
+    `;
+  }
+
+  return "";
+};
+
+export default function SchemaItem(props: Props) {
+  const {
+    children: collapsibleSchemaContent,
+    collapsible,
+    name,
+    qualifierMessage,
+    required,
+    schemaName,
+    schema,
+  } = props;
   let deprecated;
   let schemaDescription;
-  let defaultValue;
+  let defaultValue: string | undefined;
   let nullable;
+  let enumDescriptions: [string, string][] = [];
+
   if (schema) {
     deprecated = schema.deprecated;
     schemaDescription = schema.description;
+    enumDescriptions = transformEnumDescriptions(schema["x-enumDescriptions"]);
     defaultValue = schema.default;
     nullable = schema.nullable;
   }
@@ -60,6 +90,19 @@ export default function SchemaItem({
     <span className="openapi-schema__nullable">nullable</span>
   ));
 
+  const renderEnumDescriptions = guard(
+    getEnumDescriptionMarkdown(enumDescriptions),
+    (value) => {
+      return (
+        <ReactMarkdown
+          remarkPlugins={[remarkGfm]}
+          rehypePlugins={[rehypeRaw]}
+          children={value}
+        />
+      );
+    }
+  );
+
   const renderSchemaDescription = guard(schemaDescription, (description) => (
     <div>
       <ReactMarkdown
@@ -90,11 +133,29 @@ export default function SchemaItem({
     </div>
   ));
 
-  const renderDefaultValue = guard(defaultValue, (value) => (
-    <div className="">
-      <ReactMarkdown children={`**Default value:** \`${value}\``} />
-    </div>
-  ));
+  function renderDefaultValue() {
+    if (defaultValue !== undefined) {
+      if (typeof defaultValue === "string") {
+        return (
+          <div>
+            <strong>Default value: </strong>
+            <span>
+              <code>{defaultValue}</code>
+            </span>
+          </div>
+        );
+      }
+      return (
+        <div>
+          <strong>Default value: </strong>
+          <span>
+            <code>{JSON.stringify(defaultValue)}</code>
+          </span>
+        </div>
+      );
+    }
+    return undefined;
+  }
 
   const schemaContent = (
     <div>
@@ -114,9 +175,10 @@ export default function SchemaItem({
         {renderRequired}
         {renderDeprecated}
       </span>
-      {renderQualifierMessage}
-      {renderDefaultValue}
       {renderSchemaDescription}
+      {renderEnumDescriptions}
+      {renderQualifierMessage}
+      {renderDefaultValue()}
       {collapsibleSchemaContent ?? collapsibleSchemaContent}
     </div>
   );