docusaurus-plugin-openapi-docs 0.0.0-386 → 0.0.0-390

package/lib/markdown/createAnyOneOf.d.ts

@@ -0,0 +1 @@
+export declare function createAnyOneOf(anyOneOf: any[], type: string): string | undefined;

package/lib/markdown/createAnyOneOf.js

@@ -0,0 +1,84 @@
+"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.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAnyOneOf = void 0;
+const createSchemaDetails_1 = require("./createSchemaDetails");
+const utils_1 = require("./utils");
+// {
+//   'application/json': {
+//     schema: { properties: [Object], required: [Array], type: 'object' }
+//   }
+// }
+// {
+//   'application/json': { schema: { allOf: [Array], example: [Object] } }
+// }
+function createAnyOneOf(anyOneOf, type) {
+    if (anyOneOf === undefined) {
+        return undefined;
+    }
+    if (anyOneOf.length === 0) {
+        return undefined;
+    }
+    return (0, utils_1.create)("div", {
+        children: [
+            (0, utils_1.create)("span", {
+                className: "badge badge--info",
+                children: type,
+            }),
+            (0, utils_1.create)("SchemaTabs", {
+                children: anyOneOf.map((schema, index) => {
+                    // Prep schema details
+                    let schemaDetails = {};
+                    schemaDetails["application/json"] = {}; // Placeholder content type
+                    schemaDetails["application/json"].schema = {};
+                    const label = schema.title ? schema.title : `MOD${index + 1}`;
+                    if (schema.properties !== undefined) {
+                        schemaDetails["application/json"].schema.properties =
+                            schema.properties;
+                        schemaDetails["application/json"].schema.required = schema.required;
+                        schemaDetails["application/json"].schema.type = "object";
+                        return (0, utils_1.create)("TabItem", {
+                            label: label,
+                            value: `${index}-properties`,
+                            children: [
+                                (0, utils_1.create)("div", {
+                                    children: (0, createSchemaDetails_1.createSchemaDetails)({
+                                        title: "Schema",
+                                        body: {
+                                            content: schemaDetails,
+                                        },
+                                    }),
+                                }),
+                            ],
+                        });
+                    }
+                    if (schema.allOf !== undefined) {
+                        schemaDetails["application/json"].schema.allOf = schema.allOf;
+                        schemaDetails["application/json"].schema.example = schema.example;
+                        return (0, utils_1.create)("TabItem", {
+                            label: label,
+                            value: `${index}-allOf`,
+                            children: [
+                                (0, utils_1.create)("div", {
+                                    children: (0, createSchemaDetails_1.createSchemaDetails)({
+                                        title: "Schema",
+                                        body: {
+                                            content: schemaDetails,
+                                        },
+                                    }),
+                                }),
+                            ],
+                        });
+                    }
+                    return undefined;
+                }),
+            }),
+        ],
+    });
+}
+exports.createAnyOneOf = createAnyOneOf;

package/lib/markdown/createSchemaDetails.js

@@ -7,6 +7,7 @@
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createSchemaDetails = void 0;
+const createAnyOneOf_1 = require("./createAnyOneOf");
 const createDescription_1 = require("./createDescription");
 const createDetails_1 = require("./createDetails");
 const createDetailsSummary_1 = require("./createDetailsSummary");
@@ -116,19 +117,21 @@ function createRows({ schema }) {
                     style: { marginBottom: "1rem" },
                     children: "allOf",
                 }),
-                (0, utils_1.create)("ul", {
-                    className: "allOf",
-                    children: Object.entries(properties).map(([key, val]) => createRow({
-                        name: key,
-                        schema: val,
-                        required: Array.isArray(required)
-                            ? required.includes(key)
-                            : false,
-                    })),
-                }),
+                Object.entries(properties).map(([key, val]) => createRow({
+                    name: key,
+                    schema: val,
+                    required: Array.isArray(required) ? required.includes(key) : false,
+                })),
             ],
         });
     }
+    // Adds support one more level deep
+    if (schema.oneOf !== undefined) {
+        return (0, createAnyOneOf_1.createAnyOneOf)(schema.oneOf, "oneOf");
+    }
+    if (schema.anyOf !== undefined) {
+        return (0, createAnyOneOf_1.createAnyOneOf)(schema.anyOf, "anyOf");
+    }
     // array
     if (schema.items !== undefined) {
         return createRows({ schema: schema.items });
@@ -150,11 +153,27 @@ function createRowsRoot({ schema }) {
     // TODO: This can be a bit complicated types can be missmatched and there can be nested allOfs which need to be resolved before merging properties
     if (schema.allOf !== undefined) {
         const { properties, required } = resolveAllOf(schema.allOf);
-        return Object.entries(properties).map(([key, val]) => createRow({
-            name: key,
-            schema: val,
-            required: Array.isArray(required) ? required.includes(key) : false,
-        }));
+        return (0, utils_1.create)("div", {
+            children: [
+                (0, utils_1.create)("span", {
+                    className: "badge badge--info",
+                    style: { marginBottom: "1rem" },
+                    children: "allOf",
+                }),
+                Object.entries(properties).map(([key, val]) => createRow({
+                    name: key,
+                    schema: val,
+                    required: Array.isArray(required) ? required.includes(key) : false,
+                })),
+            ],
+        });
+    }
+    // TODO: This is top-level only - add support for nested oneOf/anyOf
+    if (schema.oneOf !== undefined) {
+        return (0, createAnyOneOf_1.createAnyOneOf)(schema.oneOf, "oneOf");
+    }
+    if (schema.anyOf !== undefined) {
+        return (0, createAnyOneOf_1.createAnyOneOf)(schema.anyOf, "anyOf");
     }
     // array
     if (schema.items !== undefined) {

package/lib/markdown/index.js

@@ -24,6 +24,7 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
         `import ParamsItem from "@theme/ParamsItem";\n`,
         `import SchemaItem from "@theme/SchemaItem"\n`,
         `import ApiTabs from "@theme/ApiTabs";\n`,
+        `import SchemaTabs from "@theme/SchemaTabs";\n`,
         `import TabItem from "@theme/TabItem";\n\n`,
         `## ${(0, lodash_1.escape)(title)}\n\n`,
         (0, createDeprecationNotice_1.createDeprecationNotice)({ deprecated, description: deprecatedDescription }),

package/lib/markdown/utils.d.ts

@@ -1,4 +1,4 @@
-export declare type Children = string | undefined | (string | undefined)[];
+export declare type Children = string | undefined | (string | string[] | undefined)[];
 export declare type Props = Record<string, any> & {
     children?: Children;
 };

package/lib/markdown/utils.js

@@ -26,7 +26,10 @@ function guard(value, cb) {
 exports.guard = guard;
 function render(children) {
     if (Array.isArray(children)) {
-        return children.filter((c) => c !== undefined).join("");
+        const filteredChildren = children.filter((c) => c !== undefined);
+        return filteredChildren
+            .map((i) => (Array.isArray(i) ? i.join("") : i))
+            .join("");
     }
     return children !== null && children !== void 0 ? children : "";
 }

package/lib/openapi/utils/loadAndBundleSpec.js

@@ -21,6 +21,11 @@ async function resolveJsonRefs(specUrlOrObject) {
     try {
         let schema = await json_schema_ref_parser_1.default.dereference(specUrlOrObject, {
             continueOnError: true,
+            resolve: {
+                http: {
+                    timeout: 15000, // 15 sec timeout
+                },
+            },
             dereference: {
                 circular: "ignore",
             },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-386",
+  "version": "0.0.0-390",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -63,5 +63,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "1fcfafd7dbddee666a1c801170a75a0ee26691a0"
+  "gitHead": "0773c12511d7ba04e31ad3420ba9ec084c517690"
 }

package/src/markdown/createAnyOneOf.ts

@@ -0,0 +1,88 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+import { createSchemaDetails } from "./createSchemaDetails";
+import { create } from "./utils";
+
+// {
+//   'application/json': {
+//     schema: { properties: [Object], required: [Array], type: 'object' }
+//   }
+// }
+// {
+//   'application/json': { schema: { allOf: [Array], example: [Object] } }
+// }
+
+export function createAnyOneOf(anyOneOf: any[], type: string) {
+  if (anyOneOf === undefined) {
+    return undefined;
+  }
+
+  if (anyOneOf.length === 0) {
+    return undefined;
+  }
+
+  return create("div", {
+    children: [
+      create("span", {
+        className: "badge badge--info",
+        children: type,
+      }),
+      create("SchemaTabs", {
+        children: anyOneOf.map((schema, index) => {
+          // Prep schema details
+          let schemaDetails: any = {};
+          schemaDetails["application/json"] = {}; // Placeholder content type
+          schemaDetails["application/json"].schema = {};
+          const label = schema.title ? schema.title : `MOD${index + 1}`;
+
+          if (schema.properties !== undefined) {
+            schemaDetails["application/json"].schema.properties =
+              schema.properties;
+            schemaDetails["application/json"].schema.required = schema.required;
+            schemaDetails["application/json"].schema.type = "object";
+            return create("TabItem", {
+              label: label,
+              value: `${index}-properties`,
+              children: [
+                create("div", {
+                  children: createSchemaDetails({
+                    title: "Schema",
+                    body: {
+                      content: schemaDetails,
+                    },
+                  }),
+                }),
+              ],
+            });
+          }
+
+          if (schema.allOf !== undefined) {
+            schemaDetails["application/json"].schema.allOf = schema.allOf;
+            schemaDetails["application/json"].schema.example = schema.example;
+            return create("TabItem", {
+              label: label,
+              value: `${index}-allOf`,
+              children: [
+                create("div", {
+                  children: createSchemaDetails({
+                    title: "Schema",
+                    body: {
+                      content: schemaDetails,
+                    },
+                  }),
+                }),
+              ],
+            });
+          }
+
+          return undefined;
+        }),
+      }),
+    ],
+  });
+}

package/src/markdown/createSchemaDetails.ts

@@ -6,6 +6,7 @@
  * ========================================================================== */
 
 import { MediaTypeObject, SchemaObject } from "../openapi/types";
+import { createAnyOneOf } from "./createAnyOneOf";
 import { createDescription } from "./createDescription";
 import { createDetails } from "./createDetails";
 import { createDetailsSummary } from "./createDetailsSummary";
@@ -140,22 +141,26 @@ function createRows({ schema }: RowsProps): string | undefined {
           style: { marginBottom: "1rem" },
           children: "allOf",
         }),
-        create("ul", {
-          className: "allOf",
-          children: Object.entries(properties).map(([key, val]) =>
-            createRow({
-              name: key,
-              schema: val,
-              required: Array.isArray(required)
-                ? required.includes(key)
-                : false,
-            })
-          ),
-        }),
+        Object.entries(properties).map(([key, val]) =>
+          createRow({
+            name: key,
+            schema: val,
+            required: Array.isArray(required) ? required.includes(key) : false,
+          })
+        ),
       ],
     });
   }
 
+  // Adds support one more level deep
+  if (schema.oneOf !== undefined) {
+    return createAnyOneOf(schema.oneOf, "oneOf");
+  }
+
+  if (schema.anyOf !== undefined) {
+    return createAnyOneOf(schema.anyOf, "anyOf");
+  }
+
   // array
   if (schema.items !== undefined) {
     return createRows({ schema: schema.items });
@@ -169,7 +174,7 @@ interface RowsRootProps {
   schema: SchemaObject;
 }
 
-function createRowsRoot({ schema }: RowsRootProps) {
+function createRowsRoot({ schema }: RowsRootProps): any {
   // object
   if (schema.properties !== undefined) {
     return Object.entries(schema.properties).map(([key, val]) =>
@@ -186,13 +191,31 @@ function createRowsRoot({ schema }: RowsRootProps) {
   // TODO: This can be a bit complicated types can be missmatched and there can be nested allOfs which need to be resolved before merging properties
   if (schema.allOf !== undefined) {
     const { properties, required } = resolveAllOf(schema.allOf);
-    return Object.entries(properties).map(([key, val]) =>
-      createRow({
-        name: key,
-        schema: val,
-        required: Array.isArray(required) ? required.includes(key) : false,
-      })
-    );
+    return create("div", {
+      children: [
+        create("span", {
+          className: "badge badge--info",
+          style: { marginBottom: "1rem" },
+          children: "allOf",
+        }),
+        Object.entries(properties).map(([key, val]) =>
+          createRow({
+            name: key,
+            schema: val,
+            required: Array.isArray(required) ? required.includes(key) : false,
+          })
+        ),
+      ],
+    });
+  }
+
+  // TODO: This is top-level only - add support for nested oneOf/anyOf
+  if (schema.oneOf !== undefined) {
+    return createAnyOneOf(schema.oneOf, "oneOf");
+  }
+
+  if (schema.anyOf !== undefined) {
+    return createAnyOneOf(schema.anyOf, "anyOf");
   }
 
   // array

package/src/markdown/index.ts

@@ -40,6 +40,7 @@ export function createApiPageMD({
     `import ParamsItem from "@theme/ParamsItem";\n`,
     `import SchemaItem from "@theme/SchemaItem"\n`,
     `import ApiTabs from "@theme/ApiTabs";\n`,
+    `import SchemaTabs from "@theme/SchemaTabs";\n`,
     `import TabItem from "@theme/TabItem";\n\n`,
     `## ${escape(title)}\n\n`,
     createDeprecationNotice({ deprecated, description: deprecatedDescription }),

package/src/markdown/utils.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-export type Children = string | undefined | (string | undefined)[];
+export type Children = string | undefined | (string | string[] | undefined)[];
 
 export type Props = Record<string, any> & { children?: Children };
 
@@ -33,7 +33,10 @@ export function guard<T>(
 
 export function render(children: Children): string {
   if (Array.isArray(children)) {
-    return children.filter((c) => c !== undefined).join("");
+    const filteredChildren = children.filter((c) => c !== undefined);
+    return filteredChildren
+      .map((i: any) => (Array.isArray(i) ? i.join("") : i))
+      .join("");
   }
   return children ?? "";
 }

package/src/openapi/utils/loadAndBundleSpec.ts

@@ -21,6 +21,11 @@ async function resolveJsonRefs(specUrlOrObject: object | string) {
   try {
     let schema = await $RefParser.dereference(specUrlOrObject, {
       continueOnError: true,
+      resolve: {
+        http: {
+          timeout: 15000, // 15 sec timeout
+        },
+      },
       dereference: {
         circular: "ignore",
       },