docusaurus-plugin-openapi-docs 0.0.0-beta.639 → 0.0.0-beta.641

package/lib/index.js

@@ -199,12 +199,6 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                         item.downloadUrl = downloadUrl;
                     }
                 }
-                const markdown = item.type === "api"
-                    ? (0, markdown_1.createApiPageMD)(item)
-                    : item.type === "info"
-                        ? (0, markdown_1.createInfoPageMD)(item)
-                        : (0, markdown_1.createTagPageMD)(item);
-                item.markdown = markdown;
                 if (item.type === "api") {
                     item.json = JSON.stringify(item.api);
                     let infoBasePath = `${outputDir}/${item.infoId}`;
@@ -216,6 +210,12 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                     if (item.infoId)
                         item.infoPath = infoBasePath;
                 }
+                const markdown = item.type === "api"
+                    ? (0, markdown_1.createApiPageMD)(item)
+                    : item.type === "info"
+                        ? (0, markdown_1.createInfoPageMD)(item)
+                        : (0, markdown_1.createTagPageMD)(item);
+                item.markdown = markdown;
                 const view = (0, mustache_1.render)(mdTemplate, item);
                 const utils = (0, mustache_1.render)(infoMdTemplate, item);
                 // eslint-disable-next-line testing-library/render-result-naming-convention

package/lib/markdown/createAuthorization.d.ts

@@ -0,0 +1 @@
+export declare function createAuthorization(infoPath: string): string[] | undefined;

package/lib/markdown/createAuthorization.js

@@ -0,0 +1,16 @@
+"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.createAuthorization = void 0;
+const utils_1 = require("./utils");
+function createAuthorization(infoPath) {
+    if (!infoPath)
+        return undefined;
+    return [(0, utils_1.create)("SecuritySchemes", { infoPath: infoPath }), "\n\n"];
+}
+exports.createAuthorization = createAuthorization;

package/lib/markdown/index.d.ts

@@ -1,4 +1,4 @@
 import { ApiPageMetadata, InfoPageMetadata, TagPageMetadata } from "../types";
-export declare function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, method, path, extensions, parameters, requestBody, responses, }, frontMatter, }: ApiPageMetadata): string;
+export declare function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, method, path, extensions, parameters, requestBody, responses, }, infoPath, frontMatter, }: ApiPageMetadata): string;
 export declare function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService, logo, darkLogo, }, securitySchemes, downloadUrl, }: InfoPageMetadata): string;
 export declare function createTagPageMD({ tag: { description } }: TagPageMetadata): string;

package/lib/markdown/index.js

@@ -8,6 +8,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createTagPageMD = exports.createInfoPageMD = exports.createApiPageMD = void 0;
 const createAuthentication_1 = require("./createAuthentication");
+const createAuthorization_1 = require("./createAuthorization");
 const createContactInfo_1 = require("./createContactInfo");
 const createDeprecationNotice_1 = require("./createDeprecationNotice");
 const createDescription_1 = require("./createDescription");
@@ -23,11 +24,12 @@ const createTermsOfService_1 = require("./createTermsOfService");
 const createVendorExtensions_1 = require("./createVendorExtensions");
 const createVersionBadge_1 = require("./createVersionBadge");
 const utils_1 = require("./utils");
-function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, method, path, extensions, parameters, requestBody, responses, }, frontMatter, }) {
+function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, method, path, extensions, parameters, requestBody, responses, }, infoPath, frontMatter, }) {
     return (0, utils_1.render)([
         `import ApiTabs from "@theme/ApiTabs";\n`,
         `import DiscriminatorTabs from "@theme/DiscriminatorTabs";\n`,
         `import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint";\n`,
+        `import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes";\n`,
         `import MimeTabs from "@theme/MimeTabs";\n`,
         `import ParamsItem from "@theme/ParamsItem";\n`,
         `import ResponseSamples from "@theme/ResponseSamples";\n`,
@@ -37,6 +39,7 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
         (0, createHeading_1.createHeading)(title.replace(utils_1.lessThan, "<").replace(utils_1.greaterThan, ">")),
         (0, createMethodEndpoint_1.createMethodEndpoint)(method, path),
         `## ${title.replace(utils_1.lessThan, "<").replace(utils_1.greaterThan, ">")}\n\n`,
+        infoPath && (0, createAuthorization_1.createAuthorization)(infoPath),
         frontMatter.show_extensions && (0, createVendorExtensions_1.createVendorExtensions)(extensions),
         (0, createDeprecationNotice_1.createDeprecationNotice)({ deprecated, description: deprecatedDescription }),
         (0, createDescription_1.createDescription)(description),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-beta.639",
+  "version": "0.0.0-beta.641",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -68,5 +68,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "1cf447203205b395bd7aa9bb3d5d671cf3bace12"
+  "gitHead": "24122ee7955286109c55455fc3213dd0807aaea4"
 }

package/src/index.ts

@@ -243,13 +243,6 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
             item.downloadUrl = downloadUrl;
           }
         }
-        const markdown =
-          item.type === "api"
-            ? createApiPageMD(item)
-            : item.type === "info"
-            ? createInfoPageMD(item)
-            : createTagPageMD(item);
-        item.markdown = markdown;
         if (item.type === "api") {
           item.json = JSON.stringify(item.api);
           let infoBasePath = `${outputDir}/${item.infoId}`;
@@ -260,6 +253,13 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
           }
           if (item.infoId) item.infoPath = infoBasePath;
         }
+        const markdown =
+          item.type === "api"
+            ? createApiPageMD(item)
+            : item.type === "info"
+            ? createInfoPageMD(item)
+            : createTagPageMD(item);
+        item.markdown = markdown;
 
         const view = render(mdTemplate, item);
         const utils = render(infoMdTemplate, item);

package/src/markdown/createAuthorization.ts

@@ -0,0 +1,13 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+import { create } from "./utils";
+
+export function createAuthorization(infoPath: string) {
+  if (!infoPath) return undefined;
+  return [create("SecuritySchemes", { infoPath: infoPath }), "\n\n"];
+}

package/src/markdown/index.ts

@@ -13,6 +13,7 @@ import {
 } from "../openapi/types";
 import { ApiPageMetadata, InfoPageMetadata, TagPageMetadata } from "../types";
 import { createAuthentication } from "./createAuthentication";
+import { createAuthorization } from "./createAuthorization";
 import { createContactInfo } from "./createContactInfo";
 import { createDeprecationNotice } from "./createDeprecationNotice";
 import { createDescription } from "./createDescription";
@@ -53,12 +54,14 @@ export function createApiPageMD({
     requestBody,
     responses,
   },
+  infoPath,
   frontMatter,
 }: ApiPageMetadata) {
   return render([
     `import ApiTabs from "@theme/ApiTabs";\n`,
     `import DiscriminatorTabs from "@theme/DiscriminatorTabs";\n`,
     `import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint";\n`,
+    `import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes";\n`,
     `import MimeTabs from "@theme/MimeTabs";\n`,
     `import ParamsItem from "@theme/ParamsItem";\n`,
     `import ResponseSamples from "@theme/ResponseSamples";\n`,
@@ -68,6 +71,7 @@ export function createApiPageMD({
     createHeading(title.replace(lessThan, "<").replace(greaterThan, ">")),
     createMethodEndpoint(method, path),
     `## ${title.replace(lessThan, "<").replace(greaterThan, ">")}\n\n`,
+    infoPath && createAuthorization(infoPath),
     frontMatter.show_extensions && createVendorExtensions(extensions),
     createDeprecationNotice({ deprecated, description: deprecatedDescription }),
     createDescription(description),