docusaurus-plugin-openapi-docs 1.0.4 → 1.1.0

package/src/options.ts

@@ -17,7 +17,7 @@ const sidebarOptions = Joi.object({
 
 export const OptionsSchema = Joi.object({
   id: Joi.string().required(),
-  docPluginId: Joi.string().required(),
+  docsPluginId: Joi.string().required(),
   config: Joi.object()
     .pattern(
       /^/,

package/src/sidebars/index.ts

@@ -38,7 +38,7 @@ function groupByTags(
   tags: TagObject[],
   docPath: string
 ): ProcessedSidebar {
-  const { outputDir } = options;
+  const { outputDir, label } = options;
   const {
     sidebarCollapsed,
     sidebarCollapsible,
@@ -67,7 +67,6 @@ function groupByTags(
   const basePath = docPath
     ? outputDir.split(docPath!)[1].replace(/^\/+/g, "")
     : outputDir.slice(outputDir.indexOf("/", 1)).replace(/^\/+/g, "");
-
   function createDocItem(item: ApiPageMetadata): SidebarItemDoc {
     const sidebar_label = item.frontMatter.sidebar_label;
     const title = item.title;
@@ -94,7 +93,7 @@ function groupByTags(
     const id = infoItem.id;
     rootIntroDoc = {
       type: "doc" as const,
-      id: `${basePath}/${id}`,
+      id: basePath === "" || undefined ? `${id}` : `${basePath}/${id}`,
     };
   }
 
@@ -117,7 +116,10 @@ function groupByTags(
       if (taggedInfoObject !== undefined && categoryLinkSource === "info") {
         linkConfig = {
           type: "doc",
-          id: `${basePath}/${taggedInfoObject.id}`,
+          id:
+            basePath === "" || undefined
+              ? `${taggedInfoObject.id}`
+              : `${basePath}/${taggedInfoObject.id}`,
         } as SidebarItemCategoryLinkConfig;
       }
 
@@ -126,7 +128,8 @@ function groupByTags(
         const tagId = kebabCase(tagObject.name);
         linkConfig = {
           type: "doc",
-          id: `${basePath}/${tagId}`,
+          id:
+            basePath === "" || undefined ? `${tagId}` : `${basePath}/${tagId}`,
         } as SidebarItemCategoryLinkConfig;
       }
 
@@ -135,7 +138,9 @@ function groupByTags(
         linkConfig = {
           type: "generated-index" as "generated-index",
           title: tag,
-          slug: "/category/" + kebabCase(tag),
+          slug: label
+            ? "/category/" + kebabCase(label) + "/" + kebabCase(tag)
+            : "/category/" + kebabCase(tag),
         } as SidebarItemCategoryLinkConfig;
       }
 

package/src/types.ts

@@ -22,7 +22,7 @@ export type {
 } from "@docusaurus/plugin-content-docs-types";
 export interface PluginOptions {
   id?: string;
-  docPluginId: string;
+  docsPluginId: string;
   config: {
     [key: string]: APIOptions;
   };

package/lib/openapi/utils/loadAndBundleSpec.d.ts

@@ -1,3 +0,0 @@
-import { OpenAPISpec } from "./types";
-export declare function loadAndBundleSpec(specUrlOrObject: object | string): Promise<OpenAPISpec>;
-export declare function convertSwagger2OpenAPI(spec: any): Promise<OpenAPISpec>;

package/lib/openapi/utils/loadAndBundleSpec.js

@@ -1,44 +0,0 @@
-"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.convertSwagger2OpenAPI = exports.loadAndBundleSpec = void 0;
-const bundle_1 = require("@redocly/openapi-core/lib/bundle");
-const config_1 = require("@redocly/openapi-core/lib/config/config");
-const swagger2openapi_1 = require("swagger2openapi");
-async function loadAndBundleSpec(specUrlOrObject) {
-    const config = new config_1.Config({});
-    const bundleOpts = {
-        config,
-        base: process.cwd(),
-    };
-    if (typeof specUrlOrObject === "object" && specUrlOrObject !== null) {
-        bundleOpts["doc"] = {
-            source: { absoluteRef: "" },
-            parsed: specUrlOrObject,
-        };
-    }
-    else {
-        bundleOpts["ref"] = specUrlOrObject;
-    }
-    // Force dereference ?
-    // bundleOpts["dereference"] = true;
-    const { bundle: { parsed }, } = await (0, bundle_1.bundle)(bundleOpts);
-    return parsed.swagger !== undefined ? convertSwagger2OpenAPI(parsed) : parsed;
-}
-exports.loadAndBundleSpec = loadAndBundleSpec;
-function convertSwagger2OpenAPI(spec) {
-    console.warn("[ReDoc Compatibility mode]: Converting OpenAPI 2.0 to OpenAPI 3.0");
-    return new Promise((resolve, reject) => (0, swagger2openapi_1.convertObj)(spec, { patch: true, warnOnly: true, text: "{}", anchors: true }, (err, res) => {
-        // TODO: log any warnings
-        if (err) {
-            return reject(err);
-        }
-        resolve(res && res.openapi);
-    }));
-}
-exports.convertSwagger2OpenAPI = convertSwagger2OpenAPI;

package/src/openapi/utils/loadAndBundleSpec.ts

@@ -1,62 +0,0 @@
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-// @ts-nocheck
-
-import type { Source, Document } from "@redocly/openapi-core";
-import { bundle } from "@redocly/openapi-core/lib/bundle";
-import type { ResolvedConfig } from "@redocly/openapi-core/lib/config";
-import { Config } from "@redocly/openapi-core/lib/config/config";
-import { convertObj } from "swagger2openapi";
-
-import { OpenAPISpec } from "./types";
-
-export async function loadAndBundleSpec(
-  specUrlOrObject: object | string
-): Promise<OpenAPISpec> {
-  const config = new Config({} as ResolvedConfig);
-  const bundleOpts = {
-    config,
-    base: process.cwd(),
-  };
-
-  if (typeof specUrlOrObject === "object" && specUrlOrObject !== null) {
-    bundleOpts["doc"] = {
-      source: { absoluteRef: "" } as Source,
-      parsed: specUrlOrObject,
-    } as Document;
-  } else {
-    bundleOpts["ref"] = specUrlOrObject;
-  }
-
-  // Force dereference ?
-  // bundleOpts["dereference"] = true;
-
-  const {
-    bundle: { parsed },
-  } = await bundle(bundleOpts);
-  return parsed.swagger !== undefined ? convertSwagger2OpenAPI(parsed) : parsed;
-}
-
-export function convertSwagger2OpenAPI(spec: any): Promise<OpenAPISpec> {
-  console.warn(
-    "[ReDoc Compatibility mode]: Converting OpenAPI 2.0 to OpenAPI 3.0"
-  );
-  return new Promise<OpenAPISpec>((resolve, reject) =>
-    convertObj(
-      spec,
-      { patch: true, warnOnly: true, text: "{}", anchors: true },
-      (err, res) => {
-        // TODO: log any warnings
-        if (err) {
-          return reject(err);
-        }
-        resolve(res && (res.openapi as any));
-      }
-    )
-  );
-}