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

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Palo Alto Networks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/markdown/createArrayBracket.d.ts

@@ -0,0 +1,2 @@
+export declare function createOpeningArrayBracket(): string;
+export declare function createClosingArrayBracket(): string;

package/lib/markdown/createArrayBracket.js

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

package/lib/markdown/createRequestSchema.js

@@ -7,6 +7,7 @@
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createRequestSchema = exports.mergeAllOf = void 0;
+const createArrayBracket_1 = require("./createArrayBracket");
 const createDescription_1 = require("./createDescription");
 const createDetails_1 = require("./createDetails");
 const createDetailsSummary_1 = require("./createDetailsSummary");
@@ -46,46 +47,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.filter(Boolean).flat(),
+                        });
+                    }
+                    return undefined;
+                }),
             }),
         ],
     });
@@ -188,15 +198,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
@@ -205,41 +227,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
@@ -352,6 +387,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)(Array.isArray(required)
                                 ? required.includes(name)
                                 : required === true, () => [
@@ -480,11 +524,9 @@ function createEdges({ name, schema, required, discriminator, }) {
             collapsible: false,
             name,
             required: Array.isArray(required) ? required.includes(name) : required,
-            deprecated: mergedSchemas.deprecated,
-            schemaDescription: mergedSchemas.description,
             schemaName: schemaName,
             qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
-            defaultValue: mergedSchemas.default,
+            schema: mergedSchemas,
         });
     }
     if (schema.properties !== undefined) {
@@ -508,39 +550,41 @@ function createEdges({ name, schema, required, discriminator, }) {
         collapsible: false,
         name,
         required: Array.isArray(required) ? required.includes(name) : required,
-        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 (schema.properties !== undefined) {
-        return createProperties(schema);
+        nodes.push(createProperties(schema));
     }
     if (schema.additionalProperties !== undefined) {
-        return createAdditionalProperties(schema);
+        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) {
@@ -603,10 +647,6 @@ function createRequestSchema({ 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: {