docusaurus-plugin-openapi-docs 0.0.0-429 → 0.0.0-433

package/lib/openapi/{createExample.js → createRequestExample.js}

@@ -9,7 +9,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sampleFromSchema = void 0;
+exports.sampleRequestFromSchema = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const createRequestSchema_1 = require("../markdown/createRequestSchema");
 const primitives = {
@@ -36,12 +36,42 @@ const primitives = {
     object: {},
     array: {},
 };
-const sampleFromSchema = (schema = {}) => {
+function sampleRequestFromProp(name, prop, obj) {
+    // Handle resolved circular props
+    if (typeof prop === "object" && Object.keys(prop).length === 0) {
+        obj[name] = prop;
+        return obj;
+    }
+    // TODO: handle discriminators
+    if (prop.oneOf) {
+        obj[name] = (0, exports.sampleRequestFromSchema)(prop.oneOf[0]);
+    }
+    else if (prop.anyOf) {
+        obj[name] = (0, exports.sampleRequestFromSchema)(prop.anyOf[0]);
+    }
+    else if (prop.allOf) {
+        const { mergedSchemas } = (0, createRequestSchema_1.mergeAllOf)(prop.allOf);
+        sampleRequestFromProp(name, mergedSchemas, obj);
+    }
+    else {
+        obj[name] = (0, exports.sampleRequestFromSchema)(prop);
+    }
+    return obj;
+}
+const sampleRequestFromSchema = (schema = {}) => {
     try {
-        let { type, example, allOf, properties, items } = schema;
+        let { type, example, allOf, properties, items, oneOf, anyOf } = schema;
         if (example !== undefined) {
             return example;
         }
+        if (oneOf) {
+            // Just go with first schema
+            return (0, exports.sampleRequestFromSchema)(oneOf[0]);
+        }
+        if (anyOf) {
+            // Just go with first schema
+            return (0, exports.sampleRequestFromSchema)(anyOf[0]);
+        }
         if (allOf) {
             const { mergedSchemas } = (0, createRequestSchema_1.mergeAllOf)(allOf);
             if (mergedSchemas.properties) {
@@ -51,7 +81,7 @@ const sampleFromSchema = (schema = {}) => {
                     }
                 }
             }
-            return (0, exports.sampleFromSchema)(mergedSchemas);
+            return (0, exports.sampleRequestFromSchema)(mergedSchemas);
         }
         if (!type) {
             if (properties) {
@@ -84,18 +114,19 @@ const sampleFromSchema = (schema = {}) => {
                 if (prop.deprecated) {
                     continue;
                 }
-                obj[name] = (0, exports.sampleFromSchema)(prop);
+                // Resolve schema from prop recursively
+                obj = sampleRequestFromProp(name, prop, obj);
             }
             return obj;
         }
         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.sampleFromSchema)(item));
+                return items === null || items === void 0 ? void 0 : items.anyOf.map((item) => (0, exports.sampleRequestFromSchema)(item));
             }
             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.sampleFromSchema)(item));
+                return items === null || items === void 0 ? void 0 : items.oneOf.map((item) => (0, exports.sampleRequestFromSchema)(item));
             }
-            return [(0, exports.sampleFromSchema)(items)];
+            return [(0, exports.sampleRequestFromSchema)(items)];
         }
         if (schema.enum) {
             if (schema.default) {
@@ -113,7 +144,7 @@ const sampleFromSchema = (schema = {}) => {
         return;
     }
 };
-exports.sampleFromSchema = sampleFromSchema;
+exports.sampleRequestFromSchema = sampleRequestFromSchema;
 function primitive(schema = {}) {
     let { type, format } = schema;
     if (type === undefined) {

package/lib/openapi/createResponseExample.d.ts

@@ -0,0 +1,2 @@
+import { SchemaObject } from "./types";
+export declare const sampleResponseFromSchema: (schema?: SchemaObject) => any;

package/lib/openapi/createResponseExample.js

@@ -0,0 +1,167 @@
+"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 });
+exports.sampleResponseFromSchema = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const createRequestSchema_1 = require("../markdown/createRequestSchema");
+const primitives = {
+    string: {
+        default: () => "string",
+        email: () => "user@example.com",
+        date: () => new Date().toISOString().substring(0, 10),
+        "date-time": () => new Date().toISOString().substring(0, 10),
+        uuid: () => "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+        hostname: () => "example.com",
+        ipv4: () => "198.51.100.42",
+        ipv6: () => "2001:0db8:5b96:0000:0000:426f:8e17:642a",
+    },
+    number: {
+        default: () => 0,
+        float: () => 0.0,
+    },
+    integer: {
+        default: () => 0,
+    },
+    boolean: {
+        default: (schema) => typeof schema.default === "boolean" ? schema.default : true,
+    },
+    object: {},
+    array: {},
+};
+function sampleResponseFromProp(name, prop, obj) {
+    // Handle resolved circular props
+    if (typeof prop === "object" && Object.keys(prop).length === 0) {
+        obj[name] = prop;
+        return obj;
+    }
+    // TODO: handle discriminators
+    if (prop.oneOf) {
+        obj[name] = (0, exports.sampleResponseFromSchema)(prop.oneOf[0]);
+    }
+    else if (prop.anyOf) {
+        obj[name] = (0, exports.sampleResponseFromSchema)(prop.anyOf[0]);
+    }
+    else if (prop.allOf) {
+        const { mergedSchemas } = (0, createRequestSchema_1.mergeAllOf)(prop.allOf);
+        sampleResponseFromProp(name, mergedSchemas, obj);
+    }
+    else {
+        obj[name] = (0, exports.sampleResponseFromSchema)(prop);
+    }
+    return obj;
+}
+const sampleResponseFromSchema = (schema = {}) => {
+    try {
+        let { type, example, allOf, oneOf, anyOf, properties, items } = schema;
+        if (example !== undefined) {
+            return example;
+        }
+        if (allOf) {
+            const { mergedSchemas } = (0, createRequestSchema_1.mergeAllOf)(allOf);
+            if (mergedSchemas.properties) {
+                for (const [key, value] of Object.entries(mergedSchemas.properties)) {
+                    if (value.readOnly && value.readOnly === true) {
+                        delete mergedSchemas.properties[key];
+                    }
+                }
+            }
+            return (0, exports.sampleResponseFromSchema)(mergedSchemas);
+        }
+        if (oneOf) {
+            // Just go with first schema
+            return (0, exports.sampleResponseFromSchema)(oneOf[0]);
+        }
+        if (anyOf) {
+            // Just go with first schema
+            return (0, exports.sampleResponseFromSchema)(anyOf[0]);
+        }
+        if (!type) {
+            if (properties) {
+                type = "object";
+            }
+            else if (items) {
+                type = "array";
+            }
+            else {
+                return;
+            }
+        }
+        if (type === "object") {
+            let obj = {};
+            for (let [name, prop] of Object.entries(properties !== null && properties !== void 0 ? properties : {})) {
+                if (prop.properties) {
+                    for (const [key, value] of Object.entries(prop.properties)) {
+                        if (value.readOnly && value.readOnly === true) {
+                            delete prop.properties[key];
+                        }
+                    }
+                }
+                if (prop.items && prop.items.properties) {
+                    for (const [key, value] of Object.entries(prop.items.properties)) {
+                        if (value.readOnly && value.readOnly === true) {
+                            delete prop.items.properties[key];
+                        }
+                    }
+                }
+                if (prop.deprecated) {
+                    continue;
+                }
+                // Resolve schema from prop recursively
+                obj = sampleResponseFromProp(name, prop, obj);
+            }
+            return obj;
+        }
+        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));
+            }
+            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 [(0, exports.sampleResponseFromSchema)(items)];
+        }
+        if (schema.enum) {
+            if (schema.default) {
+                return schema.default;
+            }
+            return normalizeArray(schema.enum)[0];
+        }
+        if (schema.writeOnly && schema.writeOnly === true) {
+            return undefined;
+        }
+        return primitive(schema);
+    }
+    catch (err) {
+        console.error(chalk_1.default.yellow("WARNING: failed to create example from schema object:", err));
+        return;
+    }
+};
+exports.sampleResponseFromSchema = sampleResponseFromSchema;
+function primitive(schema = {}) {
+    let { type, format } = schema;
+    if (type === undefined) {
+        return;
+    }
+    let fn = schema.default ? () => schema.default : primitives[type].default;
+    if (format !== undefined) {
+        fn = primitives[type][format] || fn;
+    }
+    if (fn) {
+        return fn(schema);
+    }
+    return "Unknown Type: " + schema.type;
+}
+function normalizeArray(arr) {
+    if (Array.isArray(arr)) {
+        return arr;
+    }
+    return [arr];
+}

package/lib/openapi/openapi.js

@@ -19,7 +19,7 @@ const fs_extra_1 = __importDefault(require("fs-extra"));
 const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
 const kebabCase_1 = __importDefault(require("lodash/kebabCase"));
 const index_1 = require("../index");
-const createExample_1 = require("./createExample");
+const createRequestExample_1 = require("./createRequestExample");
 const loadAndResolveSpec_1 = require("./utils/loadAndResolveSpec");
 /**
  * Convenience function for converting raw JSON to a Postman Collection object.
@@ -134,7 +134,7 @@ function createItems(openapiData, sidebarOptions) {
             let jsonRequestBodyExample;
             const body = (_o = (_m = operationObject.requestBody) === null || _m === void 0 ? void 0 : _m.content) === null || _o === void 0 ? void 0 : _o["application/json"];
             if (body === null || body === void 0 ? void 0 : body.schema) {
-                jsonRequestBodyExample = (0, createExample_1.sampleFromSchema)(body.schema);
+                jsonRequestBodyExample = (0, createRequestExample_1.sampleRequestFromSchema)(body.schema);
             }
             // Handle vendor JSON media types
             const bodyContent = (_p = operationObject.requestBody) === null || _p === void 0 ? void 0 : _p.content;
@@ -143,7 +143,7 @@ function createItems(openapiData, sidebarOptions) {
                 if (firstBodyContentKey.endsWith("+json")) {
                     const firstBody = bodyContent[firstBodyContentKey];
                     if (firstBody === null || firstBody === void 0 ? void 0 : firstBody.schema) {
-                        jsonRequestBodyExample = (0, createExample_1.sampleFromSchema)(firstBody.schema);
+                        jsonRequestBodyExample = (0, createRequestExample_1.sampleRequestFromSchema)(firstBody.schema);
                     }
                 }
             }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-429",
+  "version": "0.0.0-433",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -59,7 +59,8 @@
     "slugify": "^1.6.5",
     "swagger2openapi": "^7.0.8",
     "url-template": "^3.0.0",
-    "webpack": "^5.61.0"
+    "webpack": "^5.61.0",
+    "xml-formatter": "^2.6.1"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0"
@@ -67,5 +68,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "5e8eda4016c28efed34a740aca4dca0f5450835a"
+  "gitHead": "e3e99aa7627392218adc006b4918390d3efd7b3d"
 }

package/src/markdown/createRequestSchema.ts

@@ -286,106 +286,106 @@ function createItems(schema: SchemaObject) {
 /**
  * For handling discriminators that do not map to a same-level property
  */
-function createDiscriminator(schema: SchemaObject) {
-  const discriminator = schema.discriminator;
-  const propertyName = discriminator?.propertyName;
-  const propertyType = "string"; // should always be string
-  const mapping: any = discriminator?.mapping;
-
-  // Explicit mapping is required since we can't support implicit
-  if (mapping === undefined) {
-    return undefined;
-  }
-
-  // Attempt to get the property description we want to display
-  // TODO: how to make it predictable when handling allOf
-  let propertyDescription;
-  const firstMappingSchema = mapping[Object.keys(mapping)[0]];
-  if (firstMappingSchema.properties !== undefined) {
-    propertyDescription =
-      firstMappingSchema.properties![propertyName!].description;
-  }
-  if (firstMappingSchema.allOf !== undefined) {
-    const { mergedSchemas }: { mergedSchemas: SchemaObject } = mergeAllOf(
-      firstMappingSchema.allOf
-    );
-    if (mergedSchemas.properties !== undefined) {
-      propertyDescription =
-        mergedSchemas.properties[propertyName!]?.description;
-    }
-  }
-
-  if (propertyDescription === undefined) {
-    if (
-      schema.properties !== undefined &&
-      schema.properties![propertyName!] !== undefined
-    ) {
-      propertyDescription = schema.properties![propertyName!].description;
-    }
-  }
-
-  return create("div", {
-    className: "discriminatorItem",
-    children: create("div", {
-      children: [
-        create("strong", {
-          style: { paddingLeft: "1rem" },
-          children: propertyName,
-        }),
-        guard(propertyType, (name) =>
-          create("span", {
-            style: { opacity: "0.6" },
-            children: ` ${propertyType}`,
-          })
-        ),
-        guard(getQualifierMessage(schema.discriminator as any), (message) =>
-          create("div", {
-            style: {
-              paddingLeft: "1rem",
-            },
-            children: createDescription(message),
-          })
-        ),
-        guard(propertyDescription, (description) =>
-          create("div", {
-            style: {
-              paddingLeft: "1rem",
-            },
-            children: createDescription(description),
-          })
-        ),
-        create("DiscriminatorTabs", {
-          children: Object.keys(mapping!).map((key, index) => {
-            if (mapping[key].allOf !== undefined) {
-              const { mergedSchemas }: { mergedSchemas: SchemaObject } =
-                mergeAllOf(mapping[key].allOf);
-              // Cleanup duplicate property from mapping schema
-              delete mergedSchemas.properties![propertyName!];
-              mapping[key] = mergedSchemas;
-            }
-
-            if (mapping[key].properties !== undefined) {
-              // Cleanup duplicate property from mapping schema
-              delete mapping[key].properties![propertyName!];
-            }
-
-            const label = key;
-            return create("TabItem", {
-              label: label,
-              value: `${index}-item-discriminator`,
-              children: [
-                create("div", {
-                  style: { marginLeft: "-4px" },
-                  children: createNodes(mapping[key]),
-                }),
-              ],
-            });
-          }),
-        }),
-      ],
-    }),
-  });
-}
+// function createDiscriminator(schema: SchemaObject) {
+//   const discriminator = schema.discriminator;
+//   const propertyName = discriminator?.propertyName;
+//   const propertyType = "string"; // should always be string
+//   const mapping: any = discriminator?.mapping;
+
+//   // Explicit mapping is required since we can't support implicit
+//   if (mapping === undefined) {
+//     return undefined;
+//   }
+
+//   // Attempt to get the property description we want to display
+//   // TODO: how to make it predictable when handling allOf
+//   let propertyDescription;
+//   const firstMappingSchema = mapping[Object.keys(mapping)[0]];
+//   if (firstMappingSchema.properties !== undefined) {
+//     propertyDescription =
+//       firstMappingSchema.properties![propertyName!].description;
+//   }
+//   if (firstMappingSchema.allOf !== undefined) {
+//     const { mergedSchemas }: { mergedSchemas: SchemaObject } = mergeAllOf(
+//       firstMappingSchema.allOf
+//     );
+//     if (mergedSchemas.properties !== undefined) {
+//       propertyDescription =
+//         mergedSchemas.properties[propertyName!]?.description;
+//     }
+//   }
+
+//   if (propertyDescription === undefined) {
+//     if (
+//       schema.properties !== undefined &&
+//       schema.properties![propertyName!] !== undefined
+//     ) {
+//       propertyDescription = schema.properties![propertyName!].description;
+//     }
+//   }
+
+//   return create("div", {
+//     className: "discriminatorItem",
+//     children: create("div", {
+//       children: [
+//         create("strong", {
+//           style: { paddingLeft: "1rem" },
+//           children: propertyName,
+//         }),
+//         guard(propertyType, (name) =>
+//           create("span", {
+//             style: { opacity: "0.6" },
+//             children: ` ${propertyType}`,
+//           })
+//         ),
+//         guard(getQualifierMessage(schema.discriminator as any), (message) =>
+//           create("div", {
+//             style: {
+//               paddingLeft: "1rem",
+//             },
+//             children: createDescription(message),
+//           })
+//         ),
+//         guard(propertyDescription, (description) =>
+//           create("div", {
+//             style: {
+//               paddingLeft: "1rem",
+//             },
+//             children: createDescription(description),
+//           })
+//         ),
+//         create("DiscriminatorTabs", {
+//           children: Object.keys(mapping!).map((key, index) => {
+//             if (mapping[key].allOf !== undefined) {
+//               const { mergedSchemas }: { mergedSchemas: SchemaObject } =
+//                 mergeAllOf(mapping[key].allOf);
+//               // Cleanup duplicate property from mapping schema
+//               delete mergedSchemas.properties![propertyName!];
+//               mapping[key] = mergedSchemas;
+//             }
+
+//             if (mapping[key].properties !== undefined) {
+//               // Cleanup duplicate property from mapping schema
+//               delete mapping[key].properties![propertyName!];
+//             }
+
+//             const label = key;
+//             return create("TabItem", {
+//               label: label,
+//               value: `${index}-item-discriminator`,
+//               children: [
+//                 create("div", {
+//                   style: { marginLeft: "-4px" },
+//                   children: createNodes(mapping[key]),
+//                 }),
+//               ],
+//             });
+//           }),
+//         }),
+//       ],
+//     }),
+//   });
+// }
 
 function createDetailsNode(
   name: string,
@@ -624,9 +624,9 @@ function createEdges({
  * Creates a hierarchical level of a schema tree. Nodes produce edges that can branch into sub-nodes with edges, recursively.
  */
 function createNodes(schema: SchemaObject): any {
-  if (schema.discriminator !== undefined) {
-    return createDiscriminator(schema);
-  }
+  // if (schema.discriminator !== undefined) {
+  //   return createDiscriminator(schema);
+  // }
 
   if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
     return createAnyOneOf(schema);