docusaurus-plugin-openapi-docs 1.5.2 → 1.6.1

package/src/markdown/createStatusCodes.ts

@@ -62,46 +62,45 @@ function createResponseHeaders(responseHeaders: any) {
     create("ul", {
       style: { marginLeft: "1rem" },
       children: [
-        Object.entries(responseHeaders).map(([headerName, headerObj]) => {
-          const {
-            description,
-            schema: { type },
-            example,
-          }: any = headerObj;
+        Object.entries(responseHeaders).map(
+          ([headerName, headerObj]: [any, any]) => {
+            const { description, example }: any = headerObj;
+            const type = headerObj.schema?.type ?? "any";
 
-          return create("li", {
-            className: "schemaItem",
-            children: [
-              createDetailsSummary({
-                children: [
-                  create("strong", { children: headerName }),
-                  guard(type, () => [
-                    create("span", {
-                      style: { opacity: "0.6" },
-                      children: ` ${type}`,
-                    }),
-                  ]),
-                ],
-              }),
-              create("div", {
-                children: [
-                  guard(description, (description) =>
-                    create("div", {
-                      style: {
-                        marginTop: ".5rem",
-                        marginBottom: ".5rem",
-                      },
-                      children: [
-                        guard(example, () => `Example: ${example}`),
-                        createDescription(description),
-                      ],
-                    })
-                  ),
-                ],
-              }),
-            ],
-          });
-        }),
+            return create("li", {
+              className: "schemaItem",
+              children: [
+                createDetailsSummary({
+                  children: [
+                    create("strong", { children: headerName }),
+                    guard(type, () => [
+                      create("span", {
+                        style: { opacity: "0.6" },
+                        children: ` ${type}`,
+                      }),
+                    ]),
+                  ],
+                }),
+                create("div", {
+                  children: [
+                    guard(description, (description) =>
+                      create("div", {
+                        style: {
+                          marginTop: ".5rem",
+                          marginBottom: ".5rem",
+                        },
+                        children: [
+                          guard(example, () => `Example: ${example}`),
+                          createDescription(description),
+                        ],
+                      })
+                    ),
+                  ],
+                }),
+              ],
+            });
+          }
+        ),
       ],
     })
   );

package/src/markdown/index.ts

@@ -88,7 +88,7 @@ export function createInfoPageMD({
 }: InfoPageMetadata) {
   return render([
     `import ApiLogo from "@theme/ApiLogo";\n`,
-    `import Tabs from "@theme/Tabs";\n`,
+    `import SchemaTabs from "@theme/SchemaTabs";\n`,
     `import TabItem from "@theme/TabItem";\n`,
     `import Export from "@theme/ApiDemoPanel/Export";\n\n`,
 

package/src/markdown/utils.ts

@@ -24,7 +24,7 @@ export function guard<T>(
   value: T | undefined,
   cb: (value: T) => Children
 ): string {
-  if (value) {
+  if (!!value) {
     const children = cb(value);
     return render(children);
   }
@@ -45,5 +45,5 @@ export function render(children: Children): string {
 export const lessThan =
   /<(?!(=|button|\s?\/button|details|\s?\/details|summary|\s?\/summary|hr|\s?\/hr|br|\s?\/br|span|\s?\/span|strong|\s?\/strong|small|\s?\/small|table|\s?\/table|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|a|\s?\/a|li|\s?\/li|ol|\s?\/ol|ul|\s?\/ul|img|\s?\/img|div|\s?\/div|center|\s?\/center))/gu;
 export const greaterThan =
-  /(?<!(button|details|summary|hr|br|span|strong|small|table|td|tr|th|h1|h2|h3|h4|h5|h6|title|p|em|b|i|u|strike|a|tag|li|ol|ul|img|div|center|\/|\s|"|'))>/gu;
+  /(?<!(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|a|tag|li|ol|ul|img|div|center|\/|\s|"|'))>/gu;
 export const codeFence = /`{1,3}[\s\S]*?`{1,3}/g;

package/src/openapi/createRequestExample.ts

@@ -31,7 +31,7 @@ const primitives: Primitives = {
     default: () => "string",
     email: () => "user@example.com",
     date: () => new Date().toISOString().substring(0, 10),
-    "date-time": () => new Date().toISOString().substring(0, 10),
+    "date-time": () => new Date().toISOString(),
     uuid: () => "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     hostname: () => "example.com",
     ipv4: () => "198.51.100.42",

package/src/openapi/createResponseExample.ts

@@ -31,7 +31,7 @@ const primitives: Primitives = {
     default: () => "string",
     email: () => "user@example.com",
     date: () => new Date().toISOString().substring(0, 10),
-    "date-time": () => new Date().toISOString().substring(0, 10),
+    "date-time": () => new Date().toISOString(),
     uuid: () => "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     hostname: () => "example.com",
     ipv4: () => "198.51.100.42",

package/src/openapi/openapi.ts

@@ -88,7 +88,7 @@ function createItems(
   const infoIdSpaces = openapiData.info.title.replace(" ", "-").toLowerCase();
   const infoId = kebabCase(infoIdSpaces);
 
-  if (openapiData.info.description) {
+  if (openapiData.info.description || openapiData.info.title) {
     // Only create an info page if we have a description.
     const infoDescription = openapiData.info?.description;
     let splitDescription: any;
@@ -221,6 +221,9 @@ function createItems(
                 .replace(/\s+$/, "")
             : "",
           ...(options?.proxy && { proxy: options.proxy }),
+          ...(options?.hideSendButton && {
+            hide_send_button: options.hideSendButton,
+          }),
         },
         api: {
           ...defaults,
@@ -338,6 +341,9 @@ function createItems(
                 .replace(/\s+$/, "")
             : "",
           ...(options?.proxy && { proxy: options.proxy }),
+          ...(options?.hideSendButton && {
+            hide_send_button: options.hideSendButton,
+          }),
         },
         api: {
           ...defaults,

package/src/openapi/utils/loadAndResolveSpec.ts

@@ -128,6 +128,21 @@ export async function loadAndResolveSpec(specUrlOrObject: object | string) {
   const {
     bundle: { parsed },
   } = await bundle(bundleOpts);
+
+  //Pre-processing before resolving JSON refs
+  if (parsed.components) {
+    for (let [component, type] of Object.entries(parsed.components) as any) {
+      if (component === "schemas") {
+        for (let [schemaKey, schemaValue] of Object.entries(type) as any) {
+          const title: string | undefined = schemaValue["title"];
+          if (!title) {
+            schemaValue.title = schemaKey;
+          }
+        }
+      }
+    }
+  }
+
   const resolved = await resolveJsonRefs(parsed);
 
   // Force serialization and replace circular $ref pointers

package/src/options.ts

@@ -9,7 +9,8 @@ import { Joi } from "@docusaurus/utils-validation";
 
 const sidebarOptions = Joi.object({
   groupPathsBy: Joi.string().valid("tag"),
-  categoryLinkSource: Joi.string().valid("tag", "info"),
+  // TODO: Remove "none" in 2.0, make it the default if not specified
+  categoryLinkSource: Joi.string().valid("tag", "info", "none"),
   customProps: Joi.object(),
   sidebarCollapsible: Joi.boolean(),
   sidebarCollapsed: Joi.boolean(),
@@ -27,6 +28,7 @@ export const OptionsSchema = Joi.object({
         outputDir: Joi.string().required(),
         template: Joi.string(),
         downloadUrl: Joi.string(),
+        hideSendButton: Joi.boolean(),
         sidebarOptions: sidebarOptions,
         version: Joi.string().when("versions", {
           is: Joi.exist(),

package/src/sidebars/index.ts

@@ -41,7 +41,11 @@ function groupByTags(
   tags: TagObject[][],
   docPath: string
 ): ProcessedSidebar {
-  const { outputDir, label } = options;
+  let { outputDir, label } = options;
+
+  // Remove trailing slash before proceeding
+  outputDir = outputDir.replace(/\/$/, "");
+
   const {
     sidebarCollapsed,
     sidebarCollapsible,
@@ -214,6 +218,7 @@ export default function generateSidebarSlice(
   docPath: string
 ) {
   let sidebarSlice: ProcessedSidebar = [];
+
   if (sidebarOptions.groupPathsBy === "tag") {
     sidebarSlice = groupByTags(
       api as ApiPageMetadata[],

package/src/types.ts

@@ -33,6 +33,7 @@ export interface APIOptions {
   outputDir: string;
   template?: string;
   downloadUrl?: string;
+  hideSendButton?: boolean;
   sidebarOptions?: SidebarOptions;
   version?: string;
   label?: string;