fumadocs-openapi/dist/utils/pages/to-text.d.ts

Generate MDX docs for your OpenAPI spec

import "./builder.js";
import { TagObject } from "../../types.js";
import "../process-document.js";

//#region src/utils/pages/to-text.d.ts
interface PagesToTextOptions {
  /**
   * Additional imports of your MDX components.
   */
  imports?: {
    names: string[];
    from: string;
  }[];
  /**
   * Customise frontmatter.
   *
   * A `full: true` property will be added by default.
   */
  frontmatter?: (title: string, description: string | undefined, context: DocumentContext) => Record<string, unknown>;
  /**
   * Add description to document body.
   *
   * We recommend but don't enable it by default because some OpenAPI schemas have invalid description that breaks MDX syntax.
   *
   * @defaultValue false
   */
  includeDescription?: boolean;
  /**
   * Add a comment to the top of generated files indicating they are auto-generated.
   * - `true`: Adds a standardized comment
   * - `false`: No comment is added
   * - `string`: Adds the provided custom comment
   *
   * @defaultValue true
   */
  addGeneratedComment?: boolean | string;
}
type DocumentContext = {
  type: 'tag';
  tag: TagObject | undefined;
} | {
  type: 'operation';
} | {
  type: 'file';
};
//#endregion
export { PagesToTextOptions };
//# sourceMappingURL=to-text.d.ts.map