docusaurus-plugin-openapi-docs 3.0.0-beta.3 → 3.0.0-beta.5

package/lib/index.js

@@ -15,6 +15,7 @@ const path_1 = __importDefault(require("path"));
 const zlib_1 = __importDefault(require("zlib"));
 const utils_1 = require("@docusaurus/utils");
 const chalk_1 = __importDefault(require("chalk"));
+const json5_1 = __importDefault(require("json5"));
 const mustache_1 = require("mustache");
 const markdown_1 = require("./markdown");
 const openapi_1 = require("./openapi");
@@ -105,11 +106,11 @@ function pluginOpenAPIDocs(context, options) {
             // TODO: figure out better way to set default
             if (Object.keys(sidebarOptions !== null && sidebarOptions !== void 0 ? sidebarOptions : {}).length > 0) {
                 const sidebarSlice = (0, sidebars_1.default)(sidebarOptions, options, loadedApi, tags, docPath);
-                let sidebarSliceTemplate = `import {SidebarConfig} from "@docusaurus/plugin-content-docs/src/sidebars/types";\n\n`;
-                sidebarSliceTemplate += `const sidebar: SidebarConfig = {{{slice}}};\n\n`;
-                sidebarSliceTemplate += `export default sidebar;`;
+                let sidebarSliceTemplate = `import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";\n\n`;
+                sidebarSliceTemplate += `const sidebar: SidebarsConfig = {{{slice}}};\n\n`;
+                sidebarSliceTemplate += `export default sidebar.apisidebar;\n`;
                 const view = (0, mustache_1.render)(sidebarSliceTemplate, {
-                    slice: JSON.stringify(sidebarSlice, null, 2),
+                    slice: json5_1.default.stringify({ apisidebar: sidebarSlice }, { space: 2, quote: '"' }),
                 });
                 if (!fs_1.default.existsSync(`${outputDir}/sidebar.ts`)) {
                     try {
@@ -324,7 +325,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
         }
         const versionsJson = JSON.stringify(versionsArray, null, 2);
         try {
-            fs_1.default.writeFileSync(`${outputDir}/versions.json`, versionsJson, "utf8");
+            fs_1.default.writeFileSync(`${outputDir}/versions.json`, versionsJson + "\n", "utf8");
             console.log(chalk_1.default.green(`Successfully created "${outputDir}/versions.json"`));
         }
         catch (err) {

package/lib/markdown/createCallbacks.d.ts

@@ -0,0 +1,6 @@
+import { ApiItem } from "../types";
+interface Props {
+    callbacks: ApiItem["callbacks"];
+}
+export declare function createCallbacks({ callbacks }: Props): string | undefined;
+export {};

package/lib/markdown/createCallbacks.js

@@ -0,0 +1,76 @@
+"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.createCallbacks = void 0;
+const createDescription_1 = require("./createDescription");
+const createMethodEndpoint_1 = require("./createMethodEndpoint");
+const createRequestBodyDetails_1 = require("./createRequestBodyDetails");
+const createStatusCodes_1 = require("./createStatusCodes");
+const utils_1 = require("./utils");
+function createCallbacks({ callbacks }) {
+    if (callbacks === undefined) {
+        return undefined;
+    }
+    const callbacksNames = Object.keys(callbacks);
+    if (callbacksNames.length === 0) {
+        return undefined;
+    }
+    return (0, utils_1.create)("div", {
+        children: [
+            (0, utils_1.create)("div", {
+                className: "openapi__divider",
+            }),
+            (0, utils_1.create)("h2", {
+                children: "Callbacks",
+                id: "callbacks",
+            }),
+            (0, utils_1.create)("OperationTabs", {
+                className: "openapi-tabs__operation",
+                children: callbacksNames.flatMap((name) => {
+                    const path = Object.keys(callbacks[name])[0];
+                    const methods = new Map([
+                        ["delete", callbacks[name][path].delete],
+                        ["get", callbacks[name][path].get],
+                        ["head", callbacks[name][path].head],
+                        ["options", callbacks[name][path].options],
+                        ["patch", callbacks[name][path].patch],
+                        ["post", callbacks[name][path].post],
+                        ["put", callbacks[name][path].put],
+                        ["trace", callbacks[name][path].trace],
+                    ]);
+                    return Array.from(methods).flatMap(([method, operationObject]) => {
+                        if (!operationObject)
+                            return [];
+                        const { description, requestBody, responses } = operationObject;
+                        return [
+                            (0, utils_1.create)("TabItem", {
+                                label: `${method.toUpperCase()} ${name}`,
+                                value: `${method}-${name}`,
+                                children: [
+                                    (0, createMethodEndpoint_1.createMethodEndpoint)(method, path),
+                                    // TODO: add `deprecation notice` when markdown support is added
+                                    (0, createDescription_1.createDescription)(description),
+                                    (0, createRequestBodyDetails_1.createRequestBodyDetails)({
+                                        title: "Body",
+                                        body: requestBody,
+                                    }),
+                                    (0, createStatusCodes_1.createStatusCodes)({
+                                        id: "callbacks-responses",
+                                        label: "Callbacks Responses",
+                                        responses,
+                                    }),
+                                ],
+                            }),
+                        ];
+                    });
+                }),
+            }),
+        ],
+    });
+}
+exports.createCallbacks = createCallbacks;

package/lib/markdown/createRequestBodyDetails.d.ts

@@ -9,5 +9,5 @@ interface Props {
         required?: boolean;
     };
 }
-export declare function createRequestBodyDetails({ title, body }: Props): any;
+export declare function createRequestBodyDetails({ title, body }: Props): string | undefined;
 export {};

package/lib/markdown/createStatusCodes.d.ts

@@ -1,10 +1,12 @@
 import { ApiItem } from "../types";
 export default function json2xml(o: any, tab: any): string;
 interface Props {
+    id?: string;
+    label?: string;
     responses: ApiItem["responses"];
 }
 export declare function createResponseExamples(responseExamples: any, mimeType: string): string[];
 export declare function createResponseExample(responseExample: any, mimeType: string): string;
 export declare function createExampleFromSchema(schema: any, mimeType: string): string | undefined;
-export declare function createStatusCodes({ responses }: Props): string | undefined;
+export declare function createStatusCodes({ label, id, responses }: Props): string | undefined;
 export {};

package/lib/markdown/createStatusCodes.js

@@ -11,13 +11,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createStatusCodes = exports.createExampleFromSchema = exports.createResponseExample = exports.createResponseExamples = void 0;
 const xml_formatter_1 = __importDefault(require("xml-formatter"));
-const createResponseExample_1 = require("../openapi/createResponseExample");
 const createDescription_1 = require("./createDescription");
 const createDetails_1 = require("./createDetails");
 const createDetailsSummary_1 = require("./createDetailsSummary");
 const createResponseSchema_1 = require("./createResponseSchema");
 const utils_1 = require("./utils");
 const utils_2 = require("./utils");
+const createResponseExample_1 = require("../openapi/createResponseExample");
 function json2xml(o, tab) {
     var toXml = function (v, name, ind) {
         var xml = "";
@@ -118,7 +118,7 @@ function createResponseExamples(responseExamples, mimeType) {
                 value: `${exampleName}`,
                 children: [
                     (0, utils_2.guard)(exampleValue.summary, (summary) => [
-                        (0, utils_1.create)("p", {
+                        (0, utils_1.create)("Markdown", {
                             children: ` ${summary}`,
                         }),
                     ]),
@@ -134,7 +134,7 @@ function createResponseExamples(responseExamples, mimeType) {
             value: `${exampleName}`,
             children: [
                 (0, utils_2.guard)(exampleValue.summary, (summary) => [
-                    (0, utils_1.create)("p", {
+                    (0, utils_1.create)("Markdown", {
                         children: ` ${summary}`,
                     }),
                 ]),
@@ -161,7 +161,7 @@ function createResponseExample(responseExample, mimeType) {
             value: `Example`,
             children: [
                 (0, utils_2.guard)(responseExample.summary, (summary) => [
-                    (0, utils_1.create)("p", {
+                    (0, utils_1.create)("Markdown", {
                         children: ` ${summary}`,
                     }),
                 ]),
@@ -177,7 +177,7 @@ function createResponseExample(responseExample, mimeType) {
         value: `Example`,
         children: [
             (0, utils_2.guard)(responseExample.summary, (summary) => [
-                (0, utils_1.create)("p", {
+                (0, utils_1.create)("Markdown", {
                     children: ` ${summary}`,
                 }),
             ]),
@@ -248,7 +248,7 @@ function createExampleFromSchema(schema, mimeType) {
     return undefined;
 }
 exports.createExampleFromSchema = createExampleFromSchema;
-function createStatusCodes({ responses }) {
+function createStatusCodes({ label, id, responses }) {
     if (responses === undefined) {
         return undefined;
     }
@@ -261,6 +261,8 @@ function createStatusCodes({ responses }) {
             (0, utils_1.create)("div", {
                 children: [
                     (0, utils_1.create)("ApiTabs", {
+                        label,
+                        id,
                         children: codes.map((code) => {
                             const responseHeaders = responses[code].headers;
                             return (0, utils_1.create)("TabItem", {

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, }, infoPath, frontMatter, }: ApiPageMetadata): string;
+export declare function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, method, path, extensions, parameters, requestBody, responses, callbacks, }, 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

@@ -9,6 +9,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 createCallbacks_1 = require("./createCallbacks");
 const createContactInfo_1 = require("./createContactInfo");
 const createDeprecationNotice_1 = require("./createDeprecationNotice");
 const createDescription_1 = require("./createDescription");
@@ -25,7 +26,7 @@ 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, }, infoPath, frontMatter, }) {
+function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, method, path, extensions, parameters, requestBody, responses, callbacks, }, infoPath, frontMatter, }) {
     return (0, utils_1.render)([
         `import ApiTabs from "@theme/ApiTabs";\n`,
         `import DiscriminatorTabs from "@theme/DiscriminatorTabs";\n`,
@@ -36,11 +37,15 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
         `import ResponseSamples from "@theme/ResponseSamples";\n`,
         `import SchemaItem from "@theme/SchemaItem";\n`,
         `import SchemaTabs from "@theme/SchemaTabs";\n`,
+        `import Markdown from "@theme/Markdown";\n`,
+        `import OperationTabs from "@theme/OperationTabs";\n`,
         `import TabItem from "@theme/TabItem";\n\n`,
         (0, createHeading_1.createHeading)(title),
         (0, createMethodEndpoint_1.createMethodEndpoint)(method, path),
         infoPath && (0, createAuthorization_1.createAuthorization)(infoPath),
-        frontMatter.show_extensions && (0, createVendorExtensions_1.createVendorExtensions)(extensions),
+        frontMatter.show_extensions
+            ? (0, createVendorExtensions_1.createVendorExtensions)(extensions)
+            : undefined,
         (0, createDeprecationNotice_1.createDeprecationNotice)({ deprecated, description: deprecatedDescription }),
         (0, createDescription_1.createDescription)(description),
         (0, createRequestHeader_1.createRequestHeader)("Request"),
@@ -53,6 +58,7 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
             body: requestBody,
         }),
         (0, createStatusCodes_1.createStatusCodes)({ responses }),
+        (0, createCallbacks_1.createCallbacks)({ callbacks }),
     ]);
 }
 exports.createApiPageMD = createApiPageMD;

package/lib/markdown/utils.js

@@ -41,22 +41,22 @@ exports.render = render;
 exports.lessThan = /<=?(?!(=|button|\s?\/button|code|\s?\/code|details|\s?\/details|summary|\s?\/summary|hr|\s?\/hr|br|\s?\/br|span|\s?\/span|strong|\s?\/strong|small|\s?\/small|table|\s?\/table|thead|\s?\/thead|tbody|\s?\/tbody|td|\s?\/td|tr|\s?\/tr|th|\s?\/th|h1|\s?\/h1|h2|\s?\/h2|h3|\s?\/h3|h4|\s?\/h4|h5|\s?\/h5|h6|\s?\/h6|title|\s?\/title|p|\s?\/p|em|\s?\/em|b|\s?\/b|i|\s?\/i|u|\s?\/u|strike|\s?\/strike|bold|\s?\/bold|a|\s?\/a|table|\s?\/table|li|\s?\/li|ol|\s?\/ol|ul|\s?\/ul|img|\s?\/img|svg|\s?\/svg|div|\s?\/div|center|\s?\/center))/gu;
 exports.greaterThan = /(?<!(button|code|details|summary|hr|br|span|strong|small|table|thead|tbody|td|tr|th|h1|h2|h3|h4|h5|h6|title|p|em|b|i|u|strike|bold|a|li|ol|ul|img|svg|div|center|\/|\s|"|'))>/gu;
 exports.codeFence = /`{1,3}[\s\S]*?`{1,3}/g;
-exports.curlyBrackets = /\{(.*)}/g;
-exports.codeBlock = /^(```.*[\s\S]*?```)$/gm;
+exports.curlyBrackets = /([{|}])/g;
+exports.codeBlock = /(^```.*[\s\S]*?```$|`[^`].+?`)/gm;
 function clean(value) {
     if (!value) {
         return "";
     }
     let sections = value.split(exports.codeBlock);
     for (let sectionIndex in sections) {
-        if (!sections[sectionIndex].startsWith("```")) {
+        if (!sections[sectionIndex].startsWith("`")) {
             sections[sectionIndex] = sections[sectionIndex]
                 .replace(exports.lessThan, "&lt;")
                 .replace(exports.greaterThan, "&gt;")
                 .replace(exports.codeFence, function (match) {
                 return match.replace(/\\>/g, ">");
             })
-                .replace(exports.curlyBrackets, "\\{$1\\}");
+                .replace(exports.curlyBrackets, "\\$1");
         }
     }
     return sections.join("");

package/lib/openapi/openapi.d.ts

@@ -1,5 +1,5 @@
-import { ApiMetadata, APIOptions, SidebarOptions } from "../types";
 import { OpenApiObject, TagObject } from "./types";
+import { ApiMetadata, APIOptions, SidebarOptions } from "../types";
 interface OpenApiFiles {
     source: string;
     sourceDirName: string;

package/lib/openapi/openapi.js

@@ -20,9 +20,9 @@ const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
 const kebabCase_1 = __importDefault(require("lodash/kebabCase"));
 const unionBy_1 = __importDefault(require("lodash/unionBy"));
 const uniq_1 = __importDefault(require("lodash/uniq"));
-const index_1 = require("../index");
 const createRequestExample_1 = require("./createRequestExample");
 const loadAndResolveSpec_1 = require("./utils/loadAndResolveSpec");
+const index_1 = require("../index");
 /**
  * Convenience function for converting raw JSON to a Postman Collection object.
  */

package/lib/openapi/utils/services/OpenAPIParser.js

@@ -7,10 +7,11 @@
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAPIParser = void 0;
+// @ts-nocheck
+const RedocNormalizedOptions_1 = require("./RedocNormalizedOptions");
 const helpers_1 = require("../utils/helpers");
 const JsonPointer_1 = require("../utils/JsonPointer");
 const openapi_1 = require("../utils/openapi");
-const RedocNormalizedOptions_1 = require("./RedocNormalizedOptions");
 /**
  * Helper class to keep track of visited references to avoid
  * endless recursion because of circular refs

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.5",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -49,6 +49,7 @@
     "fs-extra": "^9.0.1",
     "json-pointer": "^0.6.2",
     "json-schema-merge-allof": "^0.8.1",
+    "json5": "^2.2.3",
     "lodash": "^4.17.20",
     "mustache": "^4.2.0",
     "slugify": "^1.6.5",
@@ -61,5 +62,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "4836267b8bcc01d496449e6d531663a00dfdb4ed"
+  "gitHead": "1f9c9fa811c1e9d42f3c3740a8f7407e3659d629"
 }

package/src/index.ts

@@ -12,6 +12,7 @@ import zlib from "zlib";
 import type { LoadContext, Plugin } from "@docusaurus/types";
 import { Globby, posixPath } from "@docusaurus/utils";
 import chalk from "chalk";
+import JSON5 from "json5";
 import { render } from "mustache";
 
 import { createApiPageMD, createInfoPageMD, createTagPageMD } from "./markdown";
@@ -144,12 +145,15 @@ export default function pluginOpenAPIDocs(
           docPath
         );
 
-        let sidebarSliceTemplate = `import {SidebarConfig} from "@docusaurus/plugin-content-docs/src/sidebars/types";\n\n`;
-        sidebarSliceTemplate += `const sidebar: SidebarConfig = {{{slice}}};\n\n`;
-        sidebarSliceTemplate += `export default sidebar;`;
+        let sidebarSliceTemplate = `import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";\n\n`;
+        sidebarSliceTemplate += `const sidebar: SidebarsConfig = {{{slice}}};\n\n`;
+        sidebarSliceTemplate += `export default sidebar.apisidebar;\n`;
 
         const view = render(sidebarSliceTemplate, {
-          slice: JSON.stringify(sidebarSlice, null, 2),
+          slice: JSON5.stringify(
+            { apisidebar: sidebarSlice },
+            { space: 2, quote: '"' }
+          ),
         });
 
         if (!fs.existsSync(`${outputDir}/sidebar.ts`)) {
@@ -427,7 +431,11 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
 
     const versionsJson = JSON.stringify(versionsArray, null, 2);
     try {
-      fs.writeFileSync(`${outputDir}/versions.json`, versionsJson, "utf8");
+      fs.writeFileSync(
+        `${outputDir}/versions.json`,
+        versionsJson + "\n",
+        "utf8"
+      );
       console.log(
         chalk.green(`Successfully created "${outputDir}/versions.json"`)
       );

package/src/markdown/createAuthentication.ts

@@ -5,9 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { OAuthFlowObject, SecuritySchemeObject } from "../openapi/types";
 import { createDescription } from "./createDescription";
 import { create, guard } from "./utils";
+import { OAuthFlowObject, SecuritySchemeObject } from "../openapi/types";
 
 export function createAuthentication(securitySchemes: SecuritySchemeObject) {
   if (!securitySchemes || !Object.keys(securitySchemes).length) return "";

package/src/markdown/createCallbacks.ts

@@ -0,0 +1,95 @@
+/* ============================================================================
+ * 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 { createDescription } from "./createDescription";
+import { createMethodEndpoint } from "./createMethodEndpoint";
+import { createRequestBodyDetails } from "./createRequestBodyDetails";
+import { createStatusCodes } from "./createStatusCodes";
+import { create } from "./utils";
+import { MediaTypeObject } from "../openapi/types";
+import { ApiItem } from "../types";
+
+interface Props {
+  callbacks: ApiItem["callbacks"];
+}
+
+interface RequestBodyProps {
+  title: string;
+  body: {
+    content?: {
+      [key: string]: MediaTypeObject;
+    };
+    description?: string;
+    required?: boolean;
+  };
+}
+
+export function createCallbacks({ callbacks }: Props) {
+  if (callbacks === undefined) {
+    return undefined;
+  }
+
+  const callbacksNames = Object.keys(callbacks);
+  if (callbacksNames.length === 0) {
+    return undefined;
+  }
+
+  return create("div", {
+    children: [
+      create("div", {
+        className: "openapi__divider",
+      }),
+      create("h2", {
+        children: "Callbacks",
+        id: "callbacks",
+      }),
+      create("OperationTabs", {
+        className: "openapi-tabs__operation",
+        children: callbacksNames.flatMap((name) => {
+          const path = Object.keys(callbacks[name])[0];
+          const methods = new Map([
+            ["delete", callbacks[name][path].delete],
+            ["get", callbacks[name][path].get],
+            ["head", callbacks[name][path].head],
+            ["options", callbacks[name][path].options],
+            ["patch", callbacks[name][path].patch],
+            ["post", callbacks[name][path].post],
+            ["put", callbacks[name][path].put],
+            ["trace", callbacks[name][path].trace],
+          ]);
+
+          return Array.from(methods).flatMap(([method, operationObject]) => {
+            if (!operationObject) return [];
+
+            const { description, requestBody, responses } = operationObject;
+
+            return [
+              create("TabItem", {
+                label: `${method.toUpperCase()} ${name}`,
+                value: `${method}-${name}`,
+                children: [
+                  createMethodEndpoint(method, path),
+                  // TODO: add `deprecation notice` when markdown support is added
+                  createDescription(description),
+                  createRequestBodyDetails({
+                    title: "Body",
+                    body: requestBody,
+                  } as RequestBodyProps),
+                  createStatusCodes({
+                    id: "callbacks-responses",
+                    label: "Callbacks Responses",
+                    responses,
+                  }),
+                ],
+              }),
+            ];
+          });
+        }),
+      }),
+    ],
+  });
+}

package/src/markdown/createContactInfo.ts

@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { ContactObject } from "../openapi/types";
 import { create, guard } from "./utils";
+import { ContactObject } from "../openapi/types";
 
 export function createContactInfo(contact: ContactObject) {
   if (!contact || !Object.keys(contact).length) return "";

package/src/markdown/createLicense.ts

@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { LicenseObject } from "../openapi/types";
 import { create, guard } from "./utils";
+import { LicenseObject } from "../openapi/types";
 
 export function createLicense(license: LicenseObject) {
   if (!license || !Object.keys(license).length) return "";

package/src/markdown/createLogo.ts

@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { LogoObject } from "../openapi/types";
 import { create, guard } from "./utils";
+import { LogoObject } from "../openapi/types";
 
 export function createLogo(
   logo: LogoObject | undefined,

package/src/markdown/createParamsDetails.ts

@@ -5,10 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { ApiItem } from "../types";
 import { createDetails } from "./createDetails";
 import { createDetailsSummary } from "./createDetailsSummary";
 import { create } from "./utils";
+import { ApiItem } from "../types";
 
 interface Props {
   parameters: ApiItem["parameters"];

package/src/markdown/createRequestBodyDetails.ts

@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { MediaTypeObject } from "../openapi/types";
 import { createRequestSchema } from "./createRequestSchema";
+import { MediaTypeObject } from "../openapi/types";
 
 interface Props {
   title: string;
@@ -19,6 +19,6 @@ interface Props {
   };
 }
 
-export function createRequestBodyDetails({ title, body }: Props): any {
+export function createRequestBodyDetails({ title, body }: Props) {
   return createRequestSchema({ title, body });
 }

package/src/markdown/createRequestSchema.ts

@@ -5,12 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { MediaTypeObject } from "../openapi/types";
 import { createDescription } from "./createDescription";
 import { createDetails } from "./createDetails";
 import { createDetailsSummary } from "./createDetailsSummary";
 import { createNodes } from "./createSchema";
 import { create, guard } from "./utils";
+import { MediaTypeObject } from "../openapi/types";
 
 interface Props {
   style?: any;

package/src/markdown/createResponseSchema.ts

@@ -5,7 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { MediaTypeObject } from "../openapi/types";
 import { createDescription } from "./createDescription";
 import { createDetails } from "./createDetails";
 import { createDetailsSummary } from "./createDetailsSummary";
@@ -16,6 +15,7 @@ import {
   createResponseExamples,
 } from "./createStatusCodes";
 import { create, guard } from "./utils";
+import { MediaTypeObject } from "../openapi/types";
 
 interface Props {
   style?: any;

package/src/markdown/createSchema.test.ts

@@ -7,8 +7,8 @@
 
 import * as prettier from "prettier";
 
-import { SchemaObject } from "../openapi/types";
 import { createNodes } from "./createSchema";
+import { SchemaObject } from "../openapi/types";
 
 describe("createNodes", () => {
   it("should create readable MODs for oneOf primitive properties", async () => {

package/src/markdown/createSchema.ts

@@ -7,7 +7,6 @@
 
 import clsx from "clsx";
 
-import { SchemaObject } from "../openapi/types";
 import {
   createClosingArrayBracket,
   createOpeningArrayBracket,
@@ -17,6 +16,7 @@ import { createDetails } from "./createDetails";
 import { createDetailsSummary } from "./createDetailsSummary";
 import { getQualifierMessage, getSchemaName } from "./schema";
 import { create, guard } from "./utils";
+import { SchemaObject } from "../openapi/types";
 
 const jsonSchemaMergeAllOf = require("json-schema-merge-allof");
 

package/src/markdown/createStatusCodes.ts

@@ -7,14 +7,14 @@
 
 import format from "xml-formatter";
 
-import { sampleResponseFromSchema } from "../openapi/createResponseExample";
-import { ApiItem } from "../types";
 import { createDescription } from "./createDescription";
 import { createDetails } from "./createDetails";
 import { createDetailsSummary } from "./createDetailsSummary";
 import { createResponseSchema } from "./createResponseSchema";
 import { create } from "./utils";
 import { guard } from "./utils";
+import { sampleResponseFromSchema } from "../openapi/createResponseExample";
+import { ApiItem } from "../types";
 
 export default function json2xml(o: any, tab: any) {
   var toXml = function (v: any, name: string, ind: any) {
@@ -54,6 +54,8 @@ export default function json2xml(o: any, tab: any) {
 }
 
 interface Props {
+  id?: string;
+  label?: string;
   responses: ApiItem["responses"];
 }
 
@@ -125,7 +127,7 @@ export function createResponseExamples(
           value: `${exampleName}`,
           children: [
             guard(exampleValue.summary, (summary) => [
-              create("p", {
+              create("Markdown", {
                 children: ` ${summary}`,
               }),
             ]),
@@ -141,7 +143,7 @@ export function createResponseExamples(
         value: `${exampleName}`,
         children: [
           guard(exampleValue.summary, (summary) => [
-            create("p", {
+            create("Markdown", {
               children: ` ${summary}`,
             }),
           ]),
@@ -169,7 +171,7 @@ export function createResponseExample(responseExample: any, mimeType: string) {
       value: `Example`,
       children: [
         guard(responseExample.summary, (summary) => [
-          create("p", {
+          create("Markdown", {
             children: ` ${summary}`,
           }),
         ]),
@@ -185,7 +187,7 @@ export function createResponseExample(responseExample: any, mimeType: string) {
     value: `Example`,
     children: [
       guard(responseExample.summary, (summary) => [
-        create("p", {
+        create("Markdown", {
           children: ` ${summary}`,
         }),
       ]),
@@ -254,7 +256,7 @@ export function createExampleFromSchema(schema: any, mimeType: string) {
   return undefined;
 }
 
-export function createStatusCodes({ responses }: Props) {
+export function createStatusCodes({ label, id, responses }: Props) {
   if (responses === undefined) {
     return undefined;
   }
@@ -269,6 +271,8 @@ export function createStatusCodes({ responses }: Props) {
       create("div", {
         children: [
           create("ApiTabs", {
+            label,
+            id,
             children: codes.map((code) => {
               const responseHeaders: any = responses[code].headers;
               return create("TabItem", {

package/src/markdown/index.ts

@@ -5,15 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import {
-  ContactObject,
-  LicenseObject,
-  MediaTypeObject,
-  SecuritySchemeObject,
-} from "../openapi/types";
-import { ApiPageMetadata, InfoPageMetadata, TagPageMetadata } from "../types";
 import { createAuthentication } from "./createAuthentication";
 import { createAuthorization } from "./createAuthorization";
+import { createCallbacks } from "./createCallbacks";
 import { createContactInfo } from "./createContactInfo";
 import { createDeprecationNotice } from "./createDeprecationNotice";
 import { createDescription } from "./createDescription";
@@ -30,8 +24,15 @@ import { createTermsOfService } from "./createTermsOfService";
 import { createVendorExtensions } from "./createVendorExtensions";
 import { createVersionBadge } from "./createVersionBadge";
 import { render } from "./utils";
+import {
+  ContactObject,
+  LicenseObject,
+  MediaTypeObject,
+  SecuritySchemeObject,
+} from "../openapi/types";
+import { ApiPageMetadata, InfoPageMetadata, TagPageMetadata } from "../types";
 
-interface Props {
+interface RequestBodyProps {
   title: string;
   body: {
     content?: {
@@ -54,6 +55,7 @@ export function createApiPageMD({
     parameters,
     requestBody,
     responses,
+    callbacks,
   },
   infoPath,
   frontMatter,
@@ -68,11 +70,15 @@ export function createApiPageMD({
     `import ResponseSamples from "@theme/ResponseSamples";\n`,
     `import SchemaItem from "@theme/SchemaItem";\n`,
     `import SchemaTabs from "@theme/SchemaTabs";\n`,
+    `import Markdown from "@theme/Markdown";\n`,
+    `import OperationTabs from "@theme/OperationTabs";\n`,
     `import TabItem from "@theme/TabItem";\n\n`,
     createHeading(title),
     createMethodEndpoint(method, path),
     infoPath && createAuthorization(infoPath),
-    frontMatter.show_extensions && createVendorExtensions(extensions),
+    frontMatter.show_extensions
+      ? createVendorExtensions(extensions)
+      : undefined,
     createDeprecationNotice({ deprecated, description: deprecatedDescription }),
     createDescription(description),
     createRequestHeader("Request"),
@@ -83,8 +89,9 @@ export function createApiPageMD({
     createRequestBodyDetails({
       title: "Body",
       body: requestBody,
-    } as Props),
+    } as RequestBodyProps),
     createStatusCodes({ responses }),
+    createCallbacks({ callbacks }),
   ]);
 }
 

package/src/markdown/utils.ts

@@ -50,8 +50,8 @@ export const lessThan =
 export const greaterThan =
   /(?<!(button|code|details|summary|hr|br|span|strong|small|table|thead|tbody|td|tr|th|h1|h2|h3|h4|h5|h6|title|p|em|b|i|u|strike|bold|a|li|ol|ul|img|svg|div|center|\/|\s|"|'))>/gu;
 export const codeFence = /`{1,3}[\s\S]*?`{1,3}/g;
-export const curlyBrackets = /\{(.*)}/g;
-export const codeBlock = /^(```.*[\s\S]*?```)$/gm;
+export const curlyBrackets = /([{|}])/g;
+export const codeBlock = /(^```.*[\s\S]*?```$|`[^`].+?`)/gm;
 
 export function clean(value: string | undefined): string {
   if (!value) {
@@ -60,14 +60,14 @@ export function clean(value: string | undefined): string {
 
   let sections = value.split(codeBlock);
   for (let sectionIndex in sections) {
-    if (!sections[sectionIndex].startsWith("```")) {
+    if (!sections[sectionIndex].startsWith("`")) {
       sections[sectionIndex] = sections[sectionIndex]
         .replace(lessThan, "&lt;")
         .replace(greaterThan, "&gt;")
         .replace(codeFence, function (match) {
           return match.replace(/\\>/g, ">");
         })
-        .replace(curlyBrackets, "\\{$1\\}");
+        .replace(curlyBrackets, "\\$1");
     }
   }
   return sections.join("");

package/src/openapi/createRequestExample.ts

@@ -8,8 +8,8 @@
 import chalk from "chalk";
 import merge from "lodash/merge";
 
-import { mergeAllOf } from "../markdown/createSchema";
 import { SchemaObject } from "./types";
+import { mergeAllOf } from "../markdown/createSchema";
 
 interface OASTypeToTypeMap {
   string: string;

package/src/openapi/createResponseExample.ts

@@ -8,8 +8,8 @@
 import chalk from "chalk";
 import merge from "lodash/merge";
 
-import { mergeAllOf } from "../markdown/createSchema";
 import { SchemaObject } from "./types";
+import { mergeAllOf } from "../markdown/createSchema";
 
 interface OASTypeToTypeMap {
   string: string;

package/src/openapi/openapi.ts

@@ -18,6 +18,9 @@ import kebabCase from "lodash/kebabCase";
 import unionBy from "lodash/unionBy";
 import uniq from "lodash/uniq";
 
+import { sampleRequestFromSchema } from "./createRequestExample";
+import { OpenApiObject, TagObject } from "./types";
+import { loadAndResolveSpec } from "./utils/loadAndResolveSpec";
 import { isURL } from "../index";
 import {
   ApiMetadata,
@@ -27,9 +30,6 @@ import {
   SidebarOptions,
   TagPageMetadata,
 } from "../types";
-import { sampleRequestFromSchema } from "./createRequestExample";
-import { OpenApiObject, TagObject } from "./types";
-import { loadAndResolveSpec } from "./utils/loadAndResolveSpec";
 
 /**
  * Convenience function for converting raw JSON to a Postman Collection object.

package/src/openapi/utils/loadAndResolveSpec.ts

@@ -13,8 +13,8 @@ import chalk from "chalk";
 // @ts-ignore
 import { convertObj } from "swagger2openapi";
 
-import { OpenApiObject } from "../types";
 import { OpenAPIParser } from "./services/OpenAPIParser";
+import { OpenApiObject } from "../types";
 
 function serializer(replacer: any, cycleReplacer: any) {
   var stack: any = [],

package/src/openapi/utils/services/OpenAPIParser.ts

@@ -7,11 +7,11 @@
 
 // @ts-nocheck
 
+import { RedocNormalizedOptions } from "./RedocNormalizedOptions";
 import { OpenAPIRef, OpenAPISchema, OpenAPISpec, Referenced } from "../types";
 import { isArray, isBoolean } from "../utils/helpers";
 import { JsonPointer } from "../utils/JsonPointer";
 import { getDefinitionName, isNamedDefinition } from "../utils/openapi";
-import { RedocNormalizedOptions } from "./RedocNormalizedOptions";
 
 export type MergedOpenAPISchema = OpenAPISchema & { parentRefs?: string[] };
 

package/src/openapi/utils/utils/openapi.ts

@@ -9,6 +9,13 @@
 
 import { dirname } from "path";
 
+import {
+  isNumeric,
+  removeQueryString,
+  resolveUrl,
+  isArray,
+  isBoolean,
+} from "./helpers";
 import { OpenAPIParser } from "../services/OpenAPIParser";
 import {
   OpenAPIEncoding,
@@ -21,13 +28,6 @@ import {
   OpenAPIServer,
   Referenced,
 } from "../types";
-import {
-  isNumeric,
-  removeQueryString,
-  resolveUrl,
-  isArray,
-  isBoolean,
-} from "./helpers";
 
 function isWildcardStatusCode(
   statusCode: string | number