fumadocs-openapi 5.11.2 → 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>',
@@ -1251,6 +1266,14 @@ const cache = new Map();
     return processed;
 }
 
+function getUrl(url, variables) {
+    let out = url;
+    for (const [key, value] of Object.entries(variables)){
+        out = out.replaceAll(`{${key}}`, value);
+    }
+    return out;
+}
+
 async function APIPage(props) {
     const { operations, hasHead = true, webhooks, disableCache = process.env.NODE_ENV === 'development' } = props;
     const processed = await processDocument(props.document, disableCache);
@@ -1294,10 +1317,17 @@ async function APIPage(props) {
     });
 }
 async function getContext({ document, dereferenceMap }, options = {}) {
+    const servers = document.servers && document.servers.length > 0 ? document.servers : [
+        {
+            url: 'https://example.com'
+        }
+    ];
+    const server = servers[0];
     return {
         document: document,
         dereferenceMap,
         proxyUrl: options.proxyUrl,
+        showResponseSchema: options.showResponseSchema,
         renderer: {
             ...createRenders(options.shikiOptions),
             ...options.renderer
@@ -1305,8 +1335,11 @@ async function getContext({ document, dereferenceMap }, options = {}) {
         shikiOptions: options.shikiOptions,
         generateTypeScriptSchema: options.generateTypeScriptSchema,
         generateCodeSamples: options.generateCodeSamples,
-        baseUrl: document.servers?.[0].url ?? 'https://example.com',
-        servers: document.servers ?? [],
+        baseUrl: getUrl(server.url, server.variables ? Object.fromEntries(Object.entries(server.variables).map(([k, v])=>[
+                k,
+                v.default
+            ])) : {}),
+        servers,
         slugger: new Slugger()
     };
 }

package/dist/ui/{client-client-Dxsry8Mu.js → client-client-Co3JBILS.js}

@@ -314,14 +314,14 @@ const Select = SelectPrimitive.Root;
 const SelectValue = SelectPrimitive.Value;
 const SelectTrigger = /*#__PURE__*/ forwardRef(({ className, children, ...props }, ref)=>/*#__PURE__*/ jsxs(SelectPrimitive.Trigger, {
         ref: ref,
-        className: cn('flex h-10 items-center justify-between rounded-md border px-3 py-2 text-sm text-fd-foreground hover:bg-fd-accent focus:outline-none focus:ring-2 focus:ring-fd-ring disabled:cursor-not-allowed disabled:opacity-50', className),
+        className: cn('flex h-10 items-center rounded-md border px-3 py-2 text-start text-sm text-fd-foreground hover:bg-fd-accent focus:outline-none focus:ring-2 focus:ring-fd-ring disabled:cursor-not-allowed disabled:opacity-50', className),
         ...props,
         children: [
             children,
             /*#__PURE__*/ jsx(SelectPrimitive.Icon, {
                 asChild: true,
                 children: /*#__PURE__*/ jsx(ChevronDown, {
-                    className: "size-4 text-fd-muted-foreground"
+                    className: "ms-auto size-4 text-fd-muted-foreground"
                 })
             })
         ]
@@ -407,7 +407,7 @@ function useSchemaContext() {
     return ctx;
 }
 
-const APIPlayground = dynamic(()=>import('./index-client-wsc_5cAY.js').then(function (n) { return n.i; }).then((mod)=>mod.APIPlayground));
+const APIPlayground = dynamic(()=>import('./index-client-cz-xNo9A.js').then(function (n) { return n.i; }).then((mod)=>mod.APIPlayground));
 function Root({ children, baseUrl, className, shikiOptions, servers, ...props }) {
     return /*#__PURE__*/ jsx("div", {
         className: cn('flex flex-col gap-24 text-sm text-fd-muted-foreground', className),
@@ -450,11 +450,11 @@ function ServerSelect() {
         className: "-m-2 mt-2",
         children: [
             /*#__PURE__*/ jsxs(CollapsibleTrigger, {
-                className: "flex w-full flex-row items-center justify-between p-2 text-xs font-medium",
+                className: "flex w-full flex-row items-center justify-between p-2 text-xs font-medium text-fd-muted-foreground",
                 children: [
                     "Configure Server",
                     /*#__PURE__*/ jsx(ChevronDown, {
-                        className: "size-4 text-fd-muted-foreground"
+                        className: "size-4"
                     })
                 ]
             }),
@@ -467,7 +467,7 @@ function ServerSelect() {
                             onValueChange: setServer,
                             children: [
                                 /*#__PURE__*/ jsx(SelectTrigger, {
-                                    className: "h-auto",
+                                    className: "h-auto break-all",
                                     children: /*#__PURE__*/ jsx(SelectValue, {})
                                 }),
                                 /*#__PURE__*/ jsx(SelectContent, {
@@ -535,4 +535,4 @@ function ServerSelect() {
     });
 }
 
-export { APIPlayground as A, CircleCheck as C, Input as I, Plus as P, Root as R, Select as S, Trash2 as T, SelectTrigger as a, SelectValue as b, SelectContent as c, SelectItem as d, CircleX as e, useApiContext as f, SchemaContext as g, getUrl as h, CopyRouteButton as i, ServerSelect as j, useSchemaContext as u };
+export { APIPlayground as A, CircleCheck as C, Input as I, Plus as P, Root as R, Select as S, Trash2 as T, SelectTrigger as a, SelectValue as b, SelectContent as c, SelectItem as d, CircleX as e, useApiContext as f, SchemaContext as g, ChevronDown as h, getUrl as i, CopyRouteButton as j, ServerSelect as k, useSchemaContext as u };

package/dist/ui/{fetcher-C0NHTJev.js → fetcher-DLRl_kVF.js}

@@ -1,4 +1,4 @@
-import { r as resolve } from './index-client-wsc_5cAY.js';
+import { r as resolve } from './index-client-cz-xNo9A.js';
 
 /**
  * @param bodySchema - schema of body

package/dist/ui/{index-client-wsc_5cAY.js → index-client-cz-xNo9A.js}

@@ -2,9 +2,9 @@
 import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
 import { forwardRef, useId, createContext, useContext, useState, useCallback, useRef, useEffect, useMemo } from 'react';
 import { FormProvider, Controller, useFormContext, useFieldArray, useForm, useWatch } from 'react-hook-form';
-import { Accordions, Accordion } from 'fumadocs-ui/components/accordion';
+import { Collapsible, CollapsibleTrigger, CollapsibleContent } from 'fumadocs-ui/components/ui/collapsible';
 import { cn, buttonVariants } from 'fumadocs-ui/components/api';
-import { u as useSchemaContext, T as Trash2, I as Input, S as Select, a as SelectTrigger, b as SelectValue, c as SelectContent, d as SelectItem, P as Plus, C as CircleCheck, e as CircleX, f as useApiContext, g as SchemaContext, h as getUrl } from './client-client-Dxsry8Mu.js';
+import { u as useSchemaContext, T as Trash2, I as Input, S as Select, a as SelectTrigger, b as SelectValue, c as SelectContent, d as SelectItem, P as Plus, C as CircleCheck, e as CircleX, f as useApiContext, g as SchemaContext, h as ChevronDown, i as getUrl } from './client-client-Co3JBILS.js';
 import { Slot } from '@radix-ui/react-slot';
 import { cva } from 'class-variance-authority';
 import { useOnChange } from 'fumadocs-core/utils/use-on-change';
@@ -645,7 +645,7 @@ function APIPlayground({ route, method = 'GET', authorization, path = [], header
         }
     });
     const testQuery = useQuery(async (input)=>{
-        const fetcher = await import('./fetcher-C0NHTJev.js').then((mod)=>mod.createBrowserFetcher(body, schemas));
+        const fetcher = await import('./fetcher-DLRl_kVF.js').then((mod)=>mod.createBrowserFetcher(body, schemas));
         const serverUrl = serverRef.current ? getUrl(serverRef.current.url, serverRef.current.variables) : window.location.origin;
         let url = `${serverUrl}${createPathnameFromInput(route, input.path, input.query)}`;
         if (proxyUrl) {
@@ -704,7 +704,6 @@ function APIPlayground({ route, method = 'GET', authorization, path = [], header
             field: info
         }, key);
     }
-    const isParamEmpty = path.length === 0 && query.length === 0 && header.length === 0 && body === undefined;
     return /*#__PURE__*/ jsx(Form, {
         ...form,
         children: /*#__PURE__*/ jsx(SchemaContext.Provider, {
@@ -728,7 +727,7 @@ function APIPlayground({ route, method = 'GET', authorization, path = [], header
                             /*#__PURE__*/ jsx("button", {
                                 type: "submit",
                                 className: cn(buttonVariants({
-                                    color: 'outline'
+                                    color: 'secondary'
                                 })),
                                 disabled: testQuery.isLoading,
                                 children: "Send"
@@ -736,39 +735,24 @@ function APIPlayground({ route, method = 'GET', authorization, path = [], header
                         ]
                     }),
                     authorization ? renderCustomField('authorization', authorization, fields.auth) : null,
-                    !isParamEmpty ? /*#__PURE__*/ jsxs(Accordions, {
-                        type: "multiple",
-                        className: "-m-3 border-0 bg-transparent text-sm",
-                        children: [
-                            path.length > 0 ? /*#__PURE__*/ jsx(Accordion, {
-                                title: "Path",
-                                children: /*#__PURE__*/ jsx("div", {
-                                    className: "flex flex-col gap-4",
-                                    children: path.map((field)=>renderCustomField(`path.${field.name}`, field, fields.path, field.name))
-                                })
-                            }) : null,
-                            query.length > 0 ? /*#__PURE__*/ jsx(Accordion, {
-                                title: "Query",
-                                children: /*#__PURE__*/ jsx("div", {
-                                    className: "flex flex-col gap-4",
-                                    children: query.map((field)=>renderCustomField(`query.${field.name}`, field, fields.query, field.name))
-                                })
-                            }) : null,
-                            header.length > 0 ? /*#__PURE__*/ jsx(Accordion, {
-                                title: "Headers",
-                                children: /*#__PURE__*/ jsx("div", {
-                                    className: "flex flex-col gap-4",
-                                    children: header.map((field)=>renderCustomField(`header.${field.name}`, field, fields.header, field.name))
-                                })
-                            }) : null,
-                            body ? /*#__PURE__*/ jsx(Accordion, {
-                                title: "Body",
-                                children: body.type === 'object' && !fields.body ? /*#__PURE__*/ jsx(ObjectInput, {
-                                    field: body,
-                                    fieldName: "body"
-                                }) : renderCustomField('body', body, fields.body)
-                            }) : null
-                        ]
+                    path.length > 0 ? /*#__PURE__*/ jsx(CollapsiblePanel, {
+                        title: "Path",
+                        children: path.map((field)=>renderCustomField(`path.${field.name}`, field, fields.path, field.name))
+                    }) : null,
+                    query.length > 0 ? /*#__PURE__*/ jsx(CollapsiblePanel, {
+                        title: "Query",
+                        children: query.map((field)=>renderCustomField(`query.${field.name}`, field, fields.query, field.name))
+                    }) : null,
+                    header.length > 0 ? /*#__PURE__*/ jsx(CollapsiblePanel, {
+                        title: "Headers",
+                        children: header.map((field)=>renderCustomField(`header.${field.name}`, field, fields.header, field.name))
+                    }) : null,
+                    body ? /*#__PURE__*/ jsx(CollapsiblePanel, {
+                        title: "Body",
+                        children: body.type === 'object' && !fields.body ? /*#__PURE__*/ jsx(ObjectInput, {
+                            field: body,
+                            fieldName: "body"
+                        }) : renderCustomField('body', body, fields.body)
                     }) : null,
                     testQuery.data ? /*#__PURE__*/ jsx(ResultDisplay, {
                         data: testQuery.data
@@ -778,6 +762,28 @@ function APIPlayground({ route, method = 'GET', authorization, path = [], header
         })
     });
 }
+function CollapsiblePanel({ title, children }) {
+    return /*#__PURE__*/ jsxs(Collapsible, {
+        className: "-m-2",
+        children: [
+            /*#__PURE__*/ jsxs(CollapsibleTrigger, {
+                className: "group flex w-full flex-row items-center justify-between p-2 font-medium",
+                children: [
+                    title,
+                    /*#__PURE__*/ jsx(ChevronDown, {
+                        className: "size-4 group-data-[state=open]:rotate-180"
+                    })
+                ]
+            }),
+            /*#__PURE__*/ jsx(CollapsibleContent, {
+                children: /*#__PURE__*/ jsx("div", {
+                    className: "flex flex-col gap-4 p-2",
+                    children: children
+                })
+            })
+        ]
+    });
+}
 function createPathnameFromInput(route, path, query) {
     let pathname = route;
     for (const key of Object.keys(path)){
@@ -804,7 +810,7 @@ function RouteDisplay({ route }) {
         query
     ]);
     return /*#__PURE__*/ jsx("code", {
-        className: "flex-1 overflow-auto text-nowrap rounded-lg border bg-fd-muted px-2 py-1.5 text-sm text-fd-muted-foreground",
+        className: "flex-1 overflow-auto text-nowrap rounded-lg border bg-fd-secondary px-2 py-1.5 text-sm text-fd-secondary-foreground",
         children: pathname
     });
 }

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/dist/ui/index.js

@@ -3,8 +3,8 @@ import { cn } from 'fumadocs-ui/components/api';
 import { Fragment } from 'react';
 import { Accordions, Accordion } from 'fumadocs-ui/components/accordion';
 import { cva } from 'class-variance-authority';
-import { i as CopyRouteButton, j as ServerSelect } from './client-client-Dxsry8Mu.js';
-export { A as APIPlayground, R as Root, u as useSchemaContext } from './client-client-Dxsry8Mu.js';
+import { j as CopyRouteButton, k as ServerSelect } from './client-client-Co3JBILS.js';
+export { A as APIPlayground, R as Root, u as useSchemaContext } from './client-client-Co3JBILS.js';
 
 const badgeVariants = cva('rounded-xl border px-1.5 py-1 text-xs font-medium leading-[12px]', {
     variants: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "5.11.2",
+  "version": "5.11.4",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "NextJs",
@@ -37,7 +37,7 @@
     "@scalar/openapi-parser": "0.10.2",
     "ajv-draft-04": "^1.0.0",
     "class-variance-authority": "^0.7.1",
-    "fast-glob": "^3.3.1",
+    "fast-glob": "^3.3.3",
     "github-slugger": "^2.0.0",
     "hast-util-to-jsx-runtime": "^2.3.2",
     "js-yaml": "^4.1.0",
@@ -47,17 +47,17 @@
     "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",
     "@types/node": "22.10.5",
     "@types/openapi-sampler": "^1.0.3",
-    "@types/react": "^19.0.2",
+    "@types/react": "^19.0.4",
     "bunchee": "^6.2.0",
     "lucide-react": "^0.469.0",
-    "next": "15.1.3",
+    "next": "15.1.4",
     "openapi-types": "^12.1.3",
     "eslint-config-custom": "0.0.0",
     "tsconfig": "0.0.0"