docusaurus-plugin-openapi-docs 1.5.1 → 1.6.0

package/src/openapi/createRequestExample.ts

@@ -6,6 +6,7 @@
  * ========================================================================== */
 
 import chalk from "chalk";
+import merge from "lodash/merge";
 
 import { mergeAllOf } from "../markdown/createRequestSchema";
 import { SchemaObject } from "./types";
@@ -30,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",
@@ -77,18 +78,30 @@ function sampleRequestFromProp(name: string, prop: any, obj: any): any {
 
 export const sampleRequestFromSchema = (schema: SchemaObject = {}): any => {
   try {
-    let { type, example, allOf, properties, items, oneOf, anyOf } = schema;
+    // deep copy schema before processing
+    let schemaCopy = JSON.parse(JSON.stringify(schema));
+    let { type, example, allOf, properties, items, oneOf, anyOf } = schemaCopy;
 
     if (example !== undefined) {
       return example;
     }
 
     if (oneOf) {
+      if (properties) {
+        const combinedSchemas = merge(schemaCopy, oneOf[0]);
+        delete combinedSchemas.oneOf;
+        return sampleRequestFromSchema(combinedSchemas);
+      }
       // Just go with first schema
       return sampleRequestFromSchema(oneOf[0]);
     }
 
     if (anyOf) {
+      if (properties) {
+        const combinedSchemas = merge(schemaCopy, anyOf[0]);
+        delete combinedSchemas.anyOf;
+        return sampleRequestFromSchema(combinedSchemas);
+      }
       // Just go with first schema
       return sampleRequestFromSchema(anyOf[0]);
     }
@@ -103,6 +116,11 @@ export const sampleRequestFromSchema = (schema: SchemaObject = {}): any => {
           }
         }
       }
+      if (properties) {
+        const combinedSchemas = merge(schemaCopy, mergedSchemas);
+        delete combinedSchemas.allOf;
+        return sampleRequestFromSchema(combinedSchemas);
+      }
       return sampleRequestFromSchema(mergedSchemas);
     }
 
@@ -118,9 +136,9 @@ export const sampleRequestFromSchema = (schema: SchemaObject = {}): any => {
 
     if (type === "object") {
       let obj: any = {};
-      for (let [name, prop] of Object.entries(properties ?? {})) {
+      for (let [name, prop] of Object.entries(properties ?? {}) as any) {
         if (prop.properties) {
-          for (const [key, value] of Object.entries(prop.properties)) {
+          for (const [key, value] of Object.entries(prop.properties) as any) {
             if (
               (value.readOnly && value.readOnly === true) ||
               value.deprecated
@@ -131,7 +149,9 @@ export const sampleRequestFromSchema = (schema: SchemaObject = {}): any => {
         }
 
         if (prop.items && prop.items.properties) {
-          for (const [key, value] of Object.entries(prop.items.properties)) {
+          for (const [key, value] of Object.entries(
+            prop.items.properties
+          ) as any) {
             if (
               (value.readOnly && value.readOnly === true) ||
               value.deprecated
@@ -157,28 +177,31 @@ export const sampleRequestFromSchema = (schema: SchemaObject = {}): any => {
 
     if (type === "array") {
       if (Array.isArray(items?.anyOf)) {
-        return items?.anyOf.map((item) => sampleRequestFromSchema(item));
+        return items?.anyOf.map((item: any) => sampleRequestFromSchema(item));
       }
 
       if (Array.isArray(items?.oneOf)) {
-        return items?.oneOf.map((item) => sampleRequestFromSchema(item));
+        return items?.oneOf.map((item: any) => sampleRequestFromSchema(item));
       }
 
       return [sampleRequestFromSchema(items)];
     }
 
-    if (schema.enum) {
-      if (schema.default) {
-        return schema.default;
+    if (schemaCopy.enum) {
+      if (schemaCopy.default) {
+        return schemaCopy.default;
       }
-      return normalizeArray(schema.enum)[0];
+      return normalizeArray(schemaCopy.enum)[0];
     }
 
-    if ((schema.readOnly && schema.readOnly === true) || schema.deprecated) {
+    if (
+      (schema.readOnly && schema.readOnly === true) ||
+      schemaCopy.deprecated
+    ) {
       return undefined;
     }
 
-    return primitive(schema);
+    return primitive(schemaCopy);
   } catch (err) {
     console.error(
       chalk.yellow("WARNING: failed to create example from schema object:", err)

package/src/openapi/createResponseExample.ts

@@ -6,6 +6,7 @@
  * ========================================================================== */
 
 import chalk from "chalk";
+import merge from "lodash/merge";
 
 import { mergeAllOf } from "../markdown/createResponseSchema";
 import { SchemaObject } from "./types";
@@ -30,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",
@@ -77,7 +78,9 @@ function sampleResponseFromProp(name: string, prop: any, obj: any): any {
 
 export const sampleResponseFromSchema = (schema: SchemaObject = {}): any => {
   try {
-    let { type, example, allOf, oneOf, anyOf, properties, items } = schema;
+    // deep copy schema before processing
+    let schemaCopy = JSON.parse(JSON.stringify(schema));
+    let { type, example, allOf, properties, items, oneOf, anyOf } = schemaCopy;
 
     if (example !== undefined) {
       return example;
@@ -96,15 +99,30 @@ export const sampleResponseFromSchema = (schema: SchemaObject = {}): any => {
           }
         }
       }
+      if (properties) {
+        const combinedSchemas = merge(schemaCopy, mergedSchemas);
+        delete combinedSchemas.allOf;
+        return sampleResponseFromSchema(combinedSchemas);
+      }
       return sampleResponseFromSchema(mergedSchemas);
     }
 
     if (oneOf) {
+      if (properties) {
+        const combinedSchemas = merge(schemaCopy, oneOf[0]);
+        delete combinedSchemas.oneOf;
+        return sampleResponseFromSchema(combinedSchemas);
+      }
       // Just go with first schema
       return sampleResponseFromSchema(oneOf[0]);
     }
 
     if (anyOf) {
+      if (properties) {
+        const combinedSchemas = merge(schemaCopy, anyOf[0]);
+        delete combinedSchemas.anyOf;
+        return sampleResponseFromSchema(combinedSchemas);
+      }
       // Just go with first schema
       return sampleResponseFromSchema(anyOf[0]);
     }
@@ -121,9 +139,9 @@ export const sampleResponseFromSchema = (schema: SchemaObject = {}): any => {
 
     if (type === "object") {
       let obj: any = {};
-      for (let [name, prop] of Object.entries(properties ?? {})) {
+      for (let [name, prop] of Object.entries(properties ?? {}) as any) {
         if (prop.properties) {
-          for (const [key, value] of Object.entries(prop.properties)) {
+          for (const [key, value] of Object.entries(prop.properties) as any) {
             if (
               (value.writeOnly && value.writeOnly === true) ||
               value.deprecated
@@ -134,7 +152,9 @@ export const sampleResponseFromSchema = (schema: SchemaObject = {}): any => {
         }
 
         if (prop.items && prop.items.properties) {
-          for (const [key, value] of Object.entries(prop.items.properties)) {
+          for (const [key, value] of Object.entries(
+            prop.items.properties
+          ) as any) {
             if (
               (value.writeOnly && value.writeOnly === true) ||
               value.deprecated
@@ -160,28 +180,31 @@ export const sampleResponseFromSchema = (schema: SchemaObject = {}): any => {
 
     if (type === "array") {
       if (Array.isArray(items?.anyOf)) {
-        return items?.anyOf.map((item) => sampleResponseFromSchema(item));
+        return items?.anyOf.map((item: any) => sampleResponseFromSchema(item));
       }
 
       if (Array.isArray(items?.oneOf)) {
-        return items?.oneOf.map((item) => sampleResponseFromSchema(item));
+        return items?.oneOf.map((item: any) => sampleResponseFromSchema(item));
       }
 
       return [sampleResponseFromSchema(items)];
     }
 
-    if (schema.enum) {
-      if (schema.default) {
-        return schema.default;
+    if (schemaCopy.enum) {
+      if (schemaCopy.default) {
+        return schemaCopy.default;
       }
-      return normalizeArray(schema.enum)[0];
+      return normalizeArray(schemaCopy.enum)[0];
     }
 
-    if ((schema.writeOnly && schema.writeOnly === true) || schema.deprecated) {
+    if (
+      (schemaCopy.writeOnly && schemaCopy.writeOnly === true) ||
+      schemaCopy.deprecated
+    ) {
       return undefined;
     }
 
-    return primitive(schema);
+    return primitive(schemaCopy);
   } catch (err) {
     console.error(
       chalk.yellow("WARNING: failed to create example from schema object:", err)

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

@@ -27,6 +27,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;