docusaurus-plugin-openapi-docs 0.0.0-402 → 0.0.0-405

package/README.md

@@ -246,7 +246,7 @@ yarn docusaurus gen-api-docs:version petstore:all
 Run the following to bootstrap a Docsaurus v2 site (classic theme) with `docusaurus-openapi-docs`:
 
 ```bash
-npx create-docusaurus@2.0.0-beta.21 my-website --package-manager yarn
+npx create-docusaurus@2.0.0-rc.1 my-website --package-manager yarn
 ```
 
 > When prompted to select a template choose `Git repository`.

package/lib/openapi/openapi.js

@@ -40,7 +40,8 @@ function jsonToCollection(data) {
  */
 async function createPostmanCollection(openapiData) {
     var _a, _b, _c, _d, _e, _f, _g, _h;
-    const data = openapiData;
+    // Create copy of openapiData
+    const data = Object.assign({}, openapiData);
     // Including `servers` breaks postman, so delete all of them.
     delete data.servers;
     for (let pathItemObject of Object.values(data.paths)) {
@@ -114,7 +115,9 @@ function createItems(openapiData, sidebarOptions) {
                 operationObject.description =
                     (_h = (_g = operationObject.summary) !== null && _g !== void 0 ? _g : operationObject.operationId) !== null && _h !== void 0 ? _h : "";
             }
-            const baseId = (0, lodash_1.kebabCase)(title);
+            const baseId = operationObject.operationId
+                ? (0, lodash_1.kebabCase)(operationObject.operationId)
+                : (0, lodash_1.kebabCase)(operationObject.summary);
             const servers = (_k = (_j = operationObject.servers) !== null && _j !== void 0 ? _j : pathObject.servers) !== null && _k !== void 0 ? _k : openapiData.servers;
             const security = (_l = operationObject.security) !== null && _l !== void 0 ? _l : openapiData.security;
             // Add security schemes so we know how to handle security.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-402",
+  "version": "0.0.0-405",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -67,5 +67,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "0ad47c91138db5b9d06e329fe459b3a04c51c54d"
+  "gitHead": "f87ea96605b968d06659143fc7bcf8628e9508b1"
 }

package/src/openapi/openapi.ts

@@ -53,7 +53,8 @@ function jsonToCollection(data: OpenApiObject): Promise<Collection> {
 async function createPostmanCollection(
   openapiData: OpenApiObject
 ): Promise<Collection> {
-  const data = openapiData as OpenApiObject;
+  // Create copy of openapiData
+  const data = Object.assign({}, openapiData) as OpenApiObject;
 
   // Including `servers` breaks postman, so delete all of them.
   delete data.servers;
@@ -146,7 +147,9 @@ function createItems(
           operationObject.summary ?? operationObject.operationId ?? "";
       }
 
-      const baseId = kebabCase(title);
+      const baseId = operationObject.operationId
+        ? kebabCase(operationObject.operationId)
+        : kebabCase(operationObject.summary);
 
       const servers =
         operationObject.servers ?? pathObject.servers ?? openapiData.servers;

package/lib/markdown/createAnyOneOf.d.ts

@@ -1 +0,0 @@
-export declare function createAnyOneOf(anyOneOf: any[], type: string): string | undefined;

package/lib/markdown/createAnyOneOf.js

@@ -1,57 +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.createAnyOneOf = void 0;
-const createSchemaDetails_1 = require("./createSchemaDetails");
-const utils_1 = require("./utils");
-function createAnyOneOf(anyOneOf, type) {
-    if (anyOneOf === undefined) {
-        return undefined;
-    }
-    if (anyOneOf.length === 0) {
-        return undefined;
-    }
-    return (0, utils_1.create)("div", {
-        children: [
-            (0, utils_1.create)("span", {
-                className: "badge badge--info",
-                children: type,
-            }),
-            (0, utils_1.create)("SchemaTabs", {
-                children: anyOneOf.map((schema, index) => {
-                    const label = schema.title ? schema.title : `MOD${index + 1}`;
-                    if (schema.properties !== undefined) {
-                        return (0, utils_1.create)("TabItem", {
-                            label: label,
-                            value: `${index}-properties`,
-                            children: [(0, createSchemaDetails_1.createNodes)(schema)],
-                        });
-                    }
-                    if (schema.allOf !== undefined) {
-                        return (0, utils_1.create)("TabItem", {
-                            label: label,
-                            value: `${index}-allOf`,
-                            children: [(0, createSchemaDetails_1.createNodes)(schema)],
-                        });
-                    }
-                    if (schema.items !== undefined) {
-                        if (schema.items.properties !== undefined) {
-                            return (0, utils_1.create)("TabItem", {
-                                label: label,
-                                value: `${index}-item-properties`,
-                                children: [(0, createSchemaDetails_1.createNodes)(schema.items)],
-                            });
-                        }
-                    }
-                    return undefined;
-                }),
-            }),
-        ],
-    });
-}
-exports.createAnyOneOf = createAnyOneOf;

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

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

package/lib/openapi/utils/loadAndBundleSpec.js

@@ -1,79 +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.
- * ========================================================================== */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertSwagger2OpenAPI = exports.loadAndBundleSpec = void 0;
-// @ts-nocheck
-const json_schema_ref_parser_1 = __importDefault(require("@apidevtools/json-schema-ref-parser"));
-const bundle_1 = require("@redocly/openapi-core/lib/bundle");
-const config_1 = require("@redocly/openapi-core/lib/config/config");
-const chalk_1 = __importDefault(require("chalk"));
-const swagger2openapi_1 = require("swagger2openapi");
-async function resolveJsonRefs(specUrlOrObject) {
-    var _a, _b;
-    try {
-        let schema = await json_schema_ref_parser_1.default.dereference(specUrlOrObject, {
-            continueOnError: true,
-            resolve: {
-                http: {
-                    timeout: 15000, // 15 sec timeout
-                },
-            },
-            dereference: {
-                circular: "ignore",
-            },
-        });
-        return schema;
-    }
-    catch (err) {
-        console.error(chalk_1.default.yellow((_b = (_a = err.errors[0]) === null || _a === void 0 ? void 0 : _a.message) !== null && _b !== void 0 ? _b : err));
-        return;
-    }
-}
-async function loadAndBundleSpec(specUrlOrObject, parseJsonRefs) {
-    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);
-    if (parseJsonRefs) {
-        const resolved = await resolveJsonRefs(parsed);
-        return typeof resolved === Object
-            ? resolved.swagger !== undefined
-                ? convertSwagger2OpenAPI(resolved)
-                : resolved
-            : parsed;
-    }
-    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;