docusaurus-plugin-openapi-docs 0.0.0-1081 → 0.0.0-1083

package/README.md

@@ -176,6 +176,8 @@ 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.                                               |
+| `showInfoPage`       | `boolean` | `true`  | _Optional:_ If set to `false`, disables generation of the info page (overview page with API title and description).                         |
+| `schemasOnly`        | `boolean` | `false` | _Optional:_ If set to `true`, generates only schema pages (no API endpoint pages). Also available as `--schemas-only` CLI flag.             |
 
 ### sidebarOptions
 

package/lib/index.js

@@ -234,6 +234,7 @@ custom_edit_url: null
                 schema: schemaPageGenerator,
             };
             loadedApi.map(async (item) => {
+                var _a, _b;
                 if (downloadUrl) {
                     item.downloadUrl = downloadUrl;
                 }
@@ -257,9 +258,14 @@ custom_edit_url: null
                             .toString("base64"));
                     let infoBasePath = `${outputDir}/${item.infoId}`;
                     if (docRouteBasePath) {
-                        infoBasePath = `${docRouteBasePath}/${outputDir
-                            .split(docPath)[1]
-                            .replace(/^\/+/g, "")}/${item.infoId}`.replace(/^\/+/g, "");
+                        // Safely extract path segment, handling cases where docPath may not be in outputDir
+                        const outputSegment = docPath && outputDir.includes(docPath)
+                            ? ((_b = (_a = outputDir.split(docPath)[1]) === null || _a === void 0 ? void 0 : _a.replace(/^\/+/g, "")) !== null && _b !== void 0 ? _b : "")
+                            : outputDir
+                                .slice(outputDir.indexOf("/", 1))
+                                .replace(/^\/+/g, "");
+                        infoBasePath =
+                            `${docRouteBasePath}/${outputSegment}/${item.infoId}`.replace(/^\/+/g, "");
                     }
                     if (item.infoId)
                         item.infoPath = infoBasePath;

package/lib/openapi/openapi.js

@@ -109,8 +109,9 @@ function createItems(openapiData, options, sidebarOptions) {
     const infoIdSpaces = openapiData.info.title.replace(" ", "-").toLowerCase();
     const infoId = (0, kebabCase_1.default)(infoIdSpaces);
     const schemasOnly = (options === null || options === void 0 ? void 0 : options.schemasOnly) === true;
-    if (openapiData.info.description || openapiData.info.title) {
-        // Only create an info page if we have a description.
+    // Only create an info page if we have a description/title AND showInfoPage is not false
+    if ((openapiData.info.description || openapiData.info.title) &&
+        (options === null || options === void 0 ? void 0 : options.showInfoPage) !== false) {
         const infoDescription = (_a = openapiData.info) === null || _a === void 0 ? void 0 : _a.description;
         let splitDescription;
         if (infoDescription) {

package/lib/options.js

@@ -44,6 +44,8 @@ exports.OptionsSchema = utils_validation_1.Joi.object({
         sidebarOptions: sidebarOptions,
         markdownGenerators: markdownGenerators,
         showSchemas: utils_validation_1.Joi.boolean(),
+        showInfoPage: utils_validation_1.Joi.boolean(),
+        schemasOnly: utils_validation_1.Joi.boolean(),
         disableCompression: utils_validation_1.Joi.boolean(),
         maskCredentials: utils_validation_1.Joi.boolean(),
         version: utils_validation_1.Joi.string().when("versions", {

package/lib/sidebars/index.js

@@ -81,9 +81,18 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
     if (sidebarOptions.groupPathsBy !== "tagGroup") {
         apiTags = (0, uniq_1.default)(apiTags.concat(operationTags, schemaTags));
     }
-    const basePath = docPath
-        ? outputDir.split(docPath)[1].replace(/^\/+/g, "")
-        : outputDir.slice(outputDir.indexOf("/", 1)).replace(/^\/+/g, "");
+    // Extract base path from outputDir, handling cases where docPath may not be in outputDir
+    const getBasePathFromOutput = (output, doc) => {
+        var _a, _b;
+        if (doc && output.includes(doc)) {
+            return (_b = (_a = output.split(doc)[1]) === null || _a === void 0 ? void 0 : _a.replace(/^\/+/g, "")) !== null && _b !== void 0 ? _b : "";
+        }
+        const slashIndex = output.indexOf("/", 1);
+        return slashIndex === -1
+            ? ""
+            : output.slice(slashIndex).replace(/^\/+/g, "");
+    };
+    const basePath = getBasePathFromOutput(outputDir, docPath);
     const createDocItemFnContext = {
         sidebarOptions,
         basePath,

package/lib/types.d.ts

@@ -29,6 +29,7 @@ export interface APIOptions {
     proxy?: string;
     markdownGenerators?: MarkdownGenerator;
     showSchemas?: boolean;
+    showInfoPage?: boolean;
     schemasOnly?: boolean;
     disableCompression?: boolean;
     maskCredentials?: boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-1081",
+  "version": "0.0.0-1083",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -65,5 +65,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "2b7184703cfbed61bafb8d671bbbb61ac5f187bc"
+  "gitHead": "cf5831415603ce841036073da0ff9e50db9ed9d8"
 }

package/src/index.ts

@@ -353,9 +353,18 @@ custom_edit_url: null
                 .toString("base64"));
           let infoBasePath = `${outputDir}/${item.infoId}`;
           if (docRouteBasePath) {
-            infoBasePath = `${docRouteBasePath}/${outputDir
-              .split(docPath!)[1]
-              .replace(/^\/+/g, "")}/${item.infoId}`.replace(/^\/+/g, "");
+            // Safely extract path segment, handling cases where docPath may not be in outputDir
+            const outputSegment =
+              docPath && outputDir.includes(docPath)
+                ? (outputDir.split(docPath)[1]?.replace(/^\/+/g, "") ?? "")
+                : outputDir
+                    .slice(outputDir.indexOf("/", 1))
+                    .replace(/^\/+/g, "");
+            infoBasePath =
+              `${docRouteBasePath}/${outputSegment}/${item.infoId}`.replace(
+                /^\/+/g,
+                ""
+              );
           }
           if (item.infoId) item.infoPath = infoBasePath;
         }

package/src/openapi/openapi.ts

@@ -97,8 +97,11 @@ function createItems(
   const infoId = kebabCase(infoIdSpaces);
   const schemasOnly = options?.schemasOnly === true;
 
-  if (openapiData.info.description || openapiData.info.title) {
-    // Only create an info page if we have a description.
+  // Only create an info page if we have a description/title AND showInfoPage is not false
+  if (
+    (openapiData.info.description || openapiData.info.title) &&
+    options?.showInfoPage !== false
+  ) {
     const infoDescription = openapiData.info?.description;
     let splitDescription: any;
     if (infoDescription) {

package/src/options.ts

@@ -48,6 +48,8 @@ export const OptionsSchema = Joi.object({
         sidebarOptions: sidebarOptions,
         markdownGenerators: markdownGenerators,
         showSchemas: Joi.boolean(),
+        showInfoPage: Joi.boolean(),
+        schemasOnly: Joi.boolean(),
         disableCompression: Joi.boolean(),
         maskCredentials: Joi.boolean(),
         version: Joi.string().when("versions", {

package/src/sidebars/index.ts

@@ -125,9 +125,21 @@ function groupByTags(
     apiTags = uniq(apiTags.concat(operationTags, schemaTags));
   }
 
-  const basePath = docPath
-    ? outputDir.split(docPath!)[1].replace(/^\/+/g, "")
-    : outputDir.slice(outputDir.indexOf("/", 1)).replace(/^\/+/g, "");
+  // Extract base path from outputDir, handling cases where docPath may not be in outputDir
+  const getBasePathFromOutput = (
+    output: string,
+    doc: string | undefined
+  ): string => {
+    if (doc && output.includes(doc)) {
+      return output.split(doc)[1]?.replace(/^\/+/g, "") ?? "";
+    }
+    const slashIndex = output.indexOf("/", 1);
+    return slashIndex === -1
+      ? ""
+      : output.slice(slashIndex).replace(/^\/+/g, "");
+  };
+
+  const basePath = getBasePathFromOutput(outputDir, docPath);
 
   const createDocItemFnContext = {
     sidebarOptions,

package/src/types.ts

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