docusaurus-plugin-openapi-docs 0.0.0-379 → 0.0.0-380

package/README.md

@@ -107,16 +107,19 @@ Here is an example of properly configuring your `docusaurus.config.js` file for
 
 `docusaurus-plugin-openapi-docs` can be configured with the following options:
 
-| Name             | Type     | Default | Description                                                                                                                 |
-| ---------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------- |
-| `specPath`       | `string` | `null`  | Designated URL or path to the source of an OpenAPI specification file or directory of multiple OpenAPI specification files. |
-| `ouputDir`       | `string` | `null`  | Desired output path for generated MDX files.                                                                                |
-| `template`       | `string` | `null`  | _Optional:_ Customize MDX content with a desired template.                                                                  |
-| `sidebarOptions` | `object` | `null`  | _Optional:_ Set of options for sidebar configuration. See below for a list of supported options.                            |
-| `version`        | `string` | `null`  | _Optional:_ Version assigned to single or micro-spec API specified in `specPath`.                                           |
-| `label`          | `string` | `null`  | _Optional:_ Version label used when generating version selector dropdown menu.                                              |
-| `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.                         |
+| Name              | Type     | Default | Description                                                                                                                 |
+| ----------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `specPath`        | `string` | `null`  | Designated URL or path to the source of an OpenAPI specification file or directory of multiple OpenAPI specification files. |
+| `ouputDir`        | `string` | `null`  | Desired output path for generated MDX files.                                                                                |
+| `contentDocsPath` | `string` | `null`  | Should be equal to the `path` value set in `plugin-content-docs` or preset.                                                 |
+| `ouputDir`        | `string` | `null`  | Desired output path for generated MDX files.                                                                                |
+| `routeBasePath`   | `string` | `null`  | _Optional:_ Should be equal to the `routeBasePath` value set in `plugin-content-docs or preset (if present).                |
+| `template`        | `string` | `null`  | _Optional:_ Customize MDX content with a desired template.                                                                  |
+| `sidebarOptions`  | `object` | `null`  | _Optional:_ Set of options for sidebar configuration. See below for a list of supported options.                            |
+| `version`         | `string` | `null`  | _Optional:_ Version assigned to single or micro-spec API specified in `specPath`.                                           |
+| `label`           | `string` | `null`  | _Optional:_ Version label used when generating version selector dropdown menu.                                              |
+| `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.                         |
 
 `sidebarOptions` can be configured with the following options:
 

package/lib/index.js

@@ -27,7 +27,7 @@ function pluginOpenAPIDocs(context, options) {
     let { config } = options;
     let { siteDir } = context;
     async function generateApiDocs(options) {
-        let { specPath, outputDir, template, sidebarOptions } = options;
+        let { specPath, outputDir, contentDocsPath, routeBasePath, template, sidebarOptions, } = options;
         const contentPath = isURL(specPath)
             ? specPath
             : path_1.default.resolve(siteDir, specPath);
@@ -135,8 +135,14 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                 item.markdown = markdown;
                 if (item.type === "api") {
                     item.json = JSON.stringify(item.api);
+                    let infoBasePath = `${outputDir}/${item.infoId}`;
+                    if (routeBasePath) {
+                        infoBasePath = `${routeBasePath}/${outputDir
+                            .split(contentDocsPath)[1]
+                            .replace(/^\/+/g, "")}/${item.infoId}`.replace(/^\/+/g, "");
+                    }
                     if (item.infoId)
-                        item.infoPath = `${outputDir}/${item.infoId}`;
+                        item.infoPath = infoBasePath;
                 }
                 const view = (0, mustache_1.render)(mdTemplate, item);
                 const utils = (0, mustache_1.render)(infoMdTemplate, item);

package/lib/options.js

@@ -9,19 +9,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OptionsSchema = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const sidebarOptions = utils_validation_1.Joi.object({
-    contentDocsPath: utils_validation_1.Joi.string(),
     groupPathsBy: utils_validation_1.Joi.string().valid("tag"),
     categoryLinkSource: utils_validation_1.Joi.string().valid("tag", "info"),
     customProps: utils_validation_1.Joi.object(),
     sidebarCollapsible: utils_validation_1.Joi.boolean(),
     sidebarCollapsed: utils_validation_1.Joi.boolean(),
-}).with("groupPathsBy", "contentDocsPath");
+});
 exports.OptionsSchema = utils_validation_1.Joi.object({
     id: utils_validation_1.Joi.string().required(),
     config: utils_validation_1.Joi.object()
         .pattern(/^/, utils_validation_1.Joi.object({
         specPath: utils_validation_1.Joi.string().required(),
         outputDir: utils_validation_1.Joi.string().required(),
+        contentDocsPath: utils_validation_1.Joi.string().required(),
+        routeBasePath: utils_validation_1.Joi.string(),
         template: utils_validation_1.Joi.string(),
         sidebarOptions: sidebarOptions,
         version: utils_validation_1.Joi.string().when("versions", {

package/lib/sidebars/index.js

@@ -20,7 +20,8 @@ function isInfoItem(item) {
 }
 function groupByTags(items, sidebarOptions, options, tags) {
     const { outputDir } = options;
-    const { sidebarCollapsed, sidebarCollapsible, customProps, categoryLinkSource, contentDocsPath, } = sidebarOptions;
+    const { sidebarCollapsed, sidebarCollapsible, customProps, categoryLinkSource, } = sidebarOptions;
+    const { contentDocsPath } = options;
     const apiItems = items.filter(isApiItem);
     const infoItems = items.filter(isInfoItem);
     const intros = infoItems.map((item) => {

package/lib/types.d.ts

@@ -10,6 +10,8 @@ export interface PluginOptions {
 export interface APIOptions {
     specPath: string;
     outputDir: string;
+    contentDocsPath: string;
+    routeBasePath?: string;
     template?: string;
     sidebarOptions?: SidebarOptions;
     version?: string;
@@ -19,6 +21,15 @@ export interface APIOptions {
         [key: string]: APIVersionOptions;
     };
 }
+export interface SidebarOptions {
+    groupPathsBy?: string;
+    categoryLinkSource?: string;
+    customProps?: {
+        [key: string]: unknown;
+    };
+    sidebarCollapsible?: boolean;
+    sidebarCollapsed?: boolean;
+}
 export interface APIVersionOptions {
     specPath: string;
     outputDir: string;
@@ -80,13 +91,3 @@ export interface ApiNavLink {
     title: string;
     permalink: string;
 }
-export interface SidebarOptions {
-    contentDocsPath?: string;
-    groupPathsBy?: string;
-    categoryLinkSource?: string;
-    customProps?: {
-        [key: string]: unknown;
-    };
-    sidebarCollapsible?: boolean;
-    sidebarCollapsed?: boolean;
-}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-379",
+  "version": "0.0.0-380",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -62,5 +62,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "87e5b6e59b66aae31c2f163060b030b232a45d39"
+  "gitHead": "3322e621893b40124fed23abd7f7aa8f12fed5af"
 }

package/src/index.ts

@@ -31,7 +31,14 @@ export default function pluginOpenAPIDocs(
   let { siteDir } = context;
 
   async function generateApiDocs(options: APIOptions) {
-    let { specPath, outputDir, template, sidebarOptions } = options;
+    let {
+      specPath,
+      outputDir,
+      contentDocsPath,
+      routeBasePath,
+      template,
+      sidebarOptions,
+    } = options;
 
     const contentPath = isURL(specPath)
       ? specPath
@@ -164,7 +171,13 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
         item.markdown = markdown;
         if (item.type === "api") {
           item.json = JSON.stringify(item.api);
-          if (item.infoId) item.infoPath = `${outputDir}/${item.infoId}`;
+          let infoBasePath = `${outputDir}/${item.infoId}`;
+          if (routeBasePath) {
+            infoBasePath = `${routeBasePath}/${outputDir
+              .split(contentDocsPath!)[1]
+              .replace(/^\/+/g, "")}/${item.infoId}`.replace(/^\/+/g, "");
+          }
+          if (item.infoId) item.infoPath = infoBasePath;
         }
 
         const view = render(mdTemplate, item);

package/src/options.ts

@@ -8,13 +8,12 @@
 import { Joi } from "@docusaurus/utils-validation";
 
 const sidebarOptions = Joi.object({
-  contentDocsPath: Joi.string(),
   groupPathsBy: Joi.string().valid("tag"),
   categoryLinkSource: Joi.string().valid("tag", "info"),
   customProps: Joi.object(),
   sidebarCollapsible: Joi.boolean(),
   sidebarCollapsed: Joi.boolean(),
-}).with("groupPathsBy", "contentDocsPath");
+});
 
 export const OptionsSchema = Joi.object({
   id: Joi.string().required(),
@@ -24,6 +23,8 @@ export const OptionsSchema = Joi.object({
       Joi.object({
         specPath: Joi.string().required(),
         outputDir: Joi.string().required(),
+        contentDocsPath: Joi.string().required(),
+        routeBasePath: Joi.string(),
         template: Joi.string(),
         sidebarOptions: sidebarOptions,
         version: Joi.string().when("versions", {

package/src/sidebars/index.ts

@@ -43,9 +43,10 @@ function groupByTags(
     sidebarCollapsible,
     customProps,
     categoryLinkSource,
-    contentDocsPath,
   } = sidebarOptions;
 
+  const { contentDocsPath } = options;
+
   const apiItems = items.filter(isApiItem);
   const infoItems = items.filter(isInfoItem);
   const intros = infoItems.map((item: any) => {

package/src/types.ts

@@ -30,6 +30,8 @@ export interface PluginOptions {
 export interface APIOptions {
   specPath: string;
   outputDir: string;
+  contentDocsPath: string;
+  routeBasePath?: string;
   template?: string;
   sidebarOptions?: SidebarOptions;
   version?: string;
@@ -40,6 +42,14 @@ export interface APIOptions {
   };
 }
 
+export interface SidebarOptions {
+  groupPathsBy?: string;
+  categoryLinkSource?: string;
+  customProps?: { [key: string]: unknown };
+  sidebarCollapsible?: boolean;
+  sidebarCollapsed?: boolean;
+}
+
 export interface APIVersionOptions {
   specPath: string;
   outputDir: string;
@@ -112,12 +122,3 @@ export interface ApiNavLink {
   title: string;
   permalink: string;
 }
-
-export interface SidebarOptions {
-  contentDocsPath?: string;
-  groupPathsBy?: string;
-  categoryLinkSource?: string;
-  customProps?: { [key: string]: unknown };
-  sidebarCollapsible?: boolean;
-  sidebarCollapsed?: boolean;
-}