Add generateSchemas option

This works similar to showSchemas but it doesn't add the schemas to the
sidebar. This is useful to generate the schemas and then embed them in
other pages as needed.

Author: lukedirtwalker

README.md

@@ -174,6 +174,7 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
 | `versions`           | `object`  | `null`  | _Optional:_ Options for versioning configuration. See below for a list of supported options.                                |
 | `markdownGenerators` | `object`  | `null`  | _Optional:_ Customize MDX content via generator functions. See below for a list of supported options.                       |
 | `showSchemas`        | `boolean` | `null`  | _Optional:_ If set to `true`, generates standalone schema pages and adds them to the sidebar.                               |
+| `generateSchemas`    | `boolean` | `null`  | _Optional:_ If set to `true`, generates schema pages for all schemas referenced in the OpenAPI spec (not added in sidebar). |
 
 ### sidebarOptions
 

demo/docs/intro.mdx

@@ -221,6 +221,7 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
 | `versions`           | `object`  | `null`  | _Optional:_ Options for versioning configuration. See below for a list of supported options.                                                     |
 | `markdownGenerators` | `object`  | `null`  | _Optional:_ Customize MDX content via generator functions. See below for a list of supported options.                                            |
 | `showSchemas`        | `boolean` | `null`  | _Optional:_ If set to `true`, generates standalone schema pages and adds them to the sidebar.                                                    |
+| `generateSchemas`    | `boolean` | `null`  | _Optional:_ If set to `true`, generates schema pages for all schemas referenced in the OpenAPI spec (not added in sidebar).                     |
 
 ### sidebarOptions
 

packages/docusaurus-plugin-openapi-docs/README.md

@@ -174,6 +174,7 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
 | `versions`           | `object`  | `null`  | _Optional:_ Options for versioning configuration. See below for a list of supported options.                                |
 | `markdownGenerators` | `object`  | `null`  | _Optional:_ Customize MDX content via generator functions. See below for a list of supported options.                       |
 | `showSchemas`        | `boolean` | `null`  | _Optional:_ If set to `true`, generates standalone schema pages and adds them to the sidebar.                               |
+| `generateSchemas`    | `boolean` | `null`  | _Optional:_ If set to `true`, generates schema pages for all schemas referenced in the OpenAPI spec (not added in sidebar). |
 
 ### sidebarOptions
 

packages/docusaurus-plugin-openapi-docs/src/openapi/openapi.ts

@@ -423,6 +423,7 @@ function createItems(
 
   if (
     options?.showSchemas === true ||
+    options?.generateSchemas === true ||
     Object.entries(openapiData?.components?.schemas ?? {})
       .flatMap(([_, s]) => s["x-tags"])
       .filter((item) => !!item).length > 0
@@ -431,7 +432,11 @@ function createItems(
     for (let [schema, schemaObject] of Object.entries(
       openapiData?.components?.schemas ?? {}
     )) {
-      if (options?.showSchemas === true || schemaObject["x-tags"]) {
+      if (
+        options?.showSchemas === true ||
+        options?.generateSchemas === true ||
+        schemaObject["x-tags"]
+      ) {
         const baseIdSpaces =
           schemaObject?.title?.replace(" ", "-").toLowerCase() ?? "";
         const baseId = kebabCase(baseIdSpaces);

packages/docusaurus-plugin-openapi-docs/src/options.ts

@@ -48,6 +48,7 @@ export const OptionsSchema = Joi.object({
         sidebarOptions: sidebarOptions,
         markdownGenerators: markdownGenerators,
         showSchemas: Joi.boolean(),
+        generateSchemas: Joi.boolean(),
         disableCompression: Joi.boolean(),
         version: Joi.string().when("versions", {
           is: Joi.exist(),

packages/docusaurus-plugin-openapi-docs/src/types.ts

@@ -51,6 +51,7 @@ export interface APIOptions {
   proxy?: string;
   markdownGenerators?: MarkdownGenerator;
   showSchemas?: boolean;
+  generateSchemas?: boolean;
   disableCompression?: boolean;
 }