docusaurus-plugin-openapi-docs 1.1.9 → 1.1.12

package/lib/index.d.ts

@@ -1,7 +1,7 @@
 import type { LoadContext, Plugin } from "@docusaurus/types";
 import type { PluginOptions, LoadedContent } from "./types";
 export declare function isURL(str: string): boolean;
-export declare function getDocsData(dataArray: any[], filter: string): Object | undefined;
+export declare function getDocsPluginConfig(presetsPlugins: any[], pluginId: string): Object | undefined;
 declare function pluginOpenAPIDocs(context: LoadContext, options: PluginOptions): Plugin<LoadedContent>;
 declare namespace pluginOpenAPIDocs {
     var validateOptions: ({ options, validate }: any) => any;

package/lib/index.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.getDocsData = exports.isURL = void 0;
+exports.getDocsPluginConfig = exports.isURL = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const utils_1 = require("@docusaurus/utils");
@@ -23,36 +23,44 @@ function isURL(str) {
     return /^(https?:)\/\//m.test(str);
 }
 exports.isURL = isURL;
-function getDocsData(dataArray, filter) {
+function getDocsPluginConfig(presetsPlugins, pluginId) {
     // eslint-disable-next-line array-callback-return
-    const filteredData = dataArray.filter((data) => {
-        if (data[0] === filter) {
+    const filteredConfig = presetsPlugins.filter((data) => {
+        if (data[0] === pluginId) {
             return data[1];
         }
         // Search plugin-content-docs instances
         if (data[0] === "@docusaurus/plugin-content-docs") {
-            const pluginId = data[1].id ? data[1].id : "default";
-            if (pluginId === filter) {
+            const configPluginId = data[1].id ? data[1].id : "default";
+            if (configPluginId === pluginId) {
                 return data[1];
             }
         }
     })[0];
-    if (filteredData) {
+    if (filteredConfig) {
         // Search presets, e.g. "classic"
-        if (filteredData[0] === filter) {
-            return filteredData[1].docs;
+        if (filteredConfig[0] === pluginId) {
+            return filteredConfig[1].docs;
         }
         // Search plugin-content-docs instances
-        if (filteredData[0] === "@docusaurus/plugin-content-docs") {
-            const pluginId = filteredData[1].id ? filteredData[1].id : "default";
-            if (pluginId === filter) {
-                return filteredData[1];
+        if (filteredConfig[0] === "@docusaurus/plugin-content-docs") {
+            const configPluginId = filteredConfig[1].id
+                ? filteredConfig[1].id
+                : "default";
+            if (configPluginId === pluginId) {
+                return filteredConfig[1];
             }
         }
     }
     return;
 }
-exports.getDocsData = getDocsData;
+exports.getDocsPluginConfig = getDocsPluginConfig;
+function getPluginConfig(plugins, pluginId) {
+    return plugins.filter((data) => data[1].id === pluginId)[0][1];
+}
+function getPluginInstances(plugins) {
+    return plugins.filter((data) => data[0] === "docusaurus-plugin-openapi-docs");
+}
 function pluginOpenAPIDocs(context, options) {
     const { config, docsPluginId } = options;
     const { siteDir, siteConfig } = context;
@@ -60,7 +68,7 @@ function pluginOpenAPIDocs(context, options) {
     const presets = siteConfig.presets;
     const plugins = siteConfig.plugins;
     const presetsPlugins = presets.concat(plugins);
-    const docData = getDocsData(presetsPlugins, docsPluginId);
+    const docData = getDocsPluginConfig(presetsPlugins, docsPluginId);
     const docRouteBasePath = docData ? docData.routeBasePath : undefined;
     const docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
     async function generateApiDocs(options) {
@@ -83,9 +91,7 @@ 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 = template
-                    ? fs_1.default.readFileSync(template).toString()
-                    : `module.exports = {{{slice}}};`;
+                const sidebarSliceTemplate = `module.exports = {{{slice}}};`;
                 const view = (0, mustache_1.render)(sidebarSliceTemplate, {
                     slice: JSON.stringify(sidebarSlice),
                 });
@@ -129,12 +135,11 @@ info_path: {{{infoPath}}}
 
 {{{markdown}}}
       `;
-            const infoMdTemplate = template
-                ? fs_1.default.readFileSync(template).toString()
-                : `---
+            const infoMdTemplate = `---
 id: {{{id}}}
 sidebar_label: {{{title}}}
 hide_title: true
+custom_edit_url: null
 ---
 
 {{{markdown}}}
@@ -146,12 +151,11 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
 <DocCardList items={useCurrentSidebarCategory().items}/>
 \`\`\`
       `;
-            const tagMdTemplate = template
-                ? fs_1.default.readFileSync(template).toString()
-                : `---
+            const tagMdTemplate = `---
 id: {{{id}}}
 title: {{{description}}}
 description: {{{description}}}
+custom_edit_url: null
 ---
 
 {{{markdown}}}
@@ -296,22 +300,45 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                 .description(`Generates OpenAPI docs in MDX file format and sidebar.js (if enabled).`)
                 .usage("<id>")
                 .arguments("<id>")
-                .action(async (id) => {
+                .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
+                .action(async (id, instance) => {
+                var _a;
+                const options = instance.opts();
+                const pluginId = options.pluginId;
+                const pluginInstances = getPluginInstances(plugins);
+                let targetConfig;
+                if (pluginId) {
+                    try {
+                        const pluginConfig = getPluginConfig(plugins, pluginId);
+                        targetConfig = (_a = pluginConfig.config) !== null && _a !== void 0 ? _a : {};
+                    }
+                    catch {
+                        console.error(chalk_1.default.red(`OpenAPI docs plugin ID '${pluginId}' not found.`));
+                        return;
+                    }
+                }
+                else {
+                    if (pluginInstances.length > 1) {
+                        console.error(chalk_1.default.red("OpenAPI docs plugin ID must be specified when more than one plugin instance exists."));
+                        return;
+                    }
+                    targetConfig = config;
+                }
                 if (id === "all") {
-                    if (config[id]) {
+                    if (targetConfig[id]) {
                         console.error(chalk_1.default.red("Can't use id 'all' for OpenAPI docs configuration key."));
                     }
                     else {
-                        Object.keys(config).forEach(async function (key) {
-                            await generateApiDocs(config[key]);
+                        Object.keys(targetConfig).forEach(async function (key) {
+                            await generateApiDocs(targetConfig[key]);
                         });
                     }
                 }
-                else if (!config[id]) {
+                else if (!targetConfig[id]) {
                     console.error(chalk_1.default.red(`ID '${id}' does not exist in OpenAPI docs config.`));
                 }
                 else {
-                    await generateApiDocs(config[id]);
+                    await generateApiDocs(targetConfig[id]);
                 }
             });
             cli
@@ -319,15 +346,38 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                 .description(`Generates versioned OpenAPI docs in MDX file format, versions.js and sidebar.js (if enabled).`)
                 .usage("<id:version>")
                 .arguments("<id:version>")
-                .action(async (id) => {
+                .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
+                .action(async (id, instance) => {
+                var _a;
+                const options = instance.opts();
+                const pluginId = options.pluginId;
+                const pluginInstances = getPluginInstances(plugins);
+                let targetConfig;
+                if (pluginId) {
+                    try {
+                        const pluginConfig = getPluginConfig(plugins, pluginId);
+                        targetConfig = (_a = pluginConfig.config) !== null && _a !== void 0 ? _a : {};
+                    }
+                    catch {
+                        console.error(chalk_1.default.red(`OpenAPI docs plugin ID '${pluginId}' not found.`));
+                        return;
+                    }
+                }
+                else {
+                    if (pluginInstances.length > 1) {
+                        console.error(chalk_1.default.red("OpenAPI docs plugin ID must be specified when more than one plugin instance exists."));
+                        return;
+                    }
+                    targetConfig = config;
+                }
                 const [parentId, versionId] = id.split(":");
-                const parentConfig = Object.assign({}, config[parentId]);
+                const parentConfig = Object.assign({}, targetConfig[parentId]);
                 const version = parentConfig.version;
                 const label = parentConfig.label;
                 const baseUrl = parentConfig.baseUrl;
                 let parentVersion = {};
                 parentVersion[version] = { label: label, baseUrl: baseUrl };
-                const { versions } = config[parentId];
+                const { versions } = targetConfig[parentId];
                 const mergedVersions = Object.assign(parentVersion, versions);
                 // Prepare for merge
                 delete parentConfig.versions;
@@ -369,19 +419,42 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                 .description(`Clears the generated OpenAPI docs MDX files and sidebar.js (if enabled).`)
                 .usage("<id>")
                 .arguments("<id>")
-                .action(async (id) => {
+                .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
+                .action(async (id, instance) => {
+                var _a;
+                const options = instance.opts();
+                const pluginId = options.pluginId;
+                const pluginInstances = getPluginInstances(plugins);
+                let targetConfig;
+                if (pluginId) {
+                    try {
+                        const pluginConfig = getPluginConfig(plugins, pluginId);
+                        targetConfig = (_a = pluginConfig.config) !== null && _a !== void 0 ? _a : {};
+                    }
+                    catch {
+                        console.error(chalk_1.default.red(`OpenAPI docs plugin ID '${pluginId}' not found.`));
+                        return;
+                    }
+                }
+                else {
+                    if (pluginInstances.length > 1) {
+                        console.error(chalk_1.default.red("OpenAPI docs plugin ID must be specified when more than one plugin instance exists."));
+                        return;
+                    }
+                    targetConfig = config;
+                }
                 if (id === "all") {
-                    if (config[id]) {
+                    if (targetConfig[id]) {
                         console.error(chalk_1.default.red("Can't use id 'all' for OpenAPI docs configuration key."));
                     }
                     else {
-                        Object.keys(config).forEach(async function (key) {
-                            await cleanApiDocs(config[key]);
+                        Object.keys(targetConfig).forEach(async function (key) {
+                            await cleanApiDocs(targetConfig[key]);
                         });
                     }
                 }
                 else {
-                    await cleanApiDocs(config[id]);
+                    await cleanApiDocs(targetConfig[id]);
                 }
             });
             cli
@@ -389,10 +462,33 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                 .description(`Clears the versioned, generated OpenAPI docs MDX files, versions.json and sidebar.js (if enabled).`)
                 .usage("<id:version>")
                 .arguments("<id:version>")
-                .action(async (id) => {
+                .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
+                .action(async (id, instance) => {
+                var _a;
+                const options = instance.opts();
+                const pluginId = options.pluginId;
+                const pluginInstances = getPluginInstances(plugins);
+                let targetConfig;
+                if (pluginId) {
+                    try {
+                        const pluginConfig = getPluginConfig(plugins, pluginId);
+                        targetConfig = (_a = pluginConfig.config) !== null && _a !== void 0 ? _a : {};
+                    }
+                    catch {
+                        console.error(chalk_1.default.red(`OpenAPI docs plugin ID '${pluginId}' not found.`));
+                        return;
+                    }
+                }
+                else {
+                    if (pluginInstances.length > 1) {
+                        console.error(chalk_1.default.red("OpenAPI docs plugin ID must be specified when more than one plugin instance exists."));
+                        return;
+                    }
+                    targetConfig = config;
+                }
                 const [parentId, versionId] = id.split(":");
-                const { versions } = config[parentId];
-                const parentConfig = Object.assign({}, config[parentId]);
+                const { versions } = targetConfig[parentId];
+                const parentConfig = Object.assign({}, targetConfig[parentId]);
                 delete parentConfig.versions;
                 if (versionId === "all") {
                     if (versions[id]) {

package/lib/markdown/createRequestSchema.js

@@ -344,7 +344,9 @@ function createDetailsNode(name, schemaName, schema, required) {
                                 style: { opacity: "0.6" },
                                 children: ` ${schemaName}`,
                             }),
-                            (0, utils_1.guard)(schema.required && schema.required === true, () => [
+                            (0, utils_1.guard)(Array.isArray(required)
+                                ? required.includes(name)
+                                : required === true, () => [
                                 (0, utils_1.create)("strong", {
                                     style: {
                                         fontSize: "var(--ifm-code-font-size)",

package/lib/openapi/createResponseExample.js

@@ -60,15 +60,17 @@ function sampleResponseFromProp(name, prop, obj) {
 }
 const sampleResponseFromSchema = (schema = {}) => {
     try {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         let { type, example, allOf, oneOf, anyOf, properties, items } = schema;
-        if (example !== undefined) {
-            return example;
-        }
+        // TODO: determine if we should always ignore the example when creating from schema
+        // if (example !== undefined) {
+        //   return example;
+        // }
         if (allOf) {
             const { mergedSchemas } = (0, createResponseSchema_1.mergeAllOf)(allOf);
             if (mergedSchemas.properties) {
                 for (const [key, value] of Object.entries(mergedSchemas.properties)) {
-                    if (value.readOnly && value.readOnly === true) {
+                    if (value.writeOnly && value.writeOnly === true) {
                         delete mergedSchemas.properties[key];
                     }
                 }
@@ -99,14 +101,14 @@ const sampleResponseFromSchema = (schema = {}) => {
             for (let [name, prop] of Object.entries(properties !== null && properties !== void 0 ? properties : {})) {
                 if (prop.properties) {
                     for (const [key, value] of Object.entries(prop.properties)) {
-                        if (value.readOnly && value.readOnly === true) {
+                        if (value.writeOnly && value.writeOnly === true) {
                             delete prop.properties[key];
                         }
                     }
                 }
                 if (prop.items && prop.items.properties) {
                     for (const [key, value] of Object.entries(prop.items.properties)) {
-                        if (value.readOnly && value.readOnly === true) {
+                        if (value.writeOnly && value.writeOnly === true) {
                             delete prop.items.properties[key];
                         }
                     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "1.1.9",
+  "version": "1.1.12",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -40,10 +40,10 @@
   },
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^9.0.9",
-    "@docusaurus/mdx-loader": "2.0.1",
-    "@docusaurus/plugin-content-docs": "2.0.1",
-    "@docusaurus/utils": "2.0.1",
-    "@docusaurus/utils-validation": "2.0.1",
+    "@docusaurus/mdx-loader": "^2.0.1",
+    "@docusaurus/plugin-content-docs": "^2.0.1",
+    "@docusaurus/utils": "^2.0.1",
+    "@docusaurus/utils-validation": "^2.0.1",
     "@paloaltonetworks/openapi-to-postmanv2": "3.1.0-hotfix.1",
     "@paloaltonetworks/postman-collection": "^4.1.0",
     "@redocly/openapi-core": "^1.0.0-beta.103",
@@ -68,5 +68,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "c9153730f9f180dbd199fbc9cb66f8470339c877"
+  "gitHead": "a45dcbd12f26156147a50f5f61026c3adee4b1c8"
 }

package/src/index.ts

@@ -23,41 +23,51 @@ export function isURL(str: string): boolean {
   return /^(https?:)\/\//m.test(str);
 }
 
-export function getDocsData(
-  dataArray: any[],
-  filter: string
+export function getDocsPluginConfig(
+  presetsPlugins: any[],
+  pluginId: string
 ): Object | undefined {
   // eslint-disable-next-line array-callback-return
-  const filteredData = dataArray.filter((data) => {
-    if (data[0] === filter) {
+  const filteredConfig = presetsPlugins.filter((data) => {
+    if (data[0] === pluginId) {
       return data[1];
     }
 
     // Search plugin-content-docs instances
     if (data[0] === "@docusaurus/plugin-content-docs") {
-      const pluginId = data[1].id ? data[1].id : "default";
-      if (pluginId === filter) {
+      const configPluginId = data[1].id ? data[1].id : "default";
+      if (configPluginId === pluginId) {
         return data[1];
       }
     }
   })[0];
-  if (filteredData) {
+  if (filteredConfig) {
     // Search presets, e.g. "classic"
-    if (filteredData[0] === filter) {
-      return filteredData[1].docs;
+    if (filteredConfig[0] === pluginId) {
+      return filteredConfig[1].docs;
     }
 
     // Search plugin-content-docs instances
-    if (filteredData[0] === "@docusaurus/plugin-content-docs") {
-      const pluginId = filteredData[1].id ? filteredData[1].id : "default";
-      if (pluginId === filter) {
-        return filteredData[1];
+    if (filteredConfig[0] === "@docusaurus/plugin-content-docs") {
+      const configPluginId = filteredConfig[1].id
+        ? filteredConfig[1].id
+        : "default";
+      if (configPluginId === pluginId) {
+        return filteredConfig[1];
       }
     }
   }
   return;
 }
 
+function getPluginConfig(plugins: any[], pluginId: string): any {
+  return plugins.filter((data) => data[1].id === pluginId)[0][1];
+}
+
+function getPluginInstances(plugins: any[]): any {
+  return plugins.filter((data) => data[0] === "docusaurus-plugin-openapi-docs");
+}
+
 export default function pluginOpenAPIDocs(
   context: LoadContext,
   options: PluginOptions
@@ -69,7 +79,7 @@ export default function pluginOpenAPIDocs(
   const presets: any = siteConfig.presets;
   const plugins: any = siteConfig.plugins;
   const presetsPlugins = presets.concat(plugins);
-  const docData: any = getDocsData(presetsPlugins, docsPluginId);
+  const docData: any = getDocsPluginConfig(presetsPlugins, docsPluginId);
   const docRouteBasePath = docData ? docData.routeBasePath : undefined;
   const docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
 
@@ -108,9 +118,7 @@ export default function pluginOpenAPIDocs(
           docPath
         );
 
-        const sidebarSliceTemplate = template
-          ? fs.readFileSync(template).toString()
-          : `module.exports = {{{slice}}};`;
+        const sidebarSliceTemplate = `module.exports = {{{slice}}};`;
 
         const view = render(sidebarSliceTemplate, {
           slice: JSON.stringify(sidebarSlice),
@@ -162,12 +170,11 @@ info_path: {{{infoPath}}}
 {{{markdown}}}
       `;
 
-      const infoMdTemplate = template
-        ? fs.readFileSync(template).toString()
-        : `---
+      const infoMdTemplate = `---
 id: {{{id}}}
 sidebar_label: {{{title}}}
 hide_title: true
+custom_edit_url: null
 ---
 
 {{{markdown}}}
@@ -180,12 +187,11 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
 \`\`\`
       `;
 
-      const tagMdTemplate = template
-        ? fs.readFileSync(template).toString()
-        : `---
+      const tagMdTemplate = `---
 id: {{{id}}}
 title: {{{description}}}
 description: {{{description}}}
+custom_edit_url: null
 ---
 
 {{{markdown}}}
@@ -392,25 +398,52 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
         )
         .usage("<id>")
         .arguments("<id>")
-        .action(async (id) => {
+        .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
+        .action(async (id, instance) => {
+          const options = instance.opts();
+          const pluginId = options.pluginId;
+          const pluginInstances = getPluginInstances(plugins);
+          let targetConfig: any;
+          if (pluginId) {
+            try {
+              const pluginConfig = getPluginConfig(plugins, pluginId);
+              targetConfig = pluginConfig.config ?? {};
+            } catch {
+              console.error(
+                chalk.red(`OpenAPI docs plugin ID '${pluginId}' not found.`)
+              );
+              return;
+            }
+          } else {
+            if (pluginInstances.length > 1) {
+              console.error(
+                chalk.red(
+                  "OpenAPI docs plugin ID must be specified when more than one plugin instance exists."
+                )
+              );
+              return;
+            }
+            targetConfig = config;
+          }
+
           if (id === "all") {
-            if (config[id]) {
+            if (targetConfig[id]) {
               console.error(
                 chalk.red(
                   "Can't use id 'all' for OpenAPI docs configuration key."
                 )
               );
             } else {
-              Object.keys(config).forEach(async function (key) {
-                await generateApiDocs(config[key]);
+              Object.keys(targetConfig).forEach(async function (key) {
+                await generateApiDocs(targetConfig[key]);
               });
             }
-          } else if (!config[id]) {
+          } else if (!targetConfig[id]) {
             console.error(
               chalk.red(`ID '${id}' does not exist in OpenAPI docs config.`)
             );
           } else {
-            await generateApiDocs(config[id]);
+            await generateApiDocs(targetConfig[id]);
           }
         });
 
@@ -421,9 +454,35 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
         )
         .usage("<id:version>")
         .arguments("<id:version>")
-        .action(async (id) => {
+        .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
+        .action(async (id, instance) => {
+          const options = instance.opts();
+          const pluginId = options.pluginId;
+          const pluginInstances = getPluginInstances(plugins);
+          let targetConfig: any;
+          if (pluginId) {
+            try {
+              const pluginConfig = getPluginConfig(plugins, pluginId);
+              targetConfig = pluginConfig.config ?? {};
+            } catch {
+              console.error(
+                chalk.red(`OpenAPI docs plugin ID '${pluginId}' not found.`)
+              );
+              return;
+            }
+          } else {
+            if (pluginInstances.length > 1) {
+              console.error(
+                chalk.red(
+                  "OpenAPI docs plugin ID must be specified when more than one plugin instance exists."
+                )
+              );
+              return;
+            }
+            targetConfig = config;
+          }
           const [parentId, versionId] = id.split(":");
-          const parentConfig = Object.assign({}, config[parentId]);
+          const parentConfig = Object.assign({}, targetConfig[parentId]);
 
           const version = parentConfig.version as string;
           const label = parentConfig.label as string;
@@ -432,7 +491,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
           let parentVersion = {} as any;
           parentVersion[version] = { label: label, baseUrl: baseUrl };
 
-          const { versions } = config[parentId] as any;
+          const { versions } = targetConfig[parentId] as any;
           const mergedVersions = Object.assign(parentVersion, versions);
 
           // Prepare for merge
@@ -484,21 +543,47 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
         )
         .usage("<id>")
         .arguments("<id>")
-        .action(async (id) => {
+        .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
+        .action(async (id, instance) => {
+          const options = instance.opts();
+          const pluginId = options.pluginId;
+          const pluginInstances = getPluginInstances(plugins);
+          let targetConfig: any;
+          if (pluginId) {
+            try {
+              const pluginConfig = getPluginConfig(plugins, pluginId);
+              targetConfig = pluginConfig.config ?? {};
+            } catch {
+              console.error(
+                chalk.red(`OpenAPI docs plugin ID '${pluginId}' not found.`)
+              );
+              return;
+            }
+          } else {
+            if (pluginInstances.length > 1) {
+              console.error(
+                chalk.red(
+                  "OpenAPI docs plugin ID must be specified when more than one plugin instance exists."
+                )
+              );
+              return;
+            }
+            targetConfig = config;
+          }
           if (id === "all") {
-            if (config[id]) {
+            if (targetConfig[id]) {
               console.error(
                 chalk.red(
                   "Can't use id 'all' for OpenAPI docs configuration key."
                 )
               );
             } else {
-              Object.keys(config).forEach(async function (key) {
-                await cleanApiDocs(config[key]);
+              Object.keys(targetConfig).forEach(async function (key) {
+                await cleanApiDocs(targetConfig[key]);
               });
             }
           } else {
-            await cleanApiDocs(config[id]);
+            await cleanApiDocs(targetConfig[id]);
           }
         });
 
@@ -509,11 +594,37 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
         )
         .usage("<id:version>")
         .arguments("<id:version>")
-        .action(async (id) => {
+        .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
+        .action(async (id, instance) => {
+          const options = instance.opts();
+          const pluginId = options.pluginId;
+          const pluginInstances = getPluginInstances(plugins);
+          let targetConfig: any;
+          if (pluginId) {
+            try {
+              const pluginConfig = getPluginConfig(plugins, pluginId);
+              targetConfig = pluginConfig.config ?? {};
+            } catch {
+              console.error(
+                chalk.red(`OpenAPI docs plugin ID '${pluginId}' not found.`)
+              );
+              return;
+            }
+          } else {
+            if (pluginInstances.length > 1) {
+              console.error(
+                chalk.red(
+                  "OpenAPI docs plugin ID must be specified when more than one plugin instance exists."
+                )
+              );
+              return;
+            }
+            targetConfig = config;
+          }
           const [parentId, versionId] = id.split(":");
-          const { versions } = config[parentId] as any;
+          const { versions } = targetConfig[parentId] as any;
 
-          const parentConfig = Object.assign({}, config[parentId]);
+          const parentConfig = Object.assign({}, targetConfig[parentId]);
           delete parentConfig.versions;
 
           if (versionId === "all") {

package/src/markdown/createRequestSchema.ts

@@ -407,15 +407,20 @@ function createDetailsNode(
                 style: { opacity: "0.6" },
                 children: ` ${schemaName}`,
               }),
-              guard(schema.required && schema.required === true, () => [
-                create("strong", {
-                  style: {
-                    fontSize: "var(--ifm-code-font-size)",
-                    color: "var(--openapi-required)",
-                  },
-                  children: " required",
-                }),
-              ]),
+              guard(
+                Array.isArray(required)
+                  ? required.includes(name)
+                  : required === true,
+                () => [
+                  create("strong", {
+                    style: {
+                      fontSize: "var(--ifm-code-font-size)",
+                      color: "var(--openapi-required)",
+                    },
+                    children: " required",
+                  }),
+                ]
+              ),
             ],
           }),
           create("div", {

package/src/openapi/createResponseExample.ts

@@ -77,18 +77,20 @@ function sampleResponseFromProp(name: string, prop: any, obj: any): any {
 
 export const sampleResponseFromSchema = (schema: SchemaObject = {}): any => {
   try {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     let { type, example, allOf, oneOf, anyOf, properties, items } = schema;
 
-    if (example !== undefined) {
-      return example;
-    }
+    // TODO: determine if we should always ignore the example when creating from schema
+    // if (example !== undefined) {
+    //   return example;
+    // }
 
     if (allOf) {
       const { mergedSchemas }: { mergedSchemas: SchemaObject } =
         mergeAllOf(allOf);
       if (mergedSchemas.properties) {
         for (const [key, value] of Object.entries(mergedSchemas.properties)) {
-          if (value.readOnly && value.readOnly === true) {
+          if (value.writeOnly && value.writeOnly === true) {
             delete mergedSchemas.properties[key];
           }
         }
@@ -121,7 +123,7 @@ export const sampleResponseFromSchema = (schema: SchemaObject = {}): any => {
       for (let [name, prop] of Object.entries(properties ?? {})) {
         if (prop.properties) {
           for (const [key, value] of Object.entries(prop.properties)) {
-            if (value.readOnly && value.readOnly === true) {
+            if (value.writeOnly && value.writeOnly === true) {
               delete prop.properties[key];
             }
           }
@@ -129,7 +131,7 @@ export const sampleResponseFromSchema = (schema: SchemaObject = {}): any => {
 
         if (prop.items && prop.items.properties) {
           for (const [key, value] of Object.entries(prop.items.properties)) {
-            if (value.readOnly && value.readOnly === true) {
+            if (value.writeOnly && value.writeOnly === true) {
               delete prop.items.properties[key];
             }
           }