fumadocs-openapi 5.11.3 → 5.11.4

package/dist/index.d.ts

@@ -179,6 +179,7 @@ type ReferenceObject = OpenAPIV3_1.ReferenceObject;
 type PathItemObject = OpenAPIV3_1.PathItemObject;
 type TagObject = OpenAPIV3_1.TagObject;
 type ServerObject = NoReference<OpenAPIV3_1.ServerObject>;
+type CallbackObject = NoReference<OpenAPIV3_1.CallbackObject>;
 type MethodInformation = NoReference<OperationObject> & {
     method: string;
 };
@@ -215,6 +216,10 @@ interface RenderContext {
      */
     generateCodeSamples?: (endpoint: EndpointSample) => Awaitable<CodeSample[]>;
     shikiOptions?: Omit<CodeToHastOptionsCommon, 'lang'> & CodeOptionsThemes<BuiltinTheme>;
+    /**
+     * Show full response schema instead of only example response & Typescript definitions
+     */
+    showResponseSchema?: boolean;
 }
 
 type DocumentInput = string | OpenAPIV3_1.Document | OpenAPIV3.Document;
@@ -317,4 +322,4 @@ interface Config extends GenerateOptions {
 }
 declare function generateFiles(options: Config): Promise<void>;
 
-export { type Config, type DereferenceMap, type Document, type GenerateOptions, type GeneratePageOutput, type GenerateTagOutput, type MethodInformation, type OperationObject, type ParameterObject, type PathItemObject, type ReferenceObject, type RenderContext, type SecurityRequirementObject, type SecuritySchemeObject, type ServerObject, type TagObject, generateAll, generateFiles, generatePages, generateTags };
+export { type CallbackObject, type Config, type DereferenceMap, type Document, type GenerateOptions, type GeneratePageOutput, type GenerateTagOutput, type MethodInformation, type OperationObject, type ParameterObject, type PathItemObject, type ReferenceObject, type RenderContext, type SecurityRequirementObject, type SecuritySchemeObject, type ServerObject, type TagObject, generateAll, generateFiles, generatePages, generateTags };

package/dist/server/index.d.ts

@@ -208,11 +208,15 @@ interface RenderContext {
      */
     generateCodeSamples?: (endpoint: EndpointSample) => Awaitable<CodeSample[]>;
     shikiOptions?: Omit<CodeToHastOptionsCommon, 'lang'> & CodeOptionsThemes<BuiltinTheme>;
+    /**
+     * Show full response schema instead of only example response & Typescript definitions
+     */
+    showResponseSchema?: boolean;
 }
 
 type DocumentInput = string | OpenAPIV3_1.Document | OpenAPIV3.Document;
 
-type ApiPageContextProps = Pick<Partial<RenderContext>, 'shikiOptions' | 'generateTypeScriptSchema' | 'generateCodeSamples' | 'proxyUrl'>;
+type ApiPageContextProps = Pick<Partial<RenderContext>, 'shikiOptions' | 'generateTypeScriptSchema' | 'generateCodeSamples' | 'proxyUrl' | 'showResponseSchema'>;
 interface ApiPageProps extends ApiPageContextProps {
     document: DocumentInput;
     hasHead: boolean;

package/dist/server/index.js

@@ -796,6 +796,7 @@ function Operation({ type = 'operation', path, method, ctx, hasHead, headingLeve
     const security = method.security ?? ctx.document.security;
     let headNode = null;
     let bodyNode = null;
+    let responseNode = null;
     let callbacksNode = null;
     if (hasHead) {
         const title = method.summary ?? (method.operationId ? idToTitle(method.operationId) : path);
@@ -843,6 +844,38 @@ function Operation({ type = 'operation', path, method, ctx, hasHead, headingLeve
             ]
         });
     }
+    if (method.responses && ctx.showResponseSchema) {
+        responseNode = /*#__PURE__*/ jsxs(Fragment, {
+            children: [
+                heading(headingLevel, 'Response Body', ctx),
+                Object.entries(method.responses).map(([status, response])=>{
+                    if (!response.content) return;
+                    const mediaType = getPreferredType(response.content);
+                    if (!mediaType) return null;
+                    const content = response.content[mediaType];
+                    if (!content.schema) return null;
+                    return /*#__PURE__*/ jsxs(Fragment$1, {
+                        children: [
+                            heading(headingLevel + 1, status, ctx),
+                            /*#__PURE__*/ jsx(Markdown, {
+                                text: response.description
+                            }),
+                            /*#__PURE__*/ jsx(Schema, {
+                                name: "response",
+                                schema: content.schema,
+                                ctx: {
+                                    render: ctx,
+                                    writeOnly: false,
+                                    readOnly: true,
+                                    required: true
+                                }
+                            })
+                        ]
+                    }, status);
+                })
+            ]
+        });
+    }
     const parameterGroups = new Map();
     const endpoint = generateSample(path, method, ctx);
     for (const param of method.parameters ?? []){
@@ -877,28 +910,11 @@ function Operation({ type = 'operation', path, method, ctx, hasHead, headingLeve
         callbacksNode = /*#__PURE__*/ jsxs(Fragment, {
             children: [
                 heading(headingLevel, 'Webhooks', ctx),
-                Object.entries(method.callbacks).map(([name, callback])=>{
-                    const nodes = Object.entries(callback).map(([path, pathItem])=>{
-                        const pathNodes = methodKeys.map((method)=>{
-                            const operation = pathItem[method];
-                            if (!operation) return null;
-                            return /*#__PURE__*/ jsx(Operation, {
-                                type: "webhook",
-                                hasHead: true,
-                                path: path,
-                                headingLevel: headingLevel + 1,
-                                method: createMethod(method, pathItem, operation),
-                                ctx: ctx
-                            }, method);
-                        });
-                        return /*#__PURE__*/ jsx(Fragment$1, {
-                            children: pathNodes
-                        }, path);
-                    });
-                    return /*#__PURE__*/ jsx(Fragment$1, {
-                        children: nodes
-                    }, name);
-                })
+                Object.entries(method.callbacks).map(([name, callback])=>/*#__PURE__*/ jsx(WebhookCallback, {
+                        callback: callback,
+                        ctx: ctx,
+                        headingLevel: headingLevel
+                    }, name))
             ]
         });
     }
@@ -930,6 +946,7 @@ function Operation({ type = 'operation', path, method, ctx, hasHead, headingLeve
                     ]
                 }, group);
             }),
+            responseNode,
             callbacksNode
         ]
     });
@@ -1005,6 +1022,25 @@ async function APIExample({ method, endpoint, ctx }) {
         children: children
     });
 }
+function WebhookCallback({ callback, ctx, headingLevel }) {
+    return Object.entries(callback).map(([path, pathItem])=>{
+        const pathNodes = methodKeys.map((method)=>{
+            const operation = pathItem[method];
+            if (!operation) return null;
+            return /*#__PURE__*/ jsx(Operation, {
+                type: "webhook",
+                hasHead: true,
+                path: path,
+                headingLevel: headingLevel + 1,
+                method: createMethod(method, pathItem, operation),
+                ctx: ctx
+            }, method);
+        });
+        return /*#__PURE__*/ jsx(Fragment$1, {
+            children: pathNodes
+        }, path);
+    });
+}
 /**
  * Remove duplicated labels
  */ function dedupe(samples) {
@@ -1031,28 +1067,7 @@ function AuthSection({ ctx: { document, renderer }, requirements }) {
                     })
                 ]
             }) : null;
-            if (schema.type === 'http') {
-                info.push(/*#__PURE__*/ jsxs(renderer.Property, {
-                    name: "Authorization",
-                    type: prefix ? `${prefix} <token>` : '<token>',
-                    required: true,
-                    children: [
-                        schema.description ? /*#__PURE__*/ jsx(Markdown, {
-                            text: schema.description
-                        }) : null,
-                        /*#__PURE__*/ jsxs("p", {
-                            children: [
-                                "In: ",
-                                /*#__PURE__*/ jsx("code", {
-                                    children: "header"
-                                }),
-                                scopeElement
-                            ]
-                        })
-                    ]
-                }, id++));
-            }
-            if (schema.type === 'oauth2') {
+            if (schema.type === 'http' || schema.type === 'oauth2') {
                 info.push(/*#__PURE__*/ jsxs(renderer.Property, {
                     name: "Authorization",
                     type: prefix ? `${prefix} <token>` : '<token>',
@@ -1312,6 +1327,7 @@ async function getContext({ document, dereferenceMap }, options = {}) {
         document: document,
         dereferenceMap,
         proxyUrl: options.proxyUrl,
+        showResponseSchema: options.showResponseSchema,
         renderer: {
             ...createRenders(options.shikiOptions),
             ...options.renderer

package/dist/ui/index.d.ts

@@ -82,6 +82,10 @@ interface RenderContext {
      */
     generateCodeSamples?: (endpoint: EndpointSample) => Awaitable<CodeSample[]>;
     shikiOptions?: Omit<CodeToHastOptionsCommon, 'lang'> & CodeOptionsThemes<BuiltinTheme>;
+    /**
+     * Show full response schema instead of only example response & Typescript definitions
+     */
+    showResponseSchema?: boolean;
 }
 
 interface BaseRequestField {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "5.11.3",
+  "version": "5.11.4",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "NextJs",
@@ -47,8 +47,8 @@
     "remark-rehype": "^11.1.1",
     "shiki": "^1.26.1",
     "xml-js": "^1.6.11",
-    "fumadocs-core": "14.7.2",
-    "fumadocs-ui": "14.7.2"
+    "fumadocs-core": "14.7.3",
+    "fumadocs-ui": "14.7.3"
   },
   "devDependencies": {
     "@types/js-yaml": "^4.0.9",