docusaurus-plugin-openapi-docs 1.5.1-hotfix1 → 1.5.2

package/lib/markdown/createResponseSchema.js

@@ -7,6 +7,7 @@
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createResponseSchema = exports.mergeAllOf = void 0;
+const createArrayBracket_1 = require("./createArrayBracket");
 const createDescription_1 = require("./createDescription");
 const createDetails_1 = require("./createDetails");
 const createDetailsSummary_1 = require("./createDetailsSummary");
@@ -47,46 +48,55 @@ exports.mergeAllOf = mergeAllOf;
  */
 function createAnyOneOf(schema) {
     const type = schema.oneOf ? "oneOf" : "anyOf";
-    return (0, utils_1.create)("div", {
+    return (0, utils_1.create)("li", {
         children: [
-            (0, utils_1.create)("div", {
-                children: [
-                    (0, utils_1.create)("span", {
-                        className: "badge badge--info",
-                        children: type,
-                    }),
-                    (0, utils_1.create)("SchemaTabs", {
-                        children: schema[type].map((anyOneSchema, index) => {
-                            const label = anyOneSchema.title
-                                ? anyOneSchema.title
-                                : `MOD${index + 1}`;
-                            const anyOneChildren = [];
-                            if (anyOneSchema.properties !== undefined) {
-                                anyOneChildren.push(createProperties(anyOneSchema));
-                            }
-                            if (anyOneSchema.allOf !== undefined) {
-                                anyOneChildren.push(createNodes(anyOneSchema));
-                            }
-                            if (anyOneSchema.items !== undefined) {
-                                anyOneChildren.push(createItems(anyOneSchema));
-                            }
-                            if (anyOneSchema.type === "string" ||
-                                anyOneSchema.type === "number" ||
-                                anyOneSchema.type === "integer" ||
-                                anyOneSchema.type === "boolean") {
-                                anyOneChildren.push(createNodes(anyOneSchema));
-                            }
-                            if (anyOneChildren.length) {
-                                return (0, utils_1.create)("TabItem", {
-                                    label: label,
-                                    value: `${index}-item-properties`,
-                                    children: anyOneChildren,
-                                });
-                            }
-                            return undefined;
-                        }),
-                    }),
-                ],
+            (0, utils_1.create)("span", {
+                className: "badge badge--info",
+                children: type,
+            }),
+            (0, utils_1.create)("SchemaTabs", {
+                children: schema[type].map((anyOneSchema, index) => {
+                    const label = anyOneSchema.title
+                        ? anyOneSchema.title
+                        : `MOD${index + 1}`;
+                    const anyOneChildren = [];
+                    if (anyOneSchema.properties !== undefined) {
+                        anyOneChildren.push(createProperties(anyOneSchema));
+                    }
+                    if (anyOneSchema.allOf !== undefined) {
+                        anyOneChildren.push(createNodes(anyOneSchema));
+                    }
+                    if (anyOneSchema.items !== undefined) {
+                        anyOneChildren.push(createItems(anyOneSchema));
+                    }
+                    if (anyOneSchema.type === "string" ||
+                        anyOneSchema.type === "number" ||
+                        anyOneSchema.type === "integer" ||
+                        anyOneSchema.type === "boolean") {
+                        anyOneChildren.push(createNodes(anyOneSchema));
+                    }
+                    if (anyOneChildren.length) {
+                        if (schema.type === "array") {
+                            return (0, utils_1.create)("TabItem", {
+                                label: label,
+                                value: `${index}-item-properties`,
+                                children: [
+                                    (0, createArrayBracket_1.createOpeningArrayBracket)(),
+                                    anyOneChildren,
+                                    (0, createArrayBracket_1.createClosingArrayBracket)(),
+                                ]
+                                    .filter(Boolean)
+                                    .flat(),
+                            });
+                        }
+                        return (0, utils_1.create)("TabItem", {
+                            label: label,
+                            value: `${index}-item-properties`,
+                            children: anyOneChildren,
+                        });
+                    }
+                    return undefined;
+                }),
             }),
         ],
     });
@@ -189,15 +199,27 @@ function createAdditionalProperties(schema) {
 }
 // TODO: figure out how to handle array of objects
 function createItems(schema) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
     if (((_a = schema.items) === null || _a === void 0 ? void 0 : _a.properties) !== undefined) {
-        return createProperties(schema.items);
+        return [
+            (0, createArrayBracket_1.createOpeningArrayBracket)(),
+            createProperties(schema.items),
+            (0, createArrayBracket_1.createClosingArrayBracket)(),
+        ].flat();
     }
     if (((_b = schema.items) === null || _b === void 0 ? void 0 : _b.additionalProperties) !== undefined) {
-        return createAdditionalProperties(schema.items);
+        return [
+            (0, createArrayBracket_1.createOpeningArrayBracket)(),
+            createAdditionalProperties(schema.items),
+            (0, createArrayBracket_1.createClosingArrayBracket)(),
+        ].flat();
     }
     if (((_c = schema.items) === null || _c === void 0 ? void 0 : _c.oneOf) !== undefined || ((_d = schema.items) === null || _d === void 0 ? void 0 : _d.anyOf) !== undefined) {
-        return createAnyOneOf(schema.items);
+        return [
+            (0, createArrayBracket_1.createOpeningArrayBracket)(),
+            createAnyOneOf(schema.items),
+            (0, createArrayBracket_1.createClosingArrayBracket)(),
+        ].flat();
     }
     if (((_e = schema.items) === null || _e === void 0 ? void 0 : _e.allOf) !== undefined) {
         // TODO: figure out if and how we should pass merged required array
@@ -206,41 +228,54 @@ function createItems(schema) {
         if ((mergedSchemas.oneOf !== undefined ||
             mergedSchemas.anyOf !== undefined) &&
             mergedSchemas.properties) {
-            return (0, utils_1.create)("div", {
-                children: [
-                    createAnyOneOf(mergedSchemas),
-                    createProperties(mergedSchemas),
-                ],
-            });
+            return [
+                (0, createArrayBracket_1.createOpeningArrayBracket)(),
+                createAnyOneOf(mergedSchemas),
+                createProperties(mergedSchemas),
+                (0, createArrayBracket_1.createClosingArrayBracket)(),
+            ].flat();
         }
         // Handles only anyOf/oneOf
         if (mergedSchemas.oneOf !== undefined ||
             mergedSchemas.anyOf !== undefined) {
-            return (0, utils_1.create)("div", {
-                children: [createAnyOneOf(mergedSchemas)],
-            });
+            return [
+                (0, createArrayBracket_1.createOpeningArrayBracket)(),
+                createAnyOneOf(mergedSchemas),
+                (0, createArrayBracket_1.createClosingArrayBracket)(),
+            ].flat();
         }
         // Handles properties
         if (mergedSchemas.properties !== undefined) {
-            return (0, utils_1.create)("div", {
-                children: [createProperties(mergedSchemas)],
-            });
+            return [
+                (0, createArrayBracket_1.createOpeningArrayBracket)(),
+                createProperties(mergedSchemas),
+                (0, createArrayBracket_1.createClosingArrayBracket)(),
+            ].flat();
         }
     }
     if (((_g = schema.items) === null || _g === void 0 ? void 0 : _g.type) === "string" ||
         ((_h = schema.items) === null || _h === void 0 ? void 0 : _h.type) === "number" ||
         ((_j = schema.items) === null || _j === void 0 ? void 0 : _j.type) === "integer" ||
-        ((_k = schema.items) === null || _k === void 0 ? void 0 : _k.type) === "boolean") {
-        return createNodes(schema.items);
+        ((_k = schema.items) === null || _k === void 0 ? void 0 : _k.type) === "boolean" ||
+        ((_l = schema.items) === null || _l === void 0 ? void 0 : _l.type) === "object") {
+        return [
+            (0, createArrayBracket_1.createOpeningArrayBracket)(),
+            createNodes(schema.items),
+            (0, createArrayBracket_1.createClosingArrayBracket)(),
+        ].flat();
     }
     // TODO: clean this up or eliminate it?
-    return Object.entries(schema.items).map(([key, val]) => createEdges({
-        name: key,
-        schema: val,
-        required: Array.isArray(schema.required)
-            ? schema.required.includes(key)
-            : false,
-    }));
+    return [
+        (0, createArrayBracket_1.createOpeningArrayBracket)(),
+        Object.entries(schema.items).map(([key, val]) => createEdges({
+            name: key,
+            schema: val,
+            required: Array.isArray(schema.required)
+                ? schema.required.includes(key)
+                : false,
+        })),
+        (0, createArrayBracket_1.createClosingArrayBracket)(),
+    ].flat();
 }
 /**
  * For handling discriminators that do not map to a same-level property
@@ -353,6 +388,15 @@ function createDetailsNode(name, schemaName, schema, required) {
                                 style: { opacity: "0.6" },
                                 children: ` ${schemaName}`,
                             }),
+                            (0, utils_1.guard)(schema.nullable && schema.nullable === true, () => [
+                                (0, utils_1.create)("strong", {
+                                    style: {
+                                        fontSize: "var(--ifm-code-font-size)",
+                                        color: "var(--openapi-nullable)",
+                                    },
+                                    children: " nullable",
+                                }),
+                            ]),
                             (0, utils_1.guard)(schema.required && schema.required === true, () => [
                                 (0, utils_1.create)("strong", {
                                     style: {
@@ -479,11 +523,9 @@ function createEdges({ name, schema, required, discriminator, }) {
             collapsible: false,
             name,
             required: false,
-            deprecated: mergedSchemas.deprecated,
-            schemaDescription: mergedSchemas.description,
             schemaName: schemaName,
             qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
-            defaultValue: mergedSchemas.default,
+            schema: mergedSchemas,
         });
     }
     if (schema.properties !== undefined) {
@@ -507,40 +549,43 @@ function createEdges({ name, schema, required, discriminator, }) {
         collapsible: false,
         name,
         required: false,
-        deprecated: schema.deprecated,
-        schemaDescription: schema.description,
         schemaName: schemaName,
         qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
-        defaultValue: schema.default,
+        schema: schema,
     });
 }
 /**
  * Creates a hierarchical level of a schema tree. Nodes produce edges that can branch into sub-nodes with edges, recursively.
  */
 function createNodes(schema) {
+    const nodes = [];
     // if (schema.discriminator !== undefined) {
     //   return createDiscriminator(schema);
     // }
     if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
-        return createAnyOneOf(schema);
+        nodes.push(createAnyOneOf(schema));
     }
     if (schema.allOf !== undefined) {
         const { mergedSchemas } = mergeAllOf(schema.allOf);
-        // allOf seems to always result in properties
         if (mergedSchemas.properties !== undefined) {
-            return createProperties(mergedSchemas);
+            nodes.push(createProperties(mergedSchemas));
+        }
+        if (mergedSchemas.items !== undefined) {
+            nodes.push(createItems(mergedSchemas));
         }
     }
     if (schema.properties !== undefined) {
-        return createProperties(schema);
+        nodes.push(createProperties(schema));
     }
-    // Could be set to false to just check if evals to true
-    if (schema.additionalProperties) {
-        return createAdditionalProperties(schema);
+    if (schema.additionalProperties !== undefined) {
+        nodes.push(createAdditionalProperties(schema));
     }
     // TODO: figure out how to handle array of objects
     if (schema.items !== undefined) {
-        return createItems(schema);
+        nodes.push(createItems(schema));
+    }
+    if (nodes.length && nodes.length > 0) {
+        return nodes.filter(Boolean).flat();
     }
     // primitive
     if (schema.type !== undefined) {
@@ -616,10 +661,6 @@ function createResponseSchema({ title, body, ...rest }) {
                                                         style: { textAlign: "left" },
                                                         children: [
                                                             (0, utils_1.create)("strong", { children: `${title}` }),
-                                                            (0, utils_1.guard)(firstBody.type === "array", (format) => (0, utils_1.create)("span", {
-                                                                style: { opacity: "0.6" },
-                                                                children: ` array`,
-                                                            })),
                                                             (0, utils_1.guard)(body.required && body.required === true, () => [
                                                                 (0, utils_1.create)("strong", {
                                                                     style: {

package/lib/markdown/createStatusCodes.js

@@ -110,12 +110,10 @@ function createResponseExamples(responseExamples, mimeType) {
         language = "xml";
     }
     return Object.entries(responseExamples).map(([exampleName, exampleValue]) => {
-        const camelToSpaceName = exampleName.replace(/([A-Z])/g, " $1");
-        let finalFormattedName = camelToSpaceName.charAt(0).toUpperCase() + camelToSpaceName.slice(1);
         if (typeof exampleValue.value === "object") {
             return (0, utils_1.create)("TabItem", {
-                label: `${finalFormattedName}`,
-                value: `${finalFormattedName}`,
+                label: `${exampleName}`,
+                value: `${exampleName}`,
                 children: [
                     (0, utils_2.guard)(exampleValue.summary, (summary) => [
                         (0, utils_1.create)("p", {
@@ -130,8 +128,8 @@ function createResponseExamples(responseExamples, mimeType) {
             });
         }
         return (0, utils_1.create)("TabItem", {
-            label: `${finalFormattedName}`,
-            value: `${finalFormattedName}`,
+            label: `${exampleName}`,
+            value: `${exampleName}`,
             children: [
                 (0, utils_2.guard)(exampleValue.summary, (summary) => [
                     (0, utils_1.create)("p", {

package/lib/openapi/createRequestExample.js

@@ -11,6 +11,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sampleRequestFromSchema = void 0;
 const chalk_1 = __importDefault(require("chalk"));
+const merge_1 = __importDefault(require("lodash/merge"));
 const createRequestSchema_1 = require("../markdown/createRequestSchema");
 const primitives = {
     string: {
@@ -60,15 +61,27 @@ function sampleRequestFromProp(name, prop, obj) {
 }
 const sampleRequestFromSchema = (schema = {}) => {
     try {
-        let { type, example, allOf, properties, items, oneOf, anyOf } = schema;
+        // deep copy schema before processing
+        let schemaCopy = JSON.parse(JSON.stringify(schema));
+        let { type, example, allOf, properties, items, oneOf, anyOf } = schemaCopy;
         if (example !== undefined) {
             return example;
         }
         if (oneOf) {
+            if (properties) {
+                const combinedSchemas = (0, merge_1.default)(schemaCopy, oneOf[0]);
+                delete combinedSchemas.oneOf;
+                return (0, exports.sampleRequestFromSchema)(combinedSchemas);
+            }
             // Just go with first schema
             return (0, exports.sampleRequestFromSchema)(oneOf[0]);
         }
         if (anyOf) {
+            if (properties) {
+                const combinedSchemas = (0, merge_1.default)(schemaCopy, anyOf[0]);
+                delete combinedSchemas.anyOf;
+                return (0, exports.sampleRequestFromSchema)(combinedSchemas);
+            }
             // Just go with first schema
             return (0, exports.sampleRequestFromSchema)(anyOf[0]);
         }
@@ -81,6 +94,11 @@ const sampleRequestFromSchema = (schema = {}) => {
                     }
                 }
             }
+            if (properties) {
+                const combinedSchemas = (0, merge_1.default)(schemaCopy, mergedSchemas);
+                delete combinedSchemas.allOf;
+                return (0, exports.sampleRequestFromSchema)(combinedSchemas);
+            }
             return (0, exports.sampleRequestFromSchema)(mergedSchemas);
         }
         if (!type) {
@@ -133,16 +151,17 @@ const sampleRequestFromSchema = (schema = {}) => {
             }
             return [(0, exports.sampleRequestFromSchema)(items)];
         }
-        if (schema.enum) {
-            if (schema.default) {
-                return schema.default;
+        if (schemaCopy.enum) {
+            if (schemaCopy.default) {
+                return schemaCopy.default;
             }
-            return normalizeArray(schema.enum)[0];
+            return normalizeArray(schemaCopy.enum)[0];
         }
-        if ((schema.readOnly && schema.readOnly === true) || schema.deprecated) {
+        if ((schema.readOnly && schema.readOnly === true) ||
+            schemaCopy.deprecated) {
             return undefined;
         }
-        return primitive(schema);
+        return primitive(schemaCopy);
     }
     catch (err) {
         console.error(chalk_1.default.yellow("WARNING: failed to create example from schema object:", err));

package/lib/openapi/createResponseExample.js

@@ -11,6 +11,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sampleResponseFromSchema = void 0;
 const chalk_1 = __importDefault(require("chalk"));
+const merge_1 = __importDefault(require("lodash/merge"));
 const createResponseSchema_1 = require("../markdown/createResponseSchema");
 const primitives = {
     string: {
@@ -60,7 +61,9 @@ function sampleResponseFromProp(name, prop, obj) {
 }
 const sampleResponseFromSchema = (schema = {}) => {
     try {
-        let { type, example, allOf, oneOf, anyOf, properties, items } = schema;
+        // deep copy schema before processing
+        let schemaCopy = JSON.parse(JSON.stringify(schema));
+        let { type, example, allOf, properties, items, oneOf, anyOf } = schemaCopy;
         if (example !== undefined) {
             return example;
         }
@@ -74,13 +77,28 @@ const sampleResponseFromSchema = (schema = {}) => {
                     }
                 }
             }
+            if (properties) {
+                const combinedSchemas = (0, merge_1.default)(schemaCopy, mergedSchemas);
+                delete combinedSchemas.allOf;
+                return (0, exports.sampleResponseFromSchema)(combinedSchemas);
+            }
             return (0, exports.sampleResponseFromSchema)(mergedSchemas);
         }
         if (oneOf) {
+            if (properties) {
+                const combinedSchemas = (0, merge_1.default)(schemaCopy, oneOf[0]);
+                delete combinedSchemas.oneOf;
+                return (0, exports.sampleResponseFromSchema)(combinedSchemas);
+            }
             // Just go with first schema
             return (0, exports.sampleResponseFromSchema)(oneOf[0]);
         }
         if (anyOf) {
+            if (properties) {
+                const combinedSchemas = (0, merge_1.default)(schemaCopy, anyOf[0]);
+                delete combinedSchemas.anyOf;
+                return (0, exports.sampleResponseFromSchema)(combinedSchemas);
+            }
             // Just go with first schema
             return (0, exports.sampleResponseFromSchema)(anyOf[0]);
         }
@@ -134,16 +152,17 @@ const sampleResponseFromSchema = (schema = {}) => {
             }
             return [(0, exports.sampleResponseFromSchema)(items)];
         }
-        if (schema.enum) {
-            if (schema.default) {
-                return schema.default;
+        if (schemaCopy.enum) {
+            if (schemaCopy.default) {
+                return schemaCopy.default;
             }
-            return normalizeArray(schema.enum)[0];
+            return normalizeArray(schemaCopy.enum)[0];
         }
-        if ((schema.writeOnly && schema.writeOnly === true) || schema.deprecated) {
+        if ((schemaCopy.writeOnly && schemaCopy.writeOnly === true) ||
+            schemaCopy.deprecated) {
             return undefined;
         }
-        return primitive(schema);
+        return primitive(schemaCopy);
     }
     catch (err) {
         console.error(chalk_1.default.yellow("WARNING: failed to create example from schema object:", err));

package/lib/openapi/utils/loadAndResolveSpec.js

@@ -10,7 +10,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadAndResolveSpec = exports.convertSwagger2OpenAPI = void 0;
-const json_schema_ref_parser_1 = __importDefault(require("@paloaltonetworks/json-schema-ref-parser"));
+const json_schema_ref_parser_1 = __importDefault(require("@apidevtools/json-schema-ref-parser"));
 const openapi_core_1 = require("@redocly/openapi-core");
 const chalk_1 = __importDefault(require("chalk"));
 // @ts-ignore

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "1.5.1-hotfix1",
+  "version": "1.5.2",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -39,7 +39,7 @@
     "utility-types": "^3.10.0"
   },
   "dependencies": {
-    "@paloaltonetworks/json-schema-ref-parser": "0.0.0-dev-hotfix1",
+    "@apidevtools/json-schema-ref-parser": "^9.0.9",
     "@docusaurus/mdx-loader": "^2.0.1",
     "@docusaurus/plugin-content-docs": "^2.0.1",
     "@docusaurus/utils": "^2.0.1",
@@ -67,5 +67,6 @@
   },
   "engines": {
     "node": ">=14"
-  }
+  },
+  "gitHead": "fa3096190356c0161a8e255b9950857a7b131eef"
 }

package/src/markdown/createArrayBracket.ts

@@ -0,0 +1,35 @@
+/* ============================================================================
+ * 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 { create } from "./utils";
+
+export function createOpeningArrayBracket() {
+  return create("li", {
+    children: create("div", {
+      style: {
+        fontSize: "var(--ifm-code-font-size)",
+        opacity: "0.6",
+        marginLeft: "-.5rem",
+        paddingBottom: ".5rem",
+      },
+      children: ["Array ["],
+    }),
+  });
+}
+
+export function createClosingArrayBracket() {
+  return create("li", {
+    children: create("div", {
+      style: {
+        fontSize: "var(--ifm-code-font-size)",
+        opacity: "0.6",
+        marginLeft: "-.5rem",
+      },
+      children: ["]"],
+    }),
+  });
+}