docusaurus-plugin-openapi-docs 1.1.8 → 1.1.11

package/lib/markdown/createResponseSchema.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createResponseSchema = void 0;
+exports.createResponseSchema = exports.mergeAllOf = void 0;
 const createDescription_1 = require("./createDescription");
 const createDetails_1 = require("./createDetails");
 const createDetailsSummary_1 = require("./createDetailsSummary");
@@ -27,6 +27,7 @@ function mergeAllOf(allOf) {
                 return true;
             },
         },
+        ignoreAdditionalProperties: true,
     });
     const required = allOf.reduce((acc, cur) => {
         if (Array.isArray(cur.required)) {
@@ -37,6 +38,7 @@ function mergeAllOf(allOf) {
     }, []);
     return { mergedSchemas, required };
 }
+exports.mergeAllOf = mergeAllOf;
 /**
  * For handling nested anyOf/oneOf.
  */
@@ -235,90 +237,100 @@ function createItems(schema) {
 /**
  * For handling discriminators that do not map to a same-level property
  */
-function createDiscriminator(schema) {
-    var _a;
-    const discriminator = schema.discriminator;
-    const propertyName = discriminator === null || discriminator === void 0 ? void 0 : discriminator.propertyName;
-    const propertyType = "string"; // should always be string
-    const mapping = discriminator === null || discriminator === void 0 ? void 0 : 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 } = mergeAllOf(firstMappingSchema.allOf);
-        if (mergedSchemas.properties !== undefined) {
-            propertyDescription =
-                (_a = mergedSchemas.properties[propertyName]) === null || _a === void 0 ? void 0 : _a.description;
-        }
-    }
-    if (propertyDescription === undefined) {
-        if (schema.properties !== undefined &&
-            schema.properties[propertyName] !== undefined) {
-            propertyDescription = schema.properties[propertyName].description;
-        }
-    }
-    return (0, utils_1.create)("div", {
-        className: "discriminatorItem",
-        children: (0, utils_1.create)("div", {
-            children: [
-                (0, utils_1.create)("strong", {
-                    style: { paddingLeft: "1rem" },
-                    children: propertyName,
-                }),
-                (0, utils_1.guard)(propertyType, (name) => (0, utils_1.create)("span", {
-                    style: { opacity: "0.6" },
-                    children: ` ${propertyType}`,
-                })),
-                (0, utils_1.guard)((0, schema_1.getQualifierMessage)(schema.discriminator), (message) => (0, utils_1.create)("div", {
-                    style: {
-                        paddingLeft: "1rem",
-                    },
-                    children: (0, createDescription_1.createDescription)(message),
-                })),
-                (0, utils_1.guard)(propertyDescription, (description) => (0, utils_1.create)("div", {
-                    style: {
-                        paddingLeft: "1rem",
-                    },
-                    children: (0, createDescription_1.createDescription)(description),
-                })),
-                (0, utils_1.create)("DiscriminatorTabs", {
-                    children: Object.keys(mapping).map((key, index) => {
-                        if (mapping[key].allOf !== undefined) {
-                            const { mergedSchemas } = 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 (0, utils_1.create)("TabItem", {
-                            label: label,
-                            value: `${index}-item-discriminator`,
-                            children: [
-                                (0, utils_1.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, schemaName, schema, required) {
     return (0, utils_1.create)("SchemaItem", {
         collapsible: true,
@@ -493,9 +505,9 @@ function createEdges({ name, schema, required, discriminator, }) {
  * Creates a hierarchical level of a schema tree. Nodes produce edges that can branch into sub-nodes with edges, recursively.
  */
 function createNodes(schema) {
-    if (schema.discriminator !== undefined) {
-        return createDiscriminator(schema);
-    }
+    // if (schema.discriminator !== undefined) {
+    //   return createDiscriminator(schema);
+    // }
     if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
         return createAnyOneOf(schema);
     }
@@ -627,8 +639,11 @@ function createResponseSchema({ title, body, ...rest }) {
                                             }),
                                         ],
                                     }),
-                                responseExamples && (0, createStatusCodes_1.createResponseExamples)(responseExamples),
-                                responseExample && (0, createStatusCodes_1.createResponseExample)(responseExample),
+                                firstBody && (0, createStatusCodes_1.createExampleFromSchema)(firstBody, mimeType),
+                                responseExamples &&
+                                    (0, createStatusCodes_1.createResponseExamples)(responseExamples, mimeType),
+                                responseExample &&
+                                    (0, createStatusCodes_1.createResponseExample)(responseExample, mimeType),
                             ],
                         }),
                     ],

package/lib/markdown/createStatusCodes.d.ts

@@ -1,8 +1,10 @@
 import { ApiItem } from "../types";
+export default function json2xml(o: any, tab: any): string;
 interface Props {
     responses: ApiItem["responses"];
 }
-export declare function createResponseExamples(responseExamples: any): string[];
-export declare function createResponseExample(responseExample: any): string;
+export declare function createResponseExamples(responseExamples: any, mimeType: string): string[];
+export declare function createResponseExample(responseExample: any, mimeType: string): string;
+export declare function createExampleFromSchema(schema: any, mimeType: string): string | undefined;
 export declare function createStatusCodes({ responses }: Props): string | undefined;
 export {};

package/lib/markdown/createStatusCodes.js

@@ -5,14 +5,62 @@
  * 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.createStatusCodes = exports.createResponseExample = exports.createResponseExamples = void 0;
+exports.createStatusCodes = exports.createExampleFromSchema = exports.createResponseExample = exports.createResponseExamples = void 0;
+const xml_formatter_1 = __importDefault(require("xml-formatter"));
+const createResponseExample_1 = require("../openapi/createResponseExample");
 const createDescription_1 = require("./createDescription");
 const createDetails_1 = require("./createDetails");
 const createDetailsSummary_1 = require("./createDetailsSummary");
 const createResponseSchema_1 = require("./createResponseSchema");
 const utils_1 = require("./utils");
 const utils_2 = require("./utils");
+function json2xml(o, tab) {
+    var toXml = function (v, name, ind) {
+        var xml = "";
+        if (v instanceof Array) {
+            for (var i = 0, n = v.length; i < n; i++)
+                xml += ind + toXml(v[i], name, ind + "\t") + "\n";
+        }
+        else if (typeof v == "object") {
+            var hasChild = false;
+            xml += ind + "<" + name;
+            for (var m in v) {
+                if (m.charAt(0) === "@")
+                    xml += " " + m.substr(1) + '="' + v[m].toString() + '"';
+                else
+                    hasChild = true;
+            }
+            xml += hasChild ? ">" : "/>";
+            if (hasChild) {
+                for (var m2 in v) {
+                    if (m2 === "#text")
+                        xml += v[m2];
+                    else if (m2 === "#cdata")
+                        xml += "<![CDATA[" + v[m2] + "]]>";
+                    else if (m2.charAt(0) !== "@")
+                        xml += toXml(v[m2], m2, ind + "\t");
+                }
+                xml +=
+                    (xml.charAt(xml.length - 1) === "\n" ? ind : "") +
+                        "</" +
+                        name +
+                        ">";
+            }
+        }
+        else {
+            xml += ind + "<" + name + ">" + v.toString() + "</" + name + ">";
+        }
+        return xml;
+    }, xml = "";
+    for (var m3 in o)
+        xml += toXml(o[m3], m3, "");
+    return tab ? xml.replace(/\t/g, tab) : xml.replace(/\t|\n/g, "");
+}
+exports.default = json2xml;
 function createResponseHeaders(responseHeaders) {
     return (0, utils_2.guard)(responseHeaders, () => (0, utils_1.create)("ul", {
         style: { marginLeft: "1rem" },
@@ -53,7 +101,14 @@ function createResponseHeaders(responseHeaders) {
         ],
     }));
 }
-function createResponseExamples(responseExamples) {
+function createResponseExamples(responseExamples, mimeType) {
+    let language = "shell";
+    if (mimeType.endsWith("json")) {
+        language = "json";
+    }
+    if (mimeType.endsWith("xml")) {
+        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);
@@ -64,6 +119,7 @@ function createResponseExamples(responseExamples) {
                 children: [
                     (0, utils_1.create)("ResponseSamples", {
                         responseExample: JSON.stringify(exampleValue.value, null, 2),
+                        language: language,
                     }),
                 ],
             });
@@ -74,13 +130,21 @@ function createResponseExamples(responseExamples) {
             children: [
                 (0, utils_1.create)("ResponseSamples", {
                     responseExample: exampleValue.value,
+                    language: language,
                 }),
             ],
         });
     });
 }
 exports.createResponseExamples = createResponseExamples;
-function createResponseExample(responseExample) {
+function createResponseExample(responseExample, mimeType) {
+    let language = "shell";
+    if (mimeType.endsWith("json")) {
+        language = "json";
+    }
+    if (mimeType.endsWith("xml")) {
+        language = "xml";
+    }
     if (typeof responseExample === "object") {
         return (0, utils_1.create)("TabItem", {
             label: `Example`,
@@ -88,6 +152,7 @@ function createResponseExample(responseExample) {
             children: [
                 (0, utils_1.create)("ResponseSamples", {
                     responseExample: JSON.stringify(responseExample, null, 2),
+                    language: language,
                 }),
             ],
         });
@@ -98,11 +163,71 @@ function createResponseExample(responseExample) {
         children: [
             (0, utils_1.create)("ResponseSamples", {
                 responseExample: responseExample,
+                language: language,
             }),
         ],
     });
 }
 exports.createResponseExample = createResponseExample;
+function createExampleFromSchema(schema, mimeType) {
+    const responseExample = (0, createResponseExample_1.sampleResponseFromSchema)(schema);
+    if (mimeType.endsWith("xml")) {
+        let responseExampleObject;
+        try {
+            responseExampleObject = JSON.parse(JSON.stringify(responseExample));
+        }
+        catch {
+            return undefined;
+        }
+        if (typeof responseExampleObject === "object") {
+            let xmlExample;
+            try {
+                xmlExample = (0, xml_formatter_1.default)(json2xml(responseExampleObject, ""), {
+                    indentation: "  ",
+                    lineSeparator: "\n",
+                    collapseContent: true,
+                });
+            }
+            catch {
+                const xmlExampleWithRoot = { root: responseExampleObject };
+                try {
+                    xmlExample = (0, xml_formatter_1.default)(json2xml(xmlExampleWithRoot, ""), {
+                        indentation: "  ",
+                        lineSeparator: "\n",
+                        collapseContent: true,
+                    });
+                }
+                catch {
+                    xmlExample = json2xml(responseExampleObject, "");
+                }
+            }
+            return (0, utils_1.create)("TabItem", {
+                label: `Example (from schema)`,
+                value: `Example (from schema)`,
+                children: [
+                    (0, utils_1.create)("ResponseSamples", {
+                        responseExample: xmlExample,
+                        language: "xml",
+                    }),
+                ],
+            });
+        }
+    }
+    if (typeof responseExample === "object") {
+        return (0, utils_1.create)("TabItem", {
+            label: `Example (from schema)`,
+            value: `Example (from schema)`,
+            children: [
+                (0, utils_1.create)("ResponseSamples", {
+                    responseExample: JSON.stringify(responseExample, null, 2),
+                    language: "json",
+                }),
+            ],
+        });
+    }
+    return undefined;
+}
+exports.createExampleFromSchema = createExampleFromSchema;
 function createStatusCodes({ responses }) {
     if (responses === undefined) {
         return undefined;
@@ -127,8 +252,8 @@ function createStatusCodes({ responses }) {
                             }),
                             responseHeaders &&
                                 (0, createDetails_1.createDetails)({
-                                    "data-collaposed": false,
-                                    open: true,
+                                    "data-collaposed": true,
+                                    open: false,
                                     style: { textAlign: "left", marginBottom: "1rem" },
                                     children: [
                                         (0, createDetailsSummary_1.createDetailsSummary)({

package/lib/openapi/createRequestExample.d.ts

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

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;