OpenAPI: Support adding description to generated document body

.changeset/thirty-mice-push.md

@@ -0,0 +1,5 @@
+---
+'fumadocs-openapi': patch
+---
+
+Support adding `description` to generated document body

packages/openapi/src/generate.ts

@@ -51,6 +51,13 @@ export interface GenerateOptions {
     context: DocumentContext,
   ) => Record<string, unknown>;
 
+  /**
+   * Add description to document body
+   *
+   * @defaultValue false
+   */
+  includeDescription?: boolean;
+
   cwd?: string;
 }
 

packages/openapi/src/utils/generate-document.ts

@@ -22,7 +22,7 @@ export function generateDocument(
     context: DocumentContext;
   },
 ): string {
-  const { frontmatter } = options;
+  const { frontmatter, includeDescription = false } = options;
   const out: string[] = [];
   const extend = frontmatter?.(
     options.title,
@@ -64,6 +64,8 @@ export function generateDocument(
     out.push(imports);
   }
 
+  if (options.description && includeDescription) out.push(options.description);
+
   out.push(pageContent(options.page));
 
   return out.join('\n\n');