docusaurus-plugin-openapi-docs 3.0.0-beta.1 → 3.0.0-beta.10

package/README.md

@@ -31,6 +31,7 @@ Key Features:
 
 | Docusaurus OpenAPI Docs | Docusaurus      |
 | ----------------------- | --------------- |
+| 3.0.0-beta.x (beta)     | `3.0.1 - 3.1.1` |
 | 2.0.x (current)         | `2.4.1 - 2.4.3` |
 | 1.7.3 (legacy)          | `2.0.1 - 2.2.0` |
 
@@ -159,6 +160,7 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
 | `baseUrl`            | `string`  | `null`  | _Optional:_ Version base URL used when generating version selector dropdown menu.                                                               |
 | `versions`           | `object`  | `null`  | _Optional:_ Set of options for versioning configuration. See below for a list of supported options.                                             |
 | `markdownGenerators` | `object`  | `null`  | _Optional:_ Customize MDX content with a set of options for specifying markdown generator functions. See below for a list of supported options. |
+| `showSchemas`        | `boolean` | `null`  | _Optional:_ If set to `true`, generates schema pages and adds them to the sidebar.                                                              |
 
 `sidebarOptions` can be configured with the following options:
 

package/lib/index.js

@@ -15,6 +15,7 @@ const path_1 = __importDefault(require("path"));
 const zlib_1 = __importDefault(require("zlib"));
 const utils_1 = require("@docusaurus/utils");
 const chalk_1 = __importDefault(require("chalk"));
+const json5_1 = __importDefault(require("json5"));
 const mustache_1 = require("mustache");
 const markdown_1 = require("./markdown");
 const openapi_1 = require("./openapi");
@@ -77,7 +78,7 @@ function pluginOpenAPIDocs(context, options) {
     let docRouteBasePath = docData ? docData.routeBasePath : undefined;
     let docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
     async function generateApiDocs(options, pluginId) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         let { specPath, outputDir, template, markdownGenerators, downloadUrl, sidebarOptions, } = options;
         // Remove trailing slash before proceeding
         outputDir = outputDir.replace(/\/$/, "");
@@ -92,7 +93,7 @@ function pluginOpenAPIDocs(context, options) {
             : path_1.default.resolve(siteDir, specPath);
         try {
             const openapiFiles = await (0, openapi_1.readOpenapiFiles)(contentPath);
-            const [loadedApi, tags] = await (0, openapi_1.processOpenapiFiles)(openapiFiles, options, sidebarOptions);
+            const [loadedApi, tags, tagGroups] = await (0, openapi_1.processOpenapiFiles)(openapiFiles, options, sidebarOptions);
             if (!fs_1.default.existsSync(outputDir)) {
                 try {
                     fs_1.default.mkdirSync(outputDir, { recursive: true });
@@ -104,18 +105,20 @@ function pluginOpenAPIDocs(context, options) {
             }
             // TODO: figure out better way to set default
             if (Object.keys(sidebarOptions !== null && sidebarOptions !== void 0 ? sidebarOptions : {}).length > 0) {
-                const sidebarSlice = (0, sidebars_1.default)(sidebarOptions, options, loadedApi, tags, docPath);
-                const sidebarSliceTemplate = `module.exports = {{{slice}}};`;
+                const sidebarSlice = (0, sidebars_1.default)(sidebarOptions, options, loadedApi, tags, docPath, tagGroups);
+                let sidebarSliceTemplate = `import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";\n\n`;
+                sidebarSliceTemplate += `const sidebar: SidebarsConfig = {{{slice}}};\n\n`;
+                sidebarSliceTemplate += `export default sidebar.apisidebar;\n`;
                 const view = (0, mustache_1.render)(sidebarSliceTemplate, {
-                    slice: JSON.stringify(sidebarSlice),
+                    slice: json5_1.default.stringify({ apisidebar: sidebarSlice }, { space: 2, quote: '"' }),
                 });
-                if (!fs_1.default.existsSync(`${outputDir}/sidebar.js`)) {
+                if (!fs_1.default.existsSync(`${outputDir}/sidebar.ts`)) {
                     try {
-                        fs_1.default.writeFileSync(`${outputDir}/sidebar.js`, view, "utf8");
-                        console.log(chalk_1.default.green(`Successfully created "${outputDir}/sidebar.js"`));
+                        fs_1.default.writeFileSync(`${outputDir}/sidebar.ts`, view, "utf8");
+                        console.log(chalk_1.default.green(`Successfully created "${outputDir}/sidebar.ts"`));
                     }
                     catch (err) {
-                        console.error(chalk_1.default.red(`Failed to write "${outputDir}/sidebar.js"`), chalk_1.default.yellow(err));
+                        console.error(chalk_1.default.red(`Failed to write "${outputDir}/sidebar.ts"`), chalk_1.default.yellow(err));
                     }
                 }
             }
@@ -195,20 +198,35 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
 <DocCardList items={useCurrentSidebarCategory().items}/>
 \`\`\`
       `;
+            const schemaMdTemplate = `---
+id: {{{id}}}
+title: "{{{title}}}"
+description: "{{{frontMatter.description}}}"
+sidebar_label: "{{{title}}}"
+hide_title: true
+schema: true
+custom_edit_url: null
+---
+
+{{{markdown}}}
+            `;
             const apiPageGenerator = (_a = markdownGenerators === null || markdownGenerators === void 0 ? void 0 : markdownGenerators.createApiPageMD) !== null && _a !== void 0 ? _a : markdown_1.createApiPageMD;
             const infoPageGenerator = (_b = markdownGenerators === null || markdownGenerators === void 0 ? void 0 : markdownGenerators.createInfoPageMD) !== null && _b !== void 0 ? _b : markdown_1.createInfoPageMD;
             const tagPageGenerator = (_c = markdownGenerators === null || markdownGenerators === void 0 ? void 0 : markdownGenerators.createTagPageMD) !== null && _c !== void 0 ? _c : markdown_1.createTagPageMD;
+            const schemaPageGenerator = (_d = markdownGenerators === null || markdownGenerators === void 0 ? void 0 : markdownGenerators.createSchemaPageMD) !== null && _d !== void 0 ? _d : markdown_1.createSchemaPageMD;
+            const pageGeneratorByType = {
+                api: apiPageGenerator,
+                info: infoPageGenerator,
+                tag: tagPageGenerator,
+                schema: schemaPageGenerator,
+            };
             loadedApi.map(async (item) => {
                 if (item.type === "info") {
                     if (downloadUrl && isURL(downloadUrl)) {
                         item.downloadUrl = downloadUrl;
                     }
                 }
-                const markdown = item.type === "api"
-                    ? apiPageGenerator(item)
-                    : item.type === "info"
-                        ? infoPageGenerator(item)
-                        : tagPageGenerator(item);
+                const markdown = pageGeneratorByType[item.type](item);
                 item.markdown = markdown;
                 if (item.type === "api") {
                     // opportunity to compress JSON
@@ -274,6 +292,32 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                         }
                     }
                 }
+                if (item.type === "schema") {
+                    if (!fs_1.default.existsSync(`${outputDir}/schemas/${item.id}.schema.mdx`)) {
+                        if (!fs_1.default.existsSync(`${outputDir}/schemas`)) {
+                            try {
+                                fs_1.default.mkdirSync(`${outputDir}/schemas`, { recursive: true });
+                                console.log(chalk_1.default.green(`Successfully created "${outputDir}/schemas"`));
+                            }
+                            catch (err) {
+                                console.error(chalk_1.default.red(`Failed to create "${outputDir}/schemas"`), chalk_1.default.yellow(err));
+                            }
+                        }
+                        try {
+                            // kebabCase(arg) returns 0-length string when arg is undefined
+                            if (item.id.length === 0) {
+                                throw Error("Schema must have title defined");
+                            }
+                            // eslint-disable-next-line testing-library/render-result-naming-convention
+                            const schemaView = (0, mustache_1.render)(schemaMdTemplate, item);
+                            fs_1.default.writeFileSync(`${outputDir}/schemas/${item.id}.schema.mdx`, schemaView, "utf8");
+                            console.log(chalk_1.default.green(`Successfully created "${outputDir}/${item.id}.schema.mdx"`));
+                        }
+                        catch (err) {
+                            console.error(chalk_1.default.red(`Failed to write "${outputDir}/${item.id}.schema.mdx"`), chalk_1.default.yellow(err));
+                        }
+                    }
+                }
                 return;
             });
             return;
@@ -290,6 +334,10 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
             cwd: path_1.default.resolve(apiDir),
             deep: 1,
         });
+        const schemaMdxFiles = await (0, utils_1.Globby)(["*.schema.mdx"], {
+            cwd: path_1.default.resolve(apiDir, "schemas"),
+            deep: 1,
+        });
         const sidebarFile = await (0, utils_1.Globby)(["sidebar.js"], {
             cwd: path_1.default.resolve(apiDir),
             deep: 1,
@@ -302,6 +350,14 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                 console.log(chalk_1.default.green(`Cleanup succeeded for "${apiDir}/${mdx}"`));
             }
         }));
+        schemaMdxFiles.map((mdx) => fs_1.default.unlink(`${apiDir}/schemas/${mdx}`, (err) => {
+            if (err) {
+                console.error(chalk_1.default.red(`Cleanup failed for "${apiDir}/schemas/${mdx}"`), chalk_1.default.yellow(err));
+            }
+            else {
+                console.log(chalk_1.default.green(`Cleanup succeeded for "${apiDir}/schemas/${mdx}"`));
+            }
+        }));
         sidebarFile.map((sidebar) => fs_1.default.unlink(`${apiDir}/${sidebar}`, (err) => {
             if (err) {
                 console.error(chalk_1.default.red(`Cleanup failed for "${apiDir}/${sidebar}"`), chalk_1.default.yellow(err));
@@ -322,7 +378,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
         }
         const versionsJson = JSON.stringify(versionsArray, null, 2);
         try {
-            fs_1.default.writeFileSync(`${outputDir}/versions.json`, versionsJson, "utf8");
+            fs_1.default.writeFileSync(`${outputDir}/versions.json`, versionsJson + "\n", "utf8");
             console.log(chalk_1.default.green(`Successfully created "${outputDir}/versions.json"`));
         }
         catch (err) {
@@ -346,7 +402,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
         extendCli(cli) {
             cli
                 .command(`gen-api-docs`)
-                .description(`Generates OpenAPI docs in MDX file format and sidebar.js (if enabled).`)
+                .description(`Generates OpenAPI docs in MDX file format and sidebar.ts (if enabled).`)
                 .usage("<id>")
                 .arguments("<id>")
                 .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
@@ -394,7 +450,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
             });
             cli
                 .command(`gen-api-docs:version`)
-                .description(`Generates versioned OpenAPI docs in MDX file format, versions.js and sidebar.js (if enabled).`)
+                .description(`Generates versioned OpenAPI docs in MDX file format, versions.js and sidebar.ts (if enabled).`)
                 .usage("<id:version>")
                 .arguments("<id:version>")
                 .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
@@ -469,7 +525,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
             });
             cli
                 .command(`clean-api-docs`)
-                .description(`Clears the generated OpenAPI docs MDX files and sidebar.js (if enabled).`)
+                .description(`Clears the generated OpenAPI docs MDX files and sidebar.ts (if enabled).`)
                 .usage("<id>")
                 .arguments("<id>")
                 .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
@@ -512,7 +568,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
             });
             cli
                 .command(`clean-api-docs:version`)
-                .description(`Clears the versioned, generated OpenAPI docs MDX files, versions.json and sidebar.js (if enabled).`)
+                .description(`Clears the versioned, generated OpenAPI docs MDX files, versions.json and sidebar.ts (if enabled).`)
                 .usage("<id:version>")
                 .arguments("<id:version>")
                 .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")

package/lib/markdown/createAuthentication.js

@@ -148,11 +148,12 @@ function createAuthentication(securitySchemes) {
     };
     return (0, utils_1.create)("div", {
         children: [
-            (0, utils_1.create)("h2", {
+            (0, utils_1.create)("Heading", {
                 children: "Authentication",
                 id: "authentication",
-                style: { marginBottom: "1rem" },
-            }),
+                as: "h2",
+                className: "openapi-tabs__heading",
+            }, { inline: true }),
             (0, utils_1.create)("SchemaTabs", {
                 className: "openapi-tabs__security-schemes",
                 children: Object.entries(securitySchemes).map(([schemeKey, schemeObj]) => (0, utils_1.create)("TabItem", {

package/lib/markdown/createCallbacks.d.ts

@@ -0,0 +1,6 @@
+import { ApiItem } from "../types";
+interface Props {
+    callbacks: ApiItem["callbacks"];
+}
+export declare function createCallbacks({ callbacks }: Props): string | undefined;
+export {};

package/lib/markdown/createCallbacks.js

@@ -0,0 +1,78 @@
+"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.createCallbacks = void 0;
+const createDescription_1 = require("./createDescription");
+const createMethodEndpoint_1 = require("./createMethodEndpoint");
+const createRequestBodyDetails_1 = require("./createRequestBodyDetails");
+const createStatusCodes_1 = require("./createStatusCodes");
+const utils_1 = require("./utils");
+function createCallbacks({ callbacks }) {
+    if (callbacks === undefined) {
+        return undefined;
+    }
+    const callbacksNames = Object.keys(callbacks);
+    if (callbacksNames.length === 0) {
+        return undefined;
+    }
+    return (0, utils_1.create)("div", {
+        children: [
+            (0, utils_1.create)("div", {
+                className: "openapi__divider",
+            }),
+            (0, utils_1.create)("Heading", {
+                children: "Callbacks",
+                id: "callbacks",
+                as: "h2",
+                className: "openapi-tabs__heading",
+            }, { inline: true }),
+            (0, utils_1.create)("OperationTabs", {
+                className: "openapi-tabs__operation",
+                children: callbacksNames.flatMap((name) => {
+                    const path = Object.keys(callbacks[name])[0];
+                    const methods = new Map([
+                        ["delete", callbacks[name][path].delete],
+                        ["get", callbacks[name][path].get],
+                        ["head", callbacks[name][path].head],
+                        ["options", callbacks[name][path].options],
+                        ["patch", callbacks[name][path].patch],
+                        ["post", callbacks[name][path].post],
+                        ["put", callbacks[name][path].put],
+                        ["trace", callbacks[name][path].trace],
+                    ]);
+                    return Array.from(methods).flatMap(([method, operationObject]) => {
+                        if (!operationObject)
+                            return [];
+                        const { description, requestBody, responses } = operationObject;
+                        return [
+                            (0, utils_1.create)("TabItem", {
+                                label: `${method.toUpperCase()} ${name}`,
+                                value: `${method}-${name}`,
+                                children: [
+                                    (0, createMethodEndpoint_1.createMethodEndpoint)(method, path),
+                                    // TODO: add `deprecation notice` when markdown support is added
+                                    (0, createDescription_1.createDescription)(description),
+                                    (0, createRequestBodyDetails_1.createRequestBodyDetails)({
+                                        title: "Body",
+                                        body: requestBody,
+                                    }),
+                                    (0, createStatusCodes_1.createStatusCodes)({
+                                        id: "callbacks-responses",
+                                        label: "Callbacks Responses",
+                                        responses,
+                                    }),
+                                ],
+                            }),
+                        ];
+                    });
+                }),
+            }),
+        ],
+    });
+}
+exports.createCallbacks = createCallbacks;

package/lib/markdown/createDeprecationNotice.js

@@ -12,8 +12,11 @@ function createAdmonition({ children }) {
     return `:::caution deprecated\n\n${(0, utils_1.render)(children)}\n\n:::`;
 }
 function createDeprecationNotice({ deprecated, description, }) {
-    return (0, utils_1.guard)(deprecated, () => createAdmonition({
-        children: description !== null && description !== void 0 ? description : "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
-    }));
+    return (0, utils_1.guard)(deprecated, () => {
+        var _a;
+        return createAdmonition({
+            children: (_a = (0, utils_1.clean)(description)) !== null && _a !== void 0 ? _a : "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
+        });
+    });
 }
 exports.createDeprecationNotice = createDeprecationNotice;

package/lib/markdown/createDescription.js

@@ -9,14 +9,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createDescription = void 0;
 const utils_1 = require("./utils");
 function createDescription(description) {
-    if (!description) {
-        return "";
-    }
-    return `\n\n${description
-        .replace(utils_1.lessThan, "<")
-        .replace(utils_1.greaterThan, ">")
-        .replace(utils_1.codeFence, function (match) {
-        return match.replace(/\\>/g, ">");
-    })}\n\n`;
+    return `\n\n${(0, utils_1.clean)(description)}\n\n`;
 }
 exports.createDescription = createDescription;

package/lib/markdown/createHeading.js

@@ -10,12 +10,11 @@ exports.createHeading = void 0;
 const utils_1 = require("./utils");
 function createHeading(heading) {
     return [
-        (0, utils_1.create)("h1", {
+        (0, utils_1.create)("Heading", {
+            children: (0, utils_1.clean)(heading),
+            as: "h1",
             className: "openapi__heading",
-            children: `${heading
-                .replace(utils_1.lessThan, "<")
-                .replace(utils_1.greaterThan, ">")}`,
-        }),
+        }, { inline: true }),
         `\n\n`,
     ];
 }

package/lib/markdown/createRequestBodyDetails.d.ts

@@ -9,5 +9,5 @@ interface Props {
         required?: boolean;
     };
 }
-export declare function createRequestBodyDetails({ title, body }: Props): any;
+export declare function createRequestBodyDetails({ title, body }: Props): string | undefined;
 export {};

package/lib/markdown/createRequestHeader.d.ts

@@ -1 +1 @@
-export declare function createRequestHeader(header: string): string;
+export declare function createRequestHeader(header: string): string[];

package/lib/markdown/createRequestHeader.js

@@ -7,7 +7,16 @@
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createRequestHeader = void 0;
+const utils_1 = require("./utils");
 function createRequestHeader(header) {
-    return `## ${header}\n\n`;
+    return [
+        (0, utils_1.create)("Heading", {
+            children: header,
+            id: header.replace(" ", "-").toLowerCase(),
+            as: "h2",
+            className: "openapi-tabs__heading",
+        }, { inline: true }),
+        `\n\n`,
+    ];
 }
 exports.createRequestHeader = createRequestHeader;

package/lib/markdown/createRequestSchema.js

@@ -74,7 +74,7 @@ function createRequestSchema({ title, body, ...rest }) {
                                 }),
                                 (0, utils_1.create)("ul", {
                                     style: { marginLeft: "1rem" },
-                                    children: (0, createSchema_1.createNodes)(firstBody),
+                                    children: (0, createSchema_1.createNodes)(firstBody, "request"),
                                 }),
                             ],
                         }),
@@ -139,7 +139,7 @@ function createRequestSchema({ title, body, ...rest }) {
                             }),
                             (0, utils_1.create)("ul", {
                                 style: { marginLeft: "1rem" },
-                                children: (0, createSchema_1.createNodes)(firstBody),
+                                children: (0, createSchema_1.createNodes)(firstBody, "request"),
                             }),
                         ],
                     }),

package/lib/markdown/createResponseSchema.js

@@ -89,7 +89,7 @@ function createResponseSchema({ title, body, ...rest }) {
                                                     }),
                                                     (0, utils_1.create)("ul", {
                                                         style: { marginLeft: "1rem" },
-                                                        children: (0, createSchema_1.createNodes)(firstBody),
+                                                        children: (0, createSchema_1.createNodes)(firstBody, "response"),
                                                     }),
                                                 ],
                                             }),

package/lib/markdown/createSchema.d.ts

@@ -4,9 +4,9 @@ import { SchemaObject } from "../openapi/types";
  */
 export declare function mergeAllOf(allOf: SchemaObject[]): {
     mergedSchemas: any;
-    required: any;
+    mergedRequired: any;
 };
 /**
  * Creates a hierarchical level of a schema tree. Nodes produce edges that can branch into sub-nodes with edges, recursively.
  */
-export declare function createNodes(schema: SchemaObject): any;
+export declare function createNodes(schema: SchemaObject, schemaType: "request" | "response"): any;

package/lib/markdown/createSchema.js

@@ -18,6 +18,7 @@ const createDetailsSummary_1 = require("./createDetailsSummary");
 const schema_1 = require("./schema");
 const utils_1 = require("./utils");
 const jsonSchemaMergeAllOf = require("json-schema-merge-allof");
+let SCHEMA_TYPE;
 /**
  * Returns a merged representation of allOf array of schemas.
  */
@@ -27,6 +28,9 @@ function mergeAllOf(allOf) {
             readOnly: function () {
                 return true;
             },
+            writeOnly: function () {
+                return true;
+            },
             example: function () {
                 return true;
             },
@@ -36,14 +40,14 @@ function mergeAllOf(allOf) {
         },
         ignoreAdditionalProperties: true,
     });
-    const required = allOf.reduce((acc, cur) => {
+    const mergedRequired = allOf.reduce((acc, cur) => {
         if (Array.isArray(cur.required)) {
             const next = [...acc, ...cur.required];
             return next;
         }
         return acc;
     }, []);
-    return { mergedSchemas, required };
+    return { mergedSchemas, mergedRequired };
 }
 exports.mergeAllOf = mergeAllOf;
 /**
@@ -68,7 +72,7 @@ function createAnyOneOf(schema) {
                         delete anyOneSchema.properties;
                     }
                     if (anyOneSchema.allOf !== undefined) {
-                        anyOneChildren.push(createNodes(anyOneSchema));
+                        anyOneChildren.push(createNodes(anyOneSchema, SCHEMA_TYPE));
                         delete anyOneSchema.allOf;
                     }
                     if (anyOneSchema.items !== undefined) {
@@ -79,7 +83,7 @@ function createAnyOneOf(schema) {
                         anyOneSchema.type === "number" ||
                         anyOneSchema.type === "integer" ||
                         anyOneSchema.type === "boolean") {
-                        anyOneChildren.push(createNodes(anyOneSchema));
+                        anyOneChildren.push(createNodes(anyOneSchema, SCHEMA_TYPE));
                     }
                     if (anyOneChildren.length) {
                         if (schema.type === "array") {
@@ -257,7 +261,7 @@ function createItems(schema) {
         ((_l = schema.items) === null || _l === void 0 ? void 0 : _l.type) === "object") {
         return [
             (0, createArrayBracket_1.createOpeningArrayBracket)(),
-            createNodes(schema.items),
+            createNodes(schema.items, SCHEMA_TYPE),
             (0, createArrayBracket_1.createClosingArrayBracket)(),
         ].flat();
     }
@@ -344,7 +348,7 @@ function createDetailsNode(name, schemaName, schema, required, nullable) {
                                 style: { marginTop: ".5rem", marginBottom: ".5rem" },
                                 children: (0, createDescription_1.createDescription)(description),
                             })),
-                            createNodes(schema),
+                            createNodes(schema, SCHEMA_TYPE),
                         ],
                     }),
                 ],
@@ -466,7 +470,7 @@ function createPropertyDiscriminator(name, schemaName, schema, discriminator, re
                             // className: "openapi-tabs__discriminator-item",
                             label: label,
                             value: `${index}-item-discriminator`,
-                            children: [createNodes(discriminator === null || discriminator === void 0 ? void 0 : discriminator.mapping[key])],
+                            children: [createNodes(discriminator === null || discriminator === void 0 ? void 0 : discriminator.mapping[key], SCHEMA_TYPE)],
                         });
                     }),
                 }),
@@ -487,7 +491,7 @@ function createEdges({ name, schema, required, discriminator, }) {
         return createAnyOneOfProperty(name, schemaName, schema, required, schema.nullable);
     }
     if (schema.allOf !== undefined) {
-        const { mergedSchemas, required, } = mergeAllOf(schema.allOf);
+        const { mergedSchemas } = mergeAllOf(schema.allOf);
         const mergedSchemaName = (0, schema_1.getSchemaName)(mergedSchemas);
         if (mergedSchemas.oneOf !== undefined ||
             mergedSchemas.anyOf !== undefined) {
@@ -503,15 +507,22 @@ function createEdges({ name, schema, required, discriminator, }) {
         if (((_a = mergedSchemas.items) === null || _a === void 0 ? void 0 : _a.properties) !== undefined) {
             return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
-        if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
-            return undefined;
+        if (SCHEMA_TYPE === "request") {
+            if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
+                return undefined;
+            }
+        }
+        if (SCHEMA_TYPE === "response") {
+            if (mergedSchemas.writeOnly && mergedSchemas.writeOnly === true) {
+                return undefined;
+            }
         }
         return (0, utils_1.create)("SchemaItem", {
             collapsible: false,
             name,
             required: Array.isArray(required) ? required.includes(name) : required,
-            schemaName: schemaName,
-            qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
+            schemaName: mergedSchemaName,
+            qualifierMessage: (0, schema_1.getQualifierMessage)(mergedSchemas),
             schema: mergedSchemas,
         });
     }
@@ -528,8 +539,15 @@ function createEdges({ name, schema, required, discriminator, }) {
     if (((_c = schema.items) === null || _c === void 0 ? void 0 : _c.anyOf) !== undefined || ((_d = schema.items) === null || _d === void 0 ? void 0 : _d.oneOf) !== undefined) {
         return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
-    if (schema.readOnly && schema.readOnly === true) {
-        return undefined;
+    if (SCHEMA_TYPE === "request") {
+        if (schema.readOnly && schema.readOnly === true) {
+            return undefined;
+        }
+    }
+    if (SCHEMA_TYPE === "response") {
+        if (schema.writeOnly && schema.writeOnly === true) {
+            return undefined;
+        }
     }
     // primitives and array of non-objects
     return (0, utils_1.create)("SchemaItem", {
@@ -544,7 +562,8 @@ 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) {
+function createNodes(schema, schemaType) {
+    SCHEMA_TYPE = schemaType;
     const nodes = [];
     // if (schema.discriminator !== undefined) {
     //   return createDiscriminator(schema);
@@ -591,9 +610,16 @@ function createNodes(schema) {
             style: {
                 marginTop: ".5rem",
                 marginBottom: ".5rem",
-                marginLeft: "1rem",
             },
-            children: (0, createDescription_1.createDescription)(schema.type),
+            children: [
+                (0, createDescription_1.createDescription)(schema.type),
+                (0, utils_1.guard)((0, schema_1.getQualifierMessage)(schema), (message) => (0, utils_1.create)("div", {
+                    style: {
+                        paddingTop: "1rem",
+                    },
+                    children: (0, createDescription_1.createDescription)(message),
+                })),
+            ],
         });
     }
     // handle circular references
@@ -602,9 +628,16 @@ function createNodes(schema) {
             style: {
                 marginTop: ".5rem",
                 marginBottom: ".5rem",
-                marginLeft: "1rem",
             },
-            children: [(0, createDescription_1.createDescription)(schema)],
+            children: [
+                (0, createDescription_1.createDescription)(schema),
+                (0, utils_1.guard)((0, schema_1.getQualifierMessage)(schema), (message) => (0, utils_1.create)("div", {
+                    style: {
+                        paddingTop: "1rem",
+                    },
+                    children: (0, createDescription_1.createDescription)(message),
+                })),
+            ],
         });
     }
     // Unknown node/schema type should return undefined

package/lib/markdown/createSchema.test.js

@@ -32,7 +32,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const prettier = __importStar(require("prettier"));
 const createSchema_1 = require("./createSchema");
 describe("createNodes", () => {
-    it("should create readable MODs for oneOf primitive properties", () => {
+    it("should create readable MODs for oneOf primitive properties", async () => {
         const schema = {
             type: "object",
             properties: {
@@ -68,6 +68,6 @@ describe("createNodes", () => {
                 },
             },
         };
-        expect((0, createSchema_1.createNodes)(schema).map((md) => prettier.format(md, { parser: "babel" }))).toMatchSnapshot();
+        expect(await Promise.all((0, createSchema_1.createNodes)(schema, "request").map(async (md) => await prettier.format(md, { parser: "babel" })))).toMatchSnapshot();
     });
 });

package/lib/markdown/createStatusCodes.d.ts

@@ -1,10 +1,12 @@
 import { ApiItem } from "../types";
 export default function json2xml(o: any, tab: any): string;
 interface Props {
+    id?: string;
+    label?: string;
     responses: ApiItem["responses"];
 }
 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 declare function createStatusCodes({ label, id, responses }: Props): string | undefined;
 export {};