docusaurus-plugin-openapi-docs 4.1.0 → 4.2.0

package/lib/markdown/createStatusCodes.js

@@ -5,19 +5,9 @@
  * 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.createExampleFromSchema = exports.createResponseExample = exports.createResponseExamples = void 0;
-const xml_formatter_1 = __importDefault(require("xml-formatter"));
-const createDescription_1 = require("./createDescription");
-const createDetails_1 = require("./createDetails");
-const createDetailsSummary_1 = require("./createDetailsSummary");
-const createResponseSchema_1 = require("./createResponseSchema");
+exports.createStatusCodes = void 0;
 const utils_1 = require("./utils");
-const utils_2 = require("./utils");
-const createResponseExample_1 = require("../openapi/createResponseExample");
 function json2xml(o, tab) {
     var toXml = function (v, name, ind) {
         var xml = "";
@@ -61,253 +51,14 @@ function json2xml(o, tab) {
     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" },
-        children: [
-            Object.entries(responseHeaders).map(([headerName, headerObj]) => {
-                var _a, _b;
-                const { description, example } = headerObj;
-                const type = (_b = (_a = headerObj.schema) === null || _a === void 0 ? void 0 : _a.type) !== null && _b !== void 0 ? _b : "any";
-                return (0, utils_1.create)("li", {
-                    className: "schemaItem",
-                    children: [
-                        (0, createDetailsSummary_1.createDetailsSummary)({
-                            children: [
-                                (0, utils_1.create)("strong", { children: headerName }),
-                                (0, utils_2.guard)(type, () => [
-                                    (0, utils_1.create)("span", {
-                                        style: { opacity: "0.6" },
-                                        children: ` ${type}`,
-                                    }),
-                                ]),
-                            ],
-                        }),
-                        (0, utils_1.create)("div", {
-                            children: [
-                                (0, utils_2.guard)(description, (description) => (0, utils_1.create)("div", {
-                                    style: {
-                                        marginTop: ".5rem",
-                                        marginBottom: ".5rem",
-                                    },
-                                    children: [
-                                        (0, utils_2.guard)(example, () => `Example: ${example}`),
-                                        (0, createDescription_1.createDescription)(description),
-                                    ],
-                                })),
-                            ],
-                        }),
-                    ],
-                });
-            }),
-        ],
-    }));
-}
-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]) => {
-        if (typeof exampleValue.value === "object") {
-            return (0, utils_1.create)("TabItem", {
-                label: `${exampleName}`,
-                value: `${exampleName}`,
-                children: [
-                    (0, utils_2.guard)(exampleValue.summary, (summary) => [
-                        (0, utils_1.create)("div", {
-                            children: `${summary}`,
-                            className: "openapi-example__summary",
-                        }),
-                    ]),
-                    (0, utils_1.create)("ResponseSamples", {
-                        responseExample: JSON.stringify(exampleValue.value, null, 2),
-                        language: language,
-                    }),
-                ],
-            });
-        }
-        return (0, utils_1.create)("TabItem", {
-            label: `${exampleName}`,
-            value: `${exampleName}`,
-            children: [
-                (0, utils_2.guard)(exampleValue.summary, (summary) => [
-                    (0, utils_1.create)("div", {
-                        children: `${summary}`,
-                        className: "openapi-example__summary",
-                    }),
-                ]),
-                (0, utils_1.create)("ResponseSamples", {
-                    responseExample: exampleValue.value,
-                    language: language,
-                }),
-            ],
-        });
-    });
-}
-exports.createResponseExamples = createResponseExamples;
-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`,
-            value: `Example`,
-            children: [
-                (0, utils_2.guard)(responseExample.summary, (summary) => [
-                    (0, utils_1.create)("div", {
-                        children: `${summary}`,
-                        className: "openapi-example__summary",
-                    }),
-                ]),
-                (0, utils_1.create)("ResponseSamples", {
-                    responseExample: JSON.stringify(responseExample, null, 2),
-                    language: language,
-                }),
-            ],
-        });
-    }
-    return (0, utils_1.create)("TabItem", {
-        label: `Example`,
-        value: `Example`,
-        children: [
-            (0, utils_2.guard)(responseExample.summary, (summary) => [
-                (0, utils_1.create)("div", {
-                    children: `${summary}`,
-                    className: "openapi-example__summary",
-                }),
-            ]),
-            (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({ label, id, responses }) {
-    if (responses === undefined) {
-        return undefined;
-    }
-    const codes = Object.keys(responses);
-    if (codes.length === 0) {
-        return undefined;
-    }
-    return (0, utils_1.create)("div", {
-        children: [
-            (0, utils_1.create)("div", {
-                children: [
-                    (0, utils_1.create)("ApiTabs", {
-                        label,
-                        id,
-                        children: codes.map((code) => {
-                            const responseHeaders = responses[code].headers;
-                            return (0, utils_1.create)("TabItem", {
-                                label: code,
-                                value: code,
-                                children: [
-                                    (0, utils_1.create)("div", {
-                                        children: (0, createDescription_1.createDescription)(responses[code].description),
-                                    }),
-                                    responseHeaders &&
-                                        (0, createDetails_1.createDetails)({
-                                            className: "openapi-markdown__details",
-                                            "data-collapsed": true,
-                                            open: false,
-                                            style: { textAlign: "left", marginBottom: "1rem" },
-                                            children: [
-                                                (0, createDetailsSummary_1.createDetailsSummary)({
-                                                    children: [
-                                                        (0, utils_1.create)("strong", {
-                                                            children: "Response Headers",
-                                                        }),
-                                                    ],
-                                                }),
-                                                createResponseHeaders(responseHeaders),
-                                            ],
-                                        }),
-                                    (0, utils_1.create)("div", {
-                                        children: (0, createResponseSchema_1.createResponseSchema)({
-                                            title: "Schema",
-                                            body: {
-                                                content: responses[code].content,
-                                            },
-                                        }),
-                                    }),
-                                ],
-                            });
-                        }),
-                    }),
-                ],
-            }),
-        ],
-    });
+function createStatusCodes({ id, label, responses }) {
+    return [
+        (0, utils_1.create)("StatusCodes", {
+            id: id,
+            label: label,
+            responses: responses,
+        }),
+        "\n\n",
+    ];
 }
 exports.createStatusCodes = createStatusCodes;

package/lib/markdown/index.js

@@ -21,7 +21,6 @@ const createMethodEndpoint_1 = require("./createMethodEndpoint");
 const createParamsDetails_1 = require("./createParamsDetails");
 const createRequestBodyDetails_1 = require("./createRequestBodyDetails");
 const createRequestHeader_1 = require("./createRequestHeader");
-const createSchema_1 = require("./createSchema");
 const createStatusCodes_1 = require("./createStatusCodes");
 const createTermsOfService_1 = require("./createTermsOfService");
 const createVendorExtensions_1 = require("./createVendorExtensions");
@@ -29,18 +28,13 @@ const createVersionBadge_1 = require("./createVersionBadge");
 const utils_1 = require("./utils");
 function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, method, path, extensions, parameters, requestBody, responses, callbacks, }, infoPath, frontMatter, }) {
     return (0, utils_1.render)([
-        `import ApiTabs from "@theme/ApiTabs";\n`,
-        `import DiscriminatorTabs from "@theme/DiscriminatorTabs";\n`,
         `import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";\n`,
-        `import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";\n`,
-        `import MimeTabs from "@theme/MimeTabs";\n`,
-        `import ParamsItem from "@theme/ParamsItem";\n`,
-        `import ResponseSamples from "@theme/ResponseSamples";\n`,
-        `import SchemaItem from "@theme/SchemaItem";\n`,
-        `import SchemaTabs from "@theme/SchemaTabs";\n`,
-        `import Heading from "@theme/Heading";\n`,
+        `import ParamsDetails from "@theme/ParamsDetails";\n`,
+        `import RequestSchema from "@theme/RequestSchema";\n`,
+        `import StatusCodes from "@theme/StatusCodes";\n`,
         `import OperationTabs from "@theme/OperationTabs";\n`,
-        `import TabItem from "@theme/TabItem";\n\n`,
+        `import TabItem from "@theme/TabItem";\n`,
+        `import Heading from "@theme/Heading";\n\n`,
         (0, createHeading_1.createHeading)(title),
         (0, createMethodEndpoint_1.createMethodEndpoint)(method, path),
         infoPath && (0, createAuthorization_1.createAuthorization)(infoPath),
@@ -50,10 +44,7 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
         (0, createDeprecationNotice_1.createDeprecationNotice)({ deprecated, description: deprecatedDescription }),
         (0, createDescription_1.createDescription)(description),
         requestBody || parameters ? (0, createRequestHeader_1.createRequestHeader)("Request") : undefined,
-        (0, createParamsDetails_1.createParamsDetails)({ parameters, type: "path" }),
-        (0, createParamsDetails_1.createParamsDetails)({ parameters, type: "query" }),
-        (0, createParamsDetails_1.createParamsDetails)({ parameters, type: "header" }),
-        (0, createParamsDetails_1.createParamsDetails)({ parameters, type: "cookie" }),
+        (0, createParamsDetails_1.createParamsDetails)({ parameters }),
         (0, createRequestBodyDetails_1.createRequestBodyDetails)({
             title: "Body",
             body: requestBody,
@@ -89,15 +80,13 @@ exports.createTagPageMD = createTagPageMD;
 function createSchemaPageMD({ schema }) {
     const { title = "", description } = schema;
     return (0, utils_1.render)([
-        `import DiscriminatorTabs from "@theme/DiscriminatorTabs";\n`,
-        `import SchemaItem from "@theme/SchemaItem";\n`,
-        `import SchemaTabs from "@theme/SchemaTabs";\n`,
-        `import Heading from "@theme/Heading";\n`,
-        `import TabItem from "@theme/TabItem";\n\n`,
+        `import Schema from "@theme/Schema";\n`,
+        `import Heading from "@theme/Heading";\n\n`,
         (0, createHeading_1.createHeading)(title.replace(utils_1.lessThan, "<").replace(utils_1.greaterThan, ">")),
         (0, createDescription_1.createDescription)(description),
-        (0, utils_1.create)("ul", {
-            children: (0, createSchema_1.createNodes)(schema, "response"),
+        (0, utils_1.create)("Schema", {
+            schema: schema,
+            schemaType: "response",
         }),
     ]);
 }

package/lib/openapi/createRequestExample.js

@@ -51,7 +51,7 @@ function sampleRequestFromProp(name, prop, obj) {
         obj[name] = (0, exports.sampleRequestFromSchema)(prop.anyOf[0]);
     }
     else if (prop.allOf) {
-        const { mergedSchemas } = (0, createSchema_1.mergeAllOf)(prop.allOf);
+        const mergedSchemas = (0, createSchema_1.mergeAllOf)(prop);
         sampleRequestFromProp(name, mergedSchemas, obj);
     }
     else {
@@ -86,7 +86,7 @@ const sampleRequestFromSchema = (schema = {}) => {
             return (0, exports.sampleRequestFromSchema)(anyOf[0]);
         }
         if (allOf) {
-            const { mergedSchemas } = (0, createSchema_1.mergeAllOf)(allOf);
+            const mergedSchemas = (0, createSchema_1.mergeAllOf)(schemaCopy);
             if (mergedSchemas.properties) {
                 for (const [key, value] of Object.entries(mergedSchemas.properties)) {
                     if ((value.readOnly && value.readOnly === true) || value.deprecated) {

package/lib/openapi/createResponseExample.js

@@ -51,7 +51,7 @@ function sampleResponseFromProp(name, prop, obj) {
         obj[name] = (0, exports.sampleResponseFromSchema)(prop.anyOf[0]);
     }
     else if (prop.allOf) {
-        const { mergedSchemas } = (0, createSchema_1.mergeAllOf)(prop.allOf);
+        const mergedSchemas = (0, createSchema_1.mergeAllOf)(prop);
         sampleResponseFromProp(name, mergedSchemas, obj);
     }
     else {
@@ -68,7 +68,7 @@ const sampleResponseFromSchema = (schema = {}) => {
             return example;
         }
         if (allOf) {
-            const { mergedSchemas } = (0, createSchema_1.mergeAllOf)(allOf);
+            const mergedSchemas = (0, createSchema_1.mergeAllOf)(schemaCopy);
             if (mergedSchemas.properties) {
                 for (const [key, value] of Object.entries(mergedSchemas.properties)) {
                     if ((value.writeOnly && value.writeOnly === true) ||

package/lib/openapi/openapi.js

@@ -21,8 +21,9 @@ const uniq_1 = __importDefault(require("lodash/uniq"));
 const openapi_to_postmanv2_1 = __importDefault(require("openapi-to-postmanv2"));
 const postman_collection_1 = __importDefault(require("postman-collection"));
 const createRequestExample_1 = require("./createRequestExample");
-const loadAndResolveSpec_1 = require("./utils/loadAndResolveSpec");
 const index_1 = require("../index");
+const createResponseExample_1 = require("./createResponseExample");
+const loadAndResolveSpec_1 = require("./utils/loadAndResolveSpec");
 /**
  * Convenience function for converting raw JSON to a Postman Collection object.
  */
@@ -355,6 +356,7 @@ function createItems(openapiData, options, sidebarOptions) {
                                 .replace(/((?:^|[^\\])(?:\\{2})*)"/g, "$1'")
                                 .replace(/\s+$/, "")
                             : "",
+                        sample: JSON.stringify((0, createResponseExample_1.sampleResponseFromSchema)(schemaObject)),
                     },
                     schema: schemaObject,
                 };

package/lib/openapi/types.d.ts

@@ -196,6 +196,7 @@ export interface MediaTypeObject {
     example?: any;
     examples?: Map<ExampleObject>;
     encoding?: Map<EncodingObject>;
+    type?: any;
 }
 export interface MediaTypeObjectWithRef {
     schema?: SchemaObjectWithRef | ReferenceObject;

package/lib/options.js

@@ -23,6 +23,7 @@ const markdownGenerators = utils_validation_1.Joi.object({
     createApiPageMD: utils_validation_1.Joi.function(),
     createInfoPageMD: utils_validation_1.Joi.function(),
     createTagPageMD: utils_validation_1.Joi.function(),
+    createSchemaPageMD: utils_validation_1.Joi.function(),
 });
 exports.OptionsSchema = utils_validation_1.Joi.object({
     id: utils_validation_1.Joi.string().required(),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -42,11 +42,11 @@
     "@docusaurus/utils": "^3.5.0",
     "@docusaurus/utils-validation": "^3.5.0",
     "@redocly/openapi-core": "^1.10.5",
+    "allof-merge": "^0.6.6",
     "chalk": "^4.1.2",
     "clsx": "^1.1.1",
     "fs-extra": "^9.0.1",
     "json-pointer": "^0.6.2",
-    "json-schema-merge-allof": "^0.8.1",
     "json5": "^2.2.3",
     "lodash": "^4.17.20",
     "mustache": "^4.2.0",
@@ -62,5 +62,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "4e771d309f6defe395449b26cc3c65814d72cbcc"
+  "gitHead": "e7295a8aa6f3fab5ccc4f8f9ad0e6c33d785aa16"
 }

package/src/index.ts

@@ -278,7 +278,11 @@ title: "{{{title}}}"
 description: "{{{frontMatter.description}}}"
 sidebar_label: "{{{title}}}"
 hide_title: true
+{{#schema}}
+hide_table_of_contents: true
+{{/schema}}
 schema: true
+sample: {{{frontMatter.sample}}}
 custom_edit_url: null
 ---
 

package/src/markdown/__snapshots__/createSchema.test.ts.snap

@@ -364,6 +364,24 @@ Array [
   qualifierMessage={undefined}
   schema={{ type: \\"string\\" }}
 ></SchemaItem>;
+",
+  "<SchemaItem
+  collapsible={false}
+  name={\\"parentProp1\\"}
+  required={false}
+  schemaName={\\"string\\"}
+  qualifierMessage={undefined}
+  schema={{ type: \\"string\\" }}
+></SchemaItem>;
+",
+  "<SchemaItem
+  collapsible={false}
+  name={\\"parentProp2\\"}
+  required={false}
+  schemaName={\\"string\\"}
+  qualifierMessage={undefined}
+  schema={{ type: \\"string\\" }}
+></SchemaItem>;
 ",
 ]
 `;
@@ -711,6 +729,15 @@ Array [
   qualifierMessage={undefined}
   schema={{ type: \\"string\\" }}
 ></SchemaItem>;
+",
+  "<SchemaItem
+  collapsible={false}
+  name={\\"type\\"}
+  required={false}
+  schemaName={\\"string\\"}
+  qualifierMessage={undefined}
+  schema={{ type: \\"string\\" }}
+></SchemaItem>;
 ",
 ]
 `;
@@ -797,6 +824,34 @@ Array [
   qualifierMessage={undefined}
   schema={{ type: \\"string\\" }}
 ></SchemaItem>;
+",
+  "<div className={\\"openapi-discriminator__item openapi-schema__list-item\\"}>
+  <div>
+    <span className={\\"openapi-schema__container\\"}>
+      <strong
+        className={\\"openapi-discriminator__name openapi-schema__property\\"}
+      >
+        type
+      </strong>
+      <span className={\\"openapi-schema__name\\"}>string</span>
+    </span>
+    <div style={{ paddingLeft: \\"1rem\\" }}>
+      **Possible values:** [\`typeA\`, \`typeB\`]
+    </div>
+    <DiscriminatorTabs className={\\"openapi-tabs__discriminator\\"}>
+      <TabItem label={\\"typeA\\"} value={\\"0-item-discriminator\\"}>
+        <div style={{ marginTop: \\".5rem\\", marginBottom: \\".5rem\\" }}>
+          #/definitions/TypeA
+        </div>
+      </TabItem>
+      <TabItem label={\\"typeB\\"} value={\\"1-item-discriminator\\"}>
+        <div style={{ marginTop: \\".5rem\\", marginBottom: \\".5rem\\" }}>
+          #/definitions/TypeB
+        </div>
+      </TabItem>
+    </DiscriminatorTabs>
+  </div>
+</div>;
 ",
 ]
 `;

package/src/markdown/createContactInfo.ts

@@ -33,7 +33,7 @@ export function createContactInfo(contact: ContactObject) {
       }),
       guard(url, () =>
         create("span", {
-          children: ["URL: ", `[${url}](mailto:${url})`],
+          children: ["URL: ", `[${url}](${url})`],
         })
       ),
     ],

package/src/markdown/createParamsDetails.ts

@@ -5,60 +5,18 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { createDetails } from "./createDetails";
-import { createDetailsSummary } from "./createDetailsSummary";
 import { create } from "./utils";
 import { ApiItem } from "../types";
 
 interface Props {
   parameters: ApiItem["parameters"];
-  type: "path" | "query" | "header" | "cookie";
 }
 
-export function createParamsDetails({ parameters, type }: Props) {
-  if (parameters === undefined) {
-    return undefined;
-  }
-  const params = parameters.filter((param) => param?.in === type);
-  if (params.length === 0) {
-    return undefined;
-  }
-
-  return createDetails({
-    className: "openapi-markdown__details",
-    "data-collapsed": false,
-    open: true,
-    style: { marginBottom: "1rem" },
-    children: [
-      createDetailsSummary({
-        children: [
-          create("h3", {
-            className: "openapi-markdown__details-summary-header-params",
-            children: `${
-              type.charAt(0).toUpperCase() + type.slice(1)
-            } Parameters`,
-          }),
-        ],
-      }),
-      create("div", {
-        children: [
-          create("ul", {
-            children: params.map((param) => {
-              return create("ParamsItem", {
-                className: "paramsItem",
-                param: {
-                  ...param,
-                  enumDescriptions: Object.entries(
-                    param?.schema?.["x-enumDescriptions"] ??
-                      param?.schema?.items?.["x-enumDescriptions"] ??
-                      {}
-                  ),
-                },
-              });
-            }),
-          }),
-        ],
-      }),
-    ],
-  });
+export function createParamsDetails({ parameters }: Props) {
+  return [
+    create("ParamsDetails", {
+      parameters: parameters,
+    }),
+    "\n\n",
+  ];
 }