docusaurus-plugin-openapi-docs 0.0.0-619 → 0.0.0-685

package/src/markdown/index.ts

@@ -13,14 +13,18 @@ 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";
 import { createDownload } from "./createDownload";
+import { createHeading } from "./createHeading";
 import { createLicense } from "./createLicense";
 import { createLogo } from "./createLogo";
+import { createMethodEndpoint } from "./createMethodEndpoint";
 import { createParamsDetails } from "./createParamsDetails";
 import { createRequestBodyDetails } from "./createRequestBodyDetails";
+import { createRequestHeader } from "./createRequestHeader";
 import { createStatusCodes } from "./createStatusCodes";
 import { createTermsOfService } from "./createTermsOfService";
 import { createVendorExtensions } from "./createVendorExtensions";
@@ -44,32 +48,40 @@ export function createApiPageMD({
     deprecated,
     "x-deprecated-description": deprecatedDescription,
     description,
+    method,
+    path,
     extensions,
     parameters,
     requestBody,
     responses,
   },
+  infoPath,
   frontMatter,
 }: ApiPageMetadata) {
   return render([
     `import ApiTabs from "@theme/ApiTabs";\n`,
+    `import DiscriminatorTabs from "@theme/DiscriminatorTabs";\n`,
+    `import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";\n`,
+    `import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";\n`,
     `import MimeTabs from "@theme/MimeTabs";\n`,
     `import ParamsItem from "@theme/ParamsItem";\n`,
     `import ResponseSamples from "@theme/ResponseSamples";\n`,
     `import SchemaItem from "@theme/SchemaItem";\n`,
     `import SchemaTabs from "@theme/SchemaTabs";\n`,
-    `import DiscriminatorTabs from "@theme/DiscriminatorTabs";\n`,
     `import TabItem from "@theme/TabItem";\n\n`,
-    `## ${title.replace(lessThan, "<").replace(greaterThan, ">")}\n\n`,
+    createHeading(title.replace(lessThan, "<").replace(greaterThan, ">")),
+    createMethodEndpoint(method, path),
+    infoPath && createAuthorization(infoPath),
     frontMatter.show_extensions && createVendorExtensions(extensions),
     createDeprecationNotice({ deprecated, description: deprecatedDescription }),
     createDescription(description),
+    createRequestHeader("Request"),
     createParamsDetails({ parameters, type: "path" }),
     createParamsDetails({ parameters, type: "query" }),
     createParamsDetails({ parameters, type: "header" }),
     createParamsDetails({ parameters, type: "cookie" }),
     createRequestBodyDetails({
-      title: "Request Body",
+      title: "Body",
       body: requestBody,
     } as Props),
     createStatusCodes({ responses }),
@@ -94,11 +106,11 @@ export function createInfoPageMD({
     `import ApiLogo from "@theme/ApiLogo";\n`,
     `import SchemaTabs from "@theme/SchemaTabs";\n`,
     `import TabItem from "@theme/TabItem";\n`,
-    `import Export from "@theme/ApiDemoPanel/Export";\n\n`,
+    `import Export from "@theme/ApiExplorer/Export";\n\n`,
 
     createVersionBadge(version),
     createDownload(downloadUrl),
-    `# ${title.replace(lessThan, "<").replace(greaterThan, ">")}\n\n`,
+    createHeading(title.replace(lessThan, "<").replace(greaterThan, ">")),
     createLogo(logo, darkLogo),
     createDescription(description),
     createAuthentication(securitySchemes as unknown as SecuritySchemeObject),

package/src/openapi/openapi.test.ts

@@ -7,6 +7,7 @@
 
 import path from "path";
 
+// eslint-disable-next-line import/no-extraneous-dependencies
 import { posixPath } from "@docusaurus/utils";
 
 import { readOpenapiFiles } from ".";

package/src/openapi/openapi.ts

@@ -171,7 +171,18 @@ function createItems(
       }
 
       let jsonRequestBodyExample;
-      const body = operationObject.requestBody?.content?.["application/json"];
+      const content = operationObject.requestBody?.content;
+      let body;
+      for (let key in content) {
+        if (
+          key.toLowerCase() === "application/json" ||
+          key.toLowerCase() === "application/json; charset=utf-8"
+        ) {
+          body = content[key];
+          break;
+        }
+      }
+
       if (body?.schema) {
         jsonRequestBodyExample = sampleRequestFromSchema(body.schema);
       }
@@ -304,7 +315,18 @@ function createItems(
       }
 
       let jsonRequestBodyExample;
-      const body = operationObject.requestBody?.content?.["application/json"];
+      const content = operationObject.requestBody?.content;
+      let body;
+      for (let key in content) {
+        if (
+          key.toLowerCase() === "application/json" ||
+          key.toLowerCase() === "application/json; charset=utf-8"
+        ) {
+          body = content[key];
+          break;
+        }
+      }
+
       if (body?.schema) {
         jsonRequestBodyExample = sampleRequestFromSchema(body.schema);
       }
@@ -447,8 +469,7 @@ function bindCollectionToApiItems(
     const method = item.request.method.toLowerCase();
     const path = item.request.url
       .getPath({ unresolved: true }) // unresolved returns "/:variableName" instead of "/<type>"
-      .replace(/:([a-z0-9-_]+)/gi, "{$1}"); // replace "/:variableName" with "/{variableName}"
-
+      .replace(/(?<![a-z0-9-_]+):([a-z0-9-_]+)/gi, "{$1}"); // replace "/:variableName" with "/{variableName}"
     const apiItem = items.find((item) => {
       if (item.type === "info" || item.type === "tag") {
         return false;

package/src/options.ts

@@ -9,8 +9,7 @@ import { Joi } from "@docusaurus/utils-validation";
 
 const sidebarOptions = Joi.object({
   groupPathsBy: Joi.string().valid("tag"),
-  // TODO: Remove "none" in 2.0, make it the default if not specified
-  categoryLinkSource: Joi.string().valid("tag", "info", "none"),
+  categoryLinkSource: Joi.string().valid("tag", "info", "auto"),
   customProps: Joi.object(),
   sidebarCollapsible: Joi.boolean(),
   sidebarCollapsed: Joi.boolean(),

package/src/sidebars/index.ts

@@ -130,6 +130,7 @@ function groupByTags(
       );
 
       // TODO: perhaps move this into a getLinkConfig() function
+      // Default to no link config (spindowns only)
       let linkConfig = undefined;
       if (taggedInfoObject !== undefined && categoryLinkSource === "info") {
         linkConfig = {
@@ -151,8 +152,7 @@ function groupByTags(
         } as SidebarItemCategoryLinkConfig;
       }
 
-      // Default behavior
-      if (categoryLinkSource === undefined) {
+      if (categoryLinkSource === "auto") {
         linkConfig = {
           type: "generated-index" as "generated-index",
           title: tag,

package/src/types.ts

@@ -54,7 +54,7 @@ export interface MarkdownGenerator {
 
 export interface SidebarOptions {
   groupPathsBy?: string;
-  categoryLinkSource?: string;
+  categoryLinkSource?: "info" | "tag" | "auto";
   customProps?: { [key: string]: unknown };
   sidebarCollapsible?: boolean;
   sidebarCollapsed?: boolean;
@@ -92,6 +92,8 @@ export interface ApiMetadataBase {
   permalink: string;
   sidebarPosition?: number;
   frontMatter: Record<string, unknown>;
+  method?: string;
+  path?: string;
 }
 
 export interface ApiPageMetadata extends ApiMetadataBase {