docusaurus-plugin-openapi-docs 0.0.0-1006 → 0.0.0-1008

package/lib/openapi/createRequestExample.js

@@ -147,10 +147,10 @@ const sampleRequestFromSchema = (schema = {}) => {
         }
         if (type === "array") {
             if (Array.isArray(items === null || items === void 0 ? void 0 : items.anyOf)) {
-                return items === null || items === void 0 ? void 0 : items.anyOf.map((item) => (0, exports.sampleRequestFromSchema)(item));
+                return processArrayItems(items, "anyOf");
             }
             if (Array.isArray(items === null || items === void 0 ? void 0 : items.oneOf)) {
-                return items === null || items === void 0 ? void 0 : items.oneOf.map((item) => (0, exports.sampleRequestFromSchema)(item));
+                return processArrayItems(items, "oneOf");
             }
             return normalizeArray((0, exports.sampleRequestFromSchema)(items));
         }
@@ -192,3 +192,22 @@ function normalizeArray(arr) {
     }
     return [arr];
 }
+function processArrayItems(items, schemaType) {
+    const itemsArray = items[schemaType];
+    return itemsArray.map((item) => {
+        // If items has properties, merge them with each item
+        if (items.properties) {
+            const combinedSchema = {
+                ...item,
+                properties: {
+                    ...items.properties, // Common properties from parent
+                    ...item.properties, // Specific properties from this anyOf/oneOf item
+                },
+            };
+            // Remove anyOf/oneOf to prevent infinite recursion when calling sampleRequestFromSchema
+            delete combinedSchema[schemaType];
+            return (0, exports.sampleRequestFromSchema)(combinedSchema);
+        }
+        return (0, exports.sampleRequestFromSchema)(item);
+    });
+}

package/lib/openapi/createResponseExample.js

@@ -148,10 +148,10 @@ const sampleResponseFromSchema = (schema = {}) => {
         }
         if (type === "array") {
             if (Array.isArray(items === null || items === void 0 ? void 0 : items.anyOf)) {
-                return items === null || items === void 0 ? void 0 : items.anyOf.map((item) => (0, exports.sampleResponseFromSchema)(item));
+                return processArrayItems(items, "anyOf");
             }
             if (Array.isArray(items === null || items === void 0 ? void 0 : items.oneOf)) {
-                return items === null || items === void 0 ? void 0 : items.oneOf.map((item) => (0, exports.sampleResponseFromSchema)(item));
+                return processArrayItems(items, "oneOf");
             }
             return [(0, exports.sampleResponseFromSchema)(items)];
         }
@@ -193,3 +193,22 @@ function normalizeArray(arr) {
     }
     return [arr];
 }
+function processArrayItems(items, schemaType) {
+    const itemsArray = items[schemaType];
+    return itemsArray.map((item) => {
+        // If items has properties, merge them with each item
+        if (items.properties) {
+            const combinedSchema = {
+                ...item,
+                properties: {
+                    ...items.properties, // Common properties from parent
+                    ...item.properties, // Specific properties from this anyOf/oneOf item
+                },
+            };
+            // Remove anyOf/oneOf to prevent infinite recursion when calling sampleResponseFromSchema
+            delete combinedSchema[schemaType];
+            return (0, exports.sampleResponseFromSchema)(combinedSchema);
+        }
+        return (0, exports.sampleResponseFromSchema)(item);
+    });
+}

package/lib/openapi/openapi.js

@@ -211,6 +211,7 @@ function createItems(openapiData, options, sidebarOptions) {
                     jsonRequestBodyExample,
                     info: openapiData.info,
                 },
+                position: operationObject["x-position"],
             };
             items.push(apiPage);
         }
@@ -406,6 +407,21 @@ function createItems(openapiData, options, sidebarOptions) {
             items.push(tagPage);
         });
     }
+    items.sort((a, b) => {
+        // Items with position come first, sorted by position
+        if (a.position !== undefined && b.position !== undefined) {
+            return a.position - b.position;
+        }
+        // Items with position come before items without position
+        if (a.position !== undefined) {
+            return -1;
+        }
+        if (b.position !== undefined) {
+            return 1;
+        }
+        // If neither has position, maintain original order
+        return 0;
+    });
     return items;
 }
 /**

package/lib/openapi/types.d.ts

@@ -128,6 +128,7 @@ export interface OperationObject {
     deprecated?: boolean;
     security?: SecurityRequirementObject[];
     servers?: ServerObject[];
+    "x-position"?: number;
     "x-deprecated-description"?: string;
 }
 export interface OperationObjectWithRef {

package/lib/openapi/utils/types.d.ts

@@ -76,6 +76,7 @@ export interface OpenAPIOperation {
     servers?: OpenAPIServer[];
     "x-codeSamples"?: OpenAPIXCodeSample[];
     "x-code-samples"?: OpenAPIXCodeSample[];
+    "x-position"?: number;
 }
 export interface OpenAPIParameter {
     name: string;

package/lib/types.d.ts

@@ -85,6 +85,7 @@ export interface ApiMetadataBase {
     frontMatter: Record<string, unknown>;
     method?: string;
     path?: string;
+    position?: number;
 }
 export interface ApiPageMetadata extends ApiMetadataBase {
     json?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-1006",
+  "version": "0.0.0-1008",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -65,5 +65,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "e73c0b0cead279cb3771b546adc1caebabf336ae"
+  "gitHead": "d50a1409c5b6097064616bac66c5a079431c61de"
 }

package/src/openapi/createRequestExample.ts

@@ -178,11 +178,11 @@ export const sampleRequestFromSchema = (schema: SchemaObject = {}): any => {
 
     if (type === "array") {
       if (Array.isArray(items?.anyOf)) {
-        return items?.anyOf.map((item: any) => sampleRequestFromSchema(item));
+        return processArrayItems(items, "anyOf");
       }
 
       if (Array.isArray(items?.oneOf)) {
-        return items?.oneOf.map((item: any) => sampleRequestFromSchema(item));
+        return processArrayItems(items, "oneOf");
       }
 
       return normalizeArray(sampleRequestFromSchema(items));
@@ -237,3 +237,26 @@ function normalizeArray(arr: any) {
   }
   return [arr];
 }
+
+function processArrayItems(
+  items: SchemaObject,
+  schemaType: "anyOf" | "oneOf"
+): any[] {
+  const itemsArray = items[schemaType] as SchemaObject[];
+  return itemsArray.map((item: SchemaObject) => {
+    // If items has properties, merge them with each item
+    if (items.properties) {
+      const combinedSchema = {
+        ...item,
+        properties: {
+          ...items.properties, // Common properties from parent
+          ...item.properties, // Specific properties from this anyOf/oneOf item
+        },
+      };
+      // Remove anyOf/oneOf to prevent infinite recursion when calling sampleRequestFromSchema
+      delete combinedSchema[schemaType];
+      return sampleRequestFromSchema(combinedSchema);
+    }
+    return sampleRequestFromSchema(item);
+  });
+}

package/src/openapi/createResponseExample.ts

@@ -181,11 +181,11 @@ export const sampleResponseFromSchema = (schema: SchemaObject = {}): any => {
 
     if (type === "array") {
       if (Array.isArray(items?.anyOf)) {
-        return items?.anyOf.map((item: any) => sampleResponseFromSchema(item));
+        return processArrayItems(items, "anyOf");
       }
 
       if (Array.isArray(items?.oneOf)) {
-        return items?.oneOf.map((item: any) => sampleResponseFromSchema(item));
+        return processArrayItems(items, "oneOf");
       }
 
       return [sampleResponseFromSchema(items)];
@@ -240,3 +240,26 @@ function normalizeArray(arr: any) {
   }
   return [arr];
 }
+
+function processArrayItems(
+  items: SchemaObject,
+  schemaType: "anyOf" | "oneOf"
+): any[] {
+  const itemsArray = items[schemaType] as SchemaObject[];
+  return itemsArray.map((item: SchemaObject) => {
+    // If items has properties, merge them with each item
+    if (items.properties) {
+      const combinedSchema = {
+        ...item,
+        properties: {
+          ...items.properties, // Common properties from parent
+          ...item.properties, // Specific properties from this anyOf/oneOf item
+        },
+      };
+      // Remove anyOf/oneOf to prevent infinite recursion when calling sampleResponseFromSchema
+      delete combinedSchema[schemaType];
+      return sampleResponseFromSchema(combinedSchema);
+    }
+    return sampleResponseFromSchema(item);
+  });
+}

package/src/openapi/openapi.ts

@@ -263,6 +263,7 @@ function createItems(
           jsonRequestBodyExample,
           info: openapiData.info,
         },
+        position: operationObject["x-position"] as number | undefined,
       };
 
       items.push(apiPage);
@@ -509,6 +510,22 @@ function createItems(
       });
   }
 
+  items.sort((a, b) => {
+    // Items with position come first, sorted by position
+    if (a.position !== undefined && b.position !== undefined) {
+      return a.position - b.position;
+    }
+    // Items with position come before items without position
+    if (a.position !== undefined) {
+      return -1;
+    }
+    if (b.position !== undefined) {
+      return 1;
+    }
+    // If neither has position, maintain original order
+    return 0;
+  });
+
   return items as ApiMetadata[];
 }
 

package/src/openapi/types.ts

@@ -156,8 +156,8 @@ export interface OperationObject {
   deprecated?: boolean;
   security?: SecurityRequirementObject[];
   servers?: ServerObject[];
-
   // extensions
+  "x-position"?: number;
   "x-deprecated-description"?: string;
 }
 

package/src/openapi/utils/types.ts

@@ -89,6 +89,7 @@ export interface OpenAPIOperation {
   servers?: OpenAPIServer[];
   "x-codeSamples"?: OpenAPIXCodeSample[];
   "x-code-samples"?: OpenAPIXCodeSample[]; // deprecated
+  "x-position"?: number;
 }
 
 export interface OpenAPIParameter {

package/src/types.ts

@@ -118,6 +118,7 @@ export interface ApiMetadataBase {
   frontMatter: Record<string, unknown>;
   method?: string;
   path?: string;
+  position?: number;
 }
 
 export interface ApiPageMetadata extends ApiMetadataBase {