docusaurus-theme-openapi-docs 0.0.0-1105 → 0.0.0-1106

package/lib/markdown/schema.js

@@ -10,6 +10,38 @@ exports.getSchemaName = getSchemaName;
 exports.getQualifierMessage = getQualifierMessage;
 const Translate_1 = require("@docusaurus/Translate");
 const translationIds_1 = require("../theme/translationIds");
+/**
+ * Extracts enum values from a schema, including when wrapped in allOf.
+ */
+function getEnumFromSchema(schema) {
+    if (schema.enum) {
+        return schema.enum;
+    }
+    if (schema.allOf && Array.isArray(schema.allOf)) {
+        for (const item of schema.allOf) {
+            if (item.enum) {
+                return item.enum;
+            }
+        }
+    }
+    return undefined;
+}
+/**
+ * Extracts the type from a schema, including when wrapped in allOf.
+ */
+function getTypeFromSchema(schema) {
+    if (schema.type) {
+        return schema.type;
+    }
+    if (schema.allOf && Array.isArray(schema.allOf)) {
+        for (const item of schema.allOf) {
+            if (item.type) {
+                return item.type;
+            }
+        }
+    }
+    return undefined;
+}
 function prettyName(schema, circular) {
     // Handle enum-only schemas (valid in JSON Schema)
     // When enum is present without explicit type, treat as string
@@ -26,6 +58,12 @@ function prettyName(schema, circular) {
                 return schema.allOf[0];
             }
         }
+        // Check if allOf contains an enum - if so, return the type from allOf
+        const enumFromAllOf = getEnumFromSchema(schema);
+        if (enumFromAllOf) {
+            const typeFromAllOf = getTypeFromSchema(schema);
+            return typeFromAllOf ?? "string";
+        }
         return "object";
     }
     if (schema.oneOf) {
@@ -72,9 +110,11 @@ function getQualifierMessage(schema) {
         message: "Possible values:",
     })}** `;
     let qualifierGroups = [];
-    if (schema.items && schema.items.enum) {
-        if (schema.items.enum) {
-            qualifierGroups.push(`[${schema.items.enum.map((e) => `\`${e}\``).join(", ")}]`);
+    // Check for enum in array items (directly or inside allOf)
+    if (schema.items) {
+        const itemsEnum = getEnumFromSchema(schema.items);
+        if (itemsEnum) {
+            qualifierGroups.push(`[${itemsEnum.map((e) => `\`${e}\``).join(", ")}]`);
         }
     }
     if (schema.minLength || schema.maxLength) {
@@ -146,8 +186,10 @@ function getQualifierMessage(schema) {
         const values = Object.keys(discriminator.mapping);
         qualifierGroups.push(`[${values.map((e) => `\`${e}\``).join(", ")}]`);
     }
-    if (schema.enum) {
-        qualifierGroups.push(`[${schema.enum.map((e) => `\`${e}\``).join(", ")}]`);
+    // Check for enum directly on schema or inside allOf
+    const schemaEnum = getEnumFromSchema(schema);
+    if (schemaEnum) {
+        qualifierGroups.push(`[${schemaEnum.map((e) => `\`${e}\``).join(", ")}]`);
     }
     if (schema.minItems) {
         qualifierGroups.push(`\`>= ${schema.minItems}\``);

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem.js

@@ -18,6 +18,7 @@ const error_message_1 = require("@hookform/error-message");
 const FormMultiSelect_1 = __importDefault(
   require("@theme/ApiExplorer/FormMultiSelect")
 );
+const ParamOptions_1 = require("@theme/ApiExplorer/ParamOptions");
 const slice_1 = require("@theme/ApiExplorer/ParamOptions/slice");
 const hooks_1 = require("@theme/ApiItem/hooks");
 const translationIds_1 = require("@theme/translationIds");
@@ -29,7 +30,7 @@ function ParamMultiSelectFormItem({ param }) {
   } = (0, react_hook_form_1.useFormContext)();
   const showErrorMessage = errors?.paramMultiSelect;
   const dispatch = (0, hooks_1.useTypedDispatch)();
-  const options = param.schema?.items?.enum ?? [];
+  const options = (0, ParamOptions_1.getSchemaEnum)(param.schema?.items) ?? [];
   const pathParams = (0, hooks_1.useTypedSelector)(
     (state) => state.params.path
   );

package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamSelectFormItem.js

@@ -16,6 +16,7 @@ const react_1 = __importDefault(require("react"));
 const Translate_1 = require("@docusaurus/Translate");
 const error_message_1 = require("@hookform/error-message");
 const FormSelect_1 = __importDefault(require("@theme/ApiExplorer/FormSelect"));
+const ParamOptions_1 = require("@theme/ApiExplorer/ParamOptions");
 const slice_1 = require("@theme/ApiExplorer/ParamOptions/slice");
 const hooks_1 = require("@theme/ApiItem/hooks");
 const translationIds_1 = require("@theme/translationIds");
@@ -27,7 +28,7 @@ function ParamSelectFormItem({ param }) {
   } = (0, react_hook_form_1.useFormContext)();
   const showErrorMessage = errors?.paramSelect;
   const dispatch = (0, hooks_1.useTypedDispatch)();
-  const options = param.schema?.enum ?? [];
+  const options = (0, ParamOptions_1.getSchemaEnum)(param.schema) ?? [];
   return react_1.default.createElement(
     react_1.default.Fragment,
     null,

package/lib/theme/ApiExplorer/ParamOptions/index.d.ts

@@ -3,5 +3,10 @@ import { Param } from "./slice";
 export interface ParamProps {
     param: Param;
 }
+/**
+ * Extracts enum values from a schema, including when wrapped in allOf.
+ * This handles cases where an enum is referenced via allOf for composition.
+ */
+export declare function getSchemaEnum(schema: any): any[] | undefined;
 declare function ParamOptions(): React.JSX.Element;
 export default ParamOptions;

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

@@ -67,6 +67,7 @@ var __importDefault =
     return mod && mod.__esModule ? mod : { default: mod };
   };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSchemaEnum = getSchemaEnum;
 const react_1 = __importStar(require("react"));
 const Translate_1 = require("@docusaurus/Translate");
 const FormItem_1 = __importDefault(require("@theme/ApiExplorer/FormItem"));
@@ -87,8 +88,29 @@ const ParamTextFormItem_1 = __importDefault(
 );
 const hooks_1 = require("@theme/ApiItem/hooks");
 const translationIds_1 = require("@theme/translationIds");
+/**
+ * Extracts enum values from a schema, including when wrapped in allOf.
+ * This handles cases where an enum is referenced via allOf for composition.
+ */
+function getSchemaEnum(schema) {
+  // Direct enum on schema
+  if (schema?.enum) {
+    return schema.enum;
+  }
+  // Enum inside allOf - check each item
+  if (schema?.allOf && Array.isArray(schema.allOf)) {
+    for (const item of schema.allOf) {
+      if (item.enum) {
+        return item.enum;
+      }
+    }
+  }
+  return undefined;
+}
 function ParamOption({ param }) {
-  if (param.schema?.type === "array" && param.schema.items?.enum) {
+  const schemaEnum = getSchemaEnum(param.schema);
+  const itemsEnum = getSchemaEnum(param.schema?.items);
+  if (param.schema?.type === "array" && itemsEnum) {
     return react_1.default.createElement(ParamMultiSelectFormItem_1.default, {
       param: param,
     });
@@ -98,7 +120,7 @@ function ParamOption({ param }) {
       param: param,
     });
   }
-  if (param.schema?.enum) {
+  if (schemaEnum) {
     return react_1.default.createElement(ParamSelectFormItem_1.default, {
       param: param,
     });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.0.0-1105",
+  "version": "0.0.0-1106",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -38,7 +38,7 @@
     "@types/postman-collection": "^3.5.11",
     "@types/react-modal": "^3.16.3",
     "concurrently": "^9.2.0",
-    "docusaurus-plugin-openapi-docs": "0.0.0-1105",
+    "docusaurus-plugin-openapi-docs": "0.0.0-1106",
     "docusaurus-plugin-sass": "^0.2.6",
     "eslint-plugin-prettier": "^5.5.1"
   },
@@ -81,5 +81,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "5a573d71d569e71efd1a08fc4abbd4c822533e55"
+  "gitHead": "f0ef2d969b4244b515264100ae5122bf3e08f9dc"
 }

package/src/markdown/schema.ts

@@ -10,6 +10,44 @@ import { translate } from "@docusaurus/Translate";
 import { OPENAPI_SCHEMA_ITEM } from "../theme/translationIds";
 import { SchemaObject } from "../types";
 
+/**
+ * Extracts enum values from a schema, including when wrapped in allOf.
+ */
+function getEnumFromSchema(schema: SchemaObject): any[] | undefined {
+  if (schema.enum) {
+    return schema.enum;
+  }
+
+  if (schema.allOf && Array.isArray(schema.allOf)) {
+    for (const item of schema.allOf) {
+      if (item.enum) {
+        return item.enum;
+      }
+    }
+  }
+
+  return undefined;
+}
+
+/**
+ * Extracts the type from a schema, including when wrapped in allOf.
+ */
+function getTypeFromSchema(schema: SchemaObject): string | undefined {
+  if (schema.type) {
+    return schema.type as string;
+  }
+
+  if (schema.allOf && Array.isArray(schema.allOf)) {
+    for (const item of schema.allOf) {
+      if (item.type) {
+        return item.type as string;
+      }
+    }
+  }
+
+  return undefined;
+}
+
 function prettyName(schema: SchemaObject, circular?: boolean) {
   // Handle enum-only schemas (valid in JSON Schema)
   // When enum is present without explicit type, treat as string
@@ -28,6 +66,12 @@ function prettyName(schema: SchemaObject, circular?: boolean) {
         return schema.allOf[0];
       }
     }
+    // Check if allOf contains an enum - if so, return the type from allOf
+    const enumFromAllOf = getEnumFromSchema(schema);
+    if (enumFromAllOf) {
+      const typeFromAllOf = getTypeFromSchema(schema);
+      return typeFromAllOf ?? "string";
+    }
     return "object";
   }
 
@@ -92,10 +136,12 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
 
   let qualifierGroups = [];
 
-  if (schema.items && schema.items.enum) {
-    if (schema.items.enum) {
+  // Check for enum in array items (directly or inside allOf)
+  if (schema.items) {
+    const itemsEnum = getEnumFromSchema(schema.items as SchemaObject);
+    if (itemsEnum) {
       qualifierGroups.push(
-        `[${schema.items.enum.map((e) => `\`${e}\``).join(", ")}]`
+        `[${itemsEnum.map((e) => `\`${e}\``).join(", ")}]`
       );
     }
   }
@@ -177,8 +223,10 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
     qualifierGroups.push(`[${values.map((e) => `\`${e}\``).join(", ")}]`);
   }
 
-  if (schema.enum) {
-    qualifierGroups.push(`[${schema.enum.map((e) => `\`${e}\``).join(", ")}]`);
+  // Check for enum directly on schema or inside allOf
+  const schemaEnum = getEnumFromSchema(schema);
+  if (schemaEnum) {
+    qualifierGroups.push(`[${schemaEnum.map((e) => `\`${e}\``).join(", ")}]`);
   }
 
   if (schema.minItems) {

package/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem.tsx

@@ -10,6 +10,7 @@ import React from "react";
 import { translate } from "@docusaurus/Translate";
 import { ErrorMessage } from "@hookform/error-message";
 import FormMultiSelect from "@theme/ApiExplorer/FormMultiSelect";
+import { getSchemaEnum } from "@theme/ApiExplorer/ParamOptions";
 import { Param, setParam } from "@theme/ApiExplorer/ParamOptions/slice";
 import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
 import { OPENAPI_FORM } from "@theme/translationIds";
@@ -29,7 +30,7 @@ export default function ParamMultiSelectFormItem({ param }: ParamProps) {
 
   const dispatch = useTypedDispatch();
 
-  const options = param.schema?.items?.enum ?? [];
+  const options = getSchemaEnum(param.schema?.items) ?? [];
 
   const pathParams = useTypedSelector((state: any) => state.params.path);
   const queryParams = useTypedSelector((state: any) => state.params.query);

package/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamSelectFormItem.tsx

@@ -10,6 +10,7 @@ import React from "react";
 import { translate } from "@docusaurus/Translate";
 import { ErrorMessage } from "@hookform/error-message";
 import FormSelect from "@theme/ApiExplorer/FormSelect";
+import { getSchemaEnum } from "@theme/ApiExplorer/ParamOptions";
 import { Param, setParam } from "@theme/ApiExplorer/ParamOptions/slice";
 import { useTypedDispatch } from "@theme/ApiItem/hooks";
 import { OPENAPI_FORM } from "@theme/translationIds";
@@ -29,7 +30,7 @@ export default function ParamSelectFormItem({ param }: ParamProps) {
 
   const dispatch = useTypedDispatch();
 
-  const options = param.schema?.enum ?? [];
+  const options = getSchemaEnum(param.schema) ?? [];
 
   return (
     <>

package/src/theme/ApiExplorer/ParamOptions/index.tsx

@@ -23,8 +23,33 @@ export interface ParamProps {
   param: Param;
 }
 
+/**
+ * Extracts enum values from a schema, including when wrapped in allOf.
+ * This handles cases where an enum is referenced via allOf for composition.
+ */
+export function getSchemaEnum(schema: any): any[] | undefined {
+  // Direct enum on schema
+  if (schema?.enum) {
+    return schema.enum;
+  }
+
+  // Enum inside allOf - check each item
+  if (schema?.allOf && Array.isArray(schema.allOf)) {
+    for (const item of schema.allOf) {
+      if (item.enum) {
+        return item.enum;
+      }
+    }
+  }
+
+  return undefined;
+}
+
 function ParamOption({ param }: ParamProps) {
-  if (param.schema?.type === "array" && param.schema.items?.enum) {
+  const schemaEnum = getSchemaEnum(param.schema);
+  const itemsEnum = getSchemaEnum(param.schema?.items);
+
+  if (param.schema?.type === "array" && itemsEnum) {
     return <ParamMultiSelectFormItem param={param} />;
   }
 
@@ -32,7 +57,7 @@ function ParamOption({ param }: ParamProps) {
     return <ParamArrayFormItem param={param} />;
   }
 
-  if (param.schema?.enum) {
+  if (schemaEnum) {
     return <ParamSelectFormItem param={param} />;
   }