docusaurus-plugin-openapi-docs 0.0.0-1005 → 0.0.0-1007

package/lib/openapi/createRequestExample.js

@@ -36,6 +36,9 @@ const primitives = {
     },
     object: {},
     array: {},
+    null: {
+        default: () => "null",
+    },
 };
 function sampleRequestFromProp(name, prop, obj) {
     // Handle resolved circular props
@@ -144,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));
         }
@@ -189,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

@@ -36,6 +36,9 @@ const primitives = {
     },
     object: {},
     array: {},
+    null: {
+        default: () => "null",
+    },
 };
 function sampleResponseFromProp(name, prop, obj) {
     // Handle resolved circular props
@@ -145,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)];
         }
@@ -190,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/types.d.ts

@@ -1,4 +1,4 @@
-import type { JSONSchema4, JSONSchema6, JSONSchema7 } from "json-schema";
+import type { JSONSchema4, JSONSchema6, JSONSchema7, JSONSchema7TypeName } from "json-schema";
 interface Map<T> {
     [key: string]: T;
 }
@@ -264,8 +264,9 @@ export interface ReferenceObject {
     $ref: string;
 }
 export type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
+export type SchemaType = JSONSchema7TypeName;
 export type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
-    type?: "string" | "number" | "integer" | "boolean" | "object" | "array";
+    type?: SchemaType;
     allOf?: SchemaObject[];
     oneOf?: SchemaObject[];
     anyOf?: SchemaObject[];
@@ -285,7 +286,7 @@ export type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf"
     "x-enumDescriptions"?: Record<string, string>;
 };
 export type SchemaObjectWithRef = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
-    type?: "string" | "number" | "integer" | "boolean" | "object" | "array";
+    type?: SchemaType;
     allOf?: (SchemaObject | ReferenceObject)[];
     oneOf?: (SchemaObject | ReferenceObject)[];
     anyOf?: (SchemaObject | ReferenceObject)[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-1005",
+  "version": "0.0.0-1007",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -65,5 +65,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "4263fa2f5bae006b1d7328a0f16af378786fed47"
+  "gitHead": "864d5355b98d552679472455f533ef15313a0bee"
 }

package/src/openapi/createRequestExample.ts

@@ -18,6 +18,7 @@ interface OASTypeToTypeMap {
   boolean: boolean;
   object: any;
   array: any[];
+  null: string | null;
 }
 
 type Primitives = {
@@ -50,6 +51,9 @@ const primitives: Primitives = {
   },
   object: {},
   array: {},
+  null: {
+    default: () => "null",
+  },
 };
 
 function sampleRequestFromProp(name: string, prop: any, obj: any): any {
@@ -174,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));
@@ -233,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

@@ -18,6 +18,7 @@ interface OASTypeToTypeMap {
   boolean: boolean;
   object: any;
   array: any[];
+  null: string | null;
 }
 
 type Primitives = {
@@ -50,6 +51,9 @@ const primitives: Primitives = {
   },
   object: {},
   array: {},
+  null: {
+    default: () => "null",
+  },
 };
 
 function sampleResponseFromProp(name: string, prop: any, obj: any): any {
@@ -177,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)];
@@ -236,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/types.ts

@@ -5,7 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import type { JSONSchema4, JSONSchema6, JSONSchema7 } from "json-schema";
+import type {
+  JSONSchema4,
+  JSONSchema6,
+  JSONSchema7,
+  JSONSchema7TypeName,
+} from "json-schema";
 
 interface Map<T> {
   [key: string]: T;
@@ -325,6 +330,7 @@ export interface ReferenceObject {
 }
 
 export type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
+export type SchemaType = JSONSchema7TypeName;
 export type SchemaObject = Omit<
   JSONSchema,
   | "type"
@@ -337,7 +343,7 @@ export type SchemaObject = Omit<
   | "additionalProperties"
 > & {
   // OpenAPI specific overrides
-  type?: "string" | "number" | "integer" | "boolean" | "object" | "array";
+  type?: SchemaType;
   allOf?: SchemaObject[];
   oneOf?: SchemaObject[];
   anyOf?: SchemaObject[];
@@ -371,7 +377,7 @@ export type SchemaObjectWithRef = Omit<
   | "additionalProperties"
 > & {
   // OpenAPI specific overrides
-  type?: "string" | "number" | "integer" | "boolean" | "object" | "array";
+  type?: SchemaType;
   allOf?: (SchemaObject | ReferenceObject)[];
   oneOf?: (SchemaObject | ReferenceObject)[];
   anyOf?: (SchemaObject | ReferenceObject)[];