fumadocs-openapi 6.0.4 → 6.0.5

package/dist/render/operation.d.ts

@@ -4,14 +4,16 @@ import type { MethodInformation, RenderContext } from '../types.js';
 export interface CodeSample {
     lang: string;
     label: string;
-    source: string | ((endpoint: EndpointSample) => string | undefined) | false;
+    source: string | ((endpoint: EndpointSample, exampleKey: string) => string | undefined) | false;
 }
-export declare function Operation({ type, path, method, ctx, hasHead, headingLevel, }: {
+export declare function Operation({ type, path, method, ctx, hasHead, headingLevel, selectedSampleKey, exclusiveSampleKey, }: {
     type?: 'webhook' | 'operation';
     path: string;
     method: MethodInformation;
     ctx: RenderContext;
     hasHead?: boolean;
     headingLevel?: number;
+    selectedSampleKey?: string;
+    exclusiveSampleKey?: string;
 }): ReactElement;
 //# sourceMappingURL=operation.d.ts.map

package/dist/render/operation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../src/render/operation.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,YAAY,EAAkB,MAAM,OAAO,CAAC;AACpE,OAAO,EAAkB,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAK9E,OAAO,KAAK,EAEV,iBAAiB,EAEjB,aAAa,EAEd,MAAM,SAAS,CAAC;AAgBjB,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,QAAQ,EAAE,cAAc,KAAK,MAAM,GAAG,SAAS,CAAC,GAAG,KAAK,CAAC;CAC7E;AAQD,wBAAgB,SAAS,CAAC,EACxB,IAAkB,EAClB,IAAI,EACJ,MAAM,EACN,GAAG,EACH,OAAO,EACP,YAAgB,GACjB,EAAE;IACD,IAAI,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,iBAAiB,CAAC;IAC1B,GAAG,EAAE,aAAa,CAAC;IAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GAAG,YAAY,CAoLf"}
+{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../src/render/operation.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,YAAY,EAAkB,MAAM,OAAO,CAAC;AACpE,OAAO,EAEL,KAAK,cAAc,EAEpB,MAAM,yBAAyB,CAAC;AAKjC,OAAO,KAAK,EAEV,iBAAiB,EAEjB,aAAa,EAEd,MAAM,SAAS,CAAC;AAgBjB,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EACF,MAAM,GACN,CAAC,CAAC,QAAQ,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC,GACtE,KAAK,CAAC;CACX;AAQD,wBAAgB,SAAS,CAAC,EACxB,IAAkB,EAClB,IAAI,EACJ,MAAM,EACN,GAAG,EACH,OAAO,EACP,YAAgB,EAChB,iBAAiB,EACjB,kBAAkB,GACnB,EAAE;IACD,IAAI,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,iBAAiB,CAAC;IAC1B,GAAG,EAAE,aAAa,CAAC;IAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,GAAG,YAAY,CA0Lf"}

package/dist/render/operation.js

@@ -1,6 +1,6 @@
 import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
 import { Fragment } from 'react';
-import { generateSample } from '../utils/generate-sample.js';
+import { generateSample, } from '../utils/generate-sample.js';
 import * as CURL from '../requests/curl.js';
 import * as JS from '../requests/javascript.js';
 import * as Go from '../requests/go.js';
@@ -14,7 +14,7 @@ import { heading } from './heading.js';
 import { Schema } from './schema.js';
 import { createMethod } from '../server/create-method.js';
 import { methodKeys } from '../build-routes.js';
-export function Operation({ type = 'operation', path, method, ctx, hasHead, headingLevel = 2, }) {
+export function Operation({ type = 'operation', path, method, ctx, hasHead, headingLevel = 2, selectedSampleKey, exclusiveSampleKey, }) {
     const body = method.requestBody;
     const security = method.security ?? ctx.schema.document.security;
     let headNode = null;
@@ -87,11 +87,11 @@ export function Operation({ type = 'operation', path, method, ctx, hasHead, head
     if (method.callbacks) {
         callbacksNode = (_jsxs(_Fragment, { children: [heading(headingLevel, 'Webhooks', ctx), Object.entries(method.callbacks).map(([name, callback]) => (_jsx(WebhookCallback, { callback: callback, ctx: ctx, headingLevel: headingLevel }, name)))] }));
     }
-    const info = (_jsxs(ctx.renderer.APIInfo, { head: headNode, method: method.method, route: path, children: [type === 'operation' ? (_jsx(ctx.renderer.APIPlayground, { path: path, method: method, ctx: ctx })) : null, security ? (_jsxs(_Fragment, { children: [heading(headingLevel, 'Authorization', ctx), _jsx(AuthSection, { requirements: security, ctx: ctx })] })) : null, bodyNode, Array.from(parameterGroups.entries()).map(([group, params]) => {
+    const info = (_jsxs(ctx.renderer.APIInfo, { head: headNode, method: method.method, route: path, children: [type === 'operation' ? (_jsx(ctx.renderer.APIPlayground, { path: path, method: method, ctx: ctx })) : null, security && Object.keys(security).length > 0 ? (_jsxs(_Fragment, { children: [heading(headingLevel, 'Authorization', ctx), _jsx(AuthSection, { requirements: security, ctx: ctx })] })) : null, bodyNode, Array.from(parameterGroups.entries()).map(([group, params]) => {
                 return (_jsxs(Fragment, { children: [heading(headingLevel, group, ctx), params] }, group));
             }), responseNode, callbacksNode] }));
     if (type === 'operation') {
-        return (_jsxs(ctx.renderer.API, { children: [info, _jsx(APIExample, { method: method, endpoint: endpoint, ctx: ctx })] }));
+        return (_jsxs(ctx.renderer.API, { children: [info, _jsx(APIExample, { method: method, endpoint: endpoint, ctx: ctx, selectedSampleKey: selectedSampleKey, exclusiveSampleKey: exclusiveSampleKey })] }));
     }
     else {
         return info;
@@ -119,28 +119,57 @@ const defaultSamples = [
         lang: 'python',
     },
 ];
-async function APIExample({ method, endpoint, ctx, }) {
+async function APIExample({ method, endpoint, ctx, selectedSampleKey, exclusiveSampleKey, }) {
     const renderer = ctx.renderer;
     const children = [];
-    const samples = dedupe([
-        ...defaultSamples,
-        ...(ctx.generateCodeSamples ? await ctx.generateCodeSamples(endpoint) : []),
-        ...(method['x-codeSamples'] ?? []),
-    ]).flatMap((sample) => {
-        if (sample.source === false)
-            return [];
-        const result = typeof sample.source === 'function'
-            ? sample.source(endpoint)
-            : sample.source;
-        if (result === undefined)
-            return [];
-        return {
-            ...sample,
-            source: result,
+    // fallback for methods that have no request body, we also want to show examples for
+    const existingSamples = endpoint.body?.samples ?? {
+        _default: {},
+    };
+    const samples = {};
+    for (const exampleKey in existingSamples) {
+        samples[exampleKey] = {
+            title: existingSamples[exampleKey]?.summary ?? exampleKey,
+            description: existingSamples[exampleKey]?.description,
+            samples: dedupe([
+                ...defaultSamples,
+                ...(ctx.generateCodeSamples
+                    ? await ctx.generateCodeSamples(endpoint)
+                    : []),
+                ...(method['x-codeSamples'] ?? []),
+            ]).flatMap((sample) => {
+                if (sample.source === false)
+                    return [];
+                const result = typeof sample.source === 'function'
+                    ? sample.source(endpoint, exampleKey)
+                    : sample.source;
+                if (result === undefined)
+                    return [];
+                return {
+                    ...sample,
+                    source: result,
+                };
+            }),
         };
-    });
-    if (samples.length > 0) {
-        children.push(_jsx(renderer.Requests, { items: samples.map((s) => s.label), children: samples.map((s) => (_jsx(renderer.Request, { name: s.label, code: s.source, language: s.lang }, s.label))) }, "requests"));
+    }
+    if (Object.keys(samples).length > 0) {
+        const sampleTabs = [];
+        const titles = [];
+        if ((samples && Object.keys(samples).length === 1 && samples['_default']) ||
+            (exclusiveSampleKey && samples[exclusiveSampleKey])) {
+            // if exclusiveSampleKey is present, we don't use tabs
+            // if only the fallback or non described openapi legacy example is present, we don't use tabs
+            const sampleKey = exclusiveSampleKey ?? '_default';
+            children.push(_jsx(renderer.Requests, { items: samples[sampleKey].samples.map((s) => s.label), children: samples[sampleKey].samples.map((s) => (_jsx(renderer.Request, { name: s.label, code: s.source, language: s.lang }, `requests-${sampleKey}-${s.label}`))) }, `requests-${sampleKey}`));
+        }
+        else {
+            for (const sampleKey in samples) {
+                const title = samples[sampleKey].title;
+                titles.push(title);
+                sampleTabs.push(_jsxs(renderer.Sample, { value: title, children: [samples[sampleKey].description && (_jsx(Markdown, { text: samples[sampleKey].description })), _jsx(renderer.Requests, { items: samples[sampleKey].samples.map((s) => s.label), children: samples[sampleKey].samples.map((s) => (_jsx(renderer.Request, { name: s.label, code: s.source, language: s.lang }, `requests-${sampleKey}-${s.label}`))) }, `requests-${sampleKey}`)] }, sampleKey));
+            }
+            children.push(_jsx(renderer.Samples, { items: titles, defaultValue: selectedSampleKey, children: sampleTabs }, "samples"));
+        }
     }
     children.push(_jsx(ResponseTabs, { operation: method, ctx: ctx, endpoint: endpoint }, "responses"));
     return _jsx(renderer.APIExample, { children: children });

package/dist/render/renderer.d.ts

@@ -30,6 +30,15 @@ export interface RequestProps {
     name: string;
     code: string;
 }
+export interface SampleProps {
+    value: string;
+    children: ReactNode;
+}
+export interface SamplesProps {
+    items: string[];
+    children: ReactNode;
+    defaultValue?: string;
+}
 export interface ResponseTypeProps {
     lang: string;
     code: string;
@@ -51,6 +60,8 @@ export interface Renderer {
     }>;
     Responses: ComponentType<ResponsesProps>;
     Response: ComponentType<ResponseProps>;
+    Sample: ComponentType<SampleProps>;
+    Samples: ComponentType<SamplesProps>;
     Requests: ComponentType<{
         items: string[];
         children: ReactNode;

package/dist/render/renderer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../../src/render/renderer.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAYtD,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAG9E,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IAC/B,GAAG,EAAE,aAAa,CAAC;QAAE,QAAQ,EAAE,SAAS,CAAA;KAAE,CAAC,CAAC;IAC5C,OAAO,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IACrC,UAAU,EAAE,aAAa,CAAC;QAAE,QAAQ,EAAE,SAAS,CAAA;KAAE,CAAC,CAAC;IAEnD,SAAS,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IACzC,QAAQ,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;IACvC,QAAQ,EAAE,aAAa,CAAC;QAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAAC,QAAQ,EAAE,SAAS,CAAA;KAAE,CAAC,CAAC;IAClE,OAAO,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IACrC,aAAa,EAAE,aAAa,CAAC;QAAE,QAAQ,EAAE,SAAS,CAAA;KAAE,CAAC,CAAC;IACtD,YAAY,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;IAE/C;;OAEG;IACH,iBAAiB,EAAE,aAAa,CAAC,sBAAsB,CAAC,CAAC;IACzD,QAAQ,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;IACvC,aAAa,EAAE,aAAa,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,iBAAiB,CAAC;QAC1B,GAAG,EAAE,aAAa,CAAC;KACpB,CAAC,CAAC;CACJ;AAED,YAAY,EACV,kBAAkB,EAClB,aAAa,EACb,qBAAqB,EACrB,eAAe,GAChB,MAAM,qBAAqB,CAAC;AAE7B,wBAAgB,aAAa,CAC3B,YAAY,EAAE,aAAa,CAAC,cAAc,CAAC,GAC1C,QAAQ,CA+CV"}
+{"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../../src/render/renderer.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAYtD,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAG9E,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,SAAS,CAAC;CACrB;AACD,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,SAAS,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IAC/B,GAAG,EAAE,aAAa,CAAC;QAAE,QAAQ,EAAE,SAAS,CAAA;KAAE,CAAC,CAAC;IAC5C,OAAO,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IACrC,UAAU,EAAE,aAAa,CAAC;QAAE,QAAQ,EAAE,SAAS,CAAA;KAAE,CAAC,CAAC;IAEnD,SAAS,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IACzC,QAAQ,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;IACvC,MAAM,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;IACnC,OAAO,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IACrC,QAAQ,EAAE,aAAa,CAAC;QAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAAC,QAAQ,EAAE,SAAS,CAAA;KAAE,CAAC,CAAC;IAClE,OAAO,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IACrC,aAAa,EAAE,aAAa,CAAC;QAAE,QAAQ,EAAE,SAAS,CAAA;KAAE,CAAC,CAAC;IACtD,YAAY,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;IAE/C;;OAEG;IACH,iBAAiB,EAAE,aAAa,CAAC,sBAAsB,CAAC,CAAC;IACzD,QAAQ,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;IACvC,aAAa,EAAE,aAAa,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,iBAAiB,CAAC;QAC1B,GAAG,EAAE,aAAa,CAAC;KACpB,CAAC,CAAC;CACJ;AAED,YAAY,EACV,kBAAkB,EAClB,aAAa,EACb,qBAAqB,EACrB,eAAe,GAChB,MAAM,qBAAqB,CAAC;AAE7B,wBAAgB,aAAa,CAC3B,YAAY,EAAE,aAAa,CAAC,cAAc,CAAC,GAC1C,QAAQ,CAkDV"}

package/dist/render/renderer.js

@@ -17,6 +17,8 @@ export function createRenders(shikiOptions) {
         Property,
         ObjectCollapsible,
         Requests: (props) => (_jsx(Tabs, { groupId: "fumadocs_openapi_requests", ...props })),
+        Samples: (props) => _jsx(Tabs, { ...props }),
+        Sample: Tab,
         Request: (props) => (_jsx(Tab, { value: props.name, children: _jsx(CodeBlock, { lang: props.language, code: props.code, options: shikiOptions }) })),
         APIPlayground: Playground,
     };

package/dist/requests/curl.d.ts

@@ -1,3 +1,3 @@
 import { type EndpointSample } from '../utils/generate-sample.js';
-export declare function getSampleRequest(endpoint: EndpointSample): string;
+export declare function getSampleRequest(endpoint: EndpointSample, sampleKey: string): string;
 //# sourceMappingURL=curl.d.ts.map

package/dist/requests/curl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"curl.d.ts","sourceRoot":"","sources":["../../src/requests/curl.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAG9D,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,cAAc,GAAG,MAAM,CA0CjE"}
+{"version":3,"file":"curl.d.ts","sourceRoot":"","sources":["../../src/requests/curl.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAG9D,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,cAAc,EACxB,SAAS,EAAE,MAAM,GAChB,MAAM,CA0CR"}

package/dist/requests/curl.js

@@ -1,5 +1,5 @@
 import { inputToString } from '../utils/input-to-string.js';
-export function getSampleRequest(endpoint) {
+export function getSampleRequest(endpoint, sampleKey) {
     const s = [];
     s.push(`curl -X ${endpoint.method} "${endpoint.url}"`);
     for (const param of endpoint.parameters) {
@@ -13,7 +13,7 @@ export function getSampleRequest(endpoint) {
         }
     }
     if (endpoint.body?.mediaType === 'multipart/form-data') {
-        const sample = endpoint.body.sample;
+        const sample = endpoint.body.samples[sampleKey]?.value;
         if (sample && typeof sample === 'object') {
             for (const [key, value] of Object.entries(sample)) {
                 s.push(`-F ${key}=${inputToString(value)}`);
@@ -22,7 +22,7 @@ export function getSampleRequest(endpoint) {
     }
     else if (endpoint.body) {
         s.push(`-H "Content-Type: ${endpoint.body.mediaType}"`);
-        s.push(`-d ${inputToString(endpoint.body.sample, endpoint.body.mediaType, 'single-quote')}`);
+        s.push(`-d ${inputToString(endpoint.body.samples[sampleKey]?.value ?? '', endpoint.body.mediaType, 'single-quote')}`);
     }
     return s
         .flatMap((v, i) => v

package/dist/requests/go.d.ts

@@ -1,3 +1,3 @@
 import { type EndpointSample } from '../utils/generate-sample.js';
-export declare function getSampleRequest(endpoint: EndpointSample): string;
+export declare function getSampleRequest(endpoint: EndpointSample, sampleKey: string): string;
 //# sourceMappingURL=go.d.ts.map

package/dist/requests/go.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"go.d.ts","sourceRoot":"","sources":["../../src/requests/go.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAG9D,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,cAAc,GAAG,MAAM,CA0EjE"}
+{"version":3,"file":"go.d.ts","sourceRoot":"","sources":["../../src/requests/go.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAG9D,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,cAAc,EACxB,SAAS,EAAE,MAAM,GAChB,MAAM,CA4ER"}

package/dist/requests/go.js

@@ -1,5 +1,5 @@
 import { inputToString } from '../utils/input-to-string.js';
-export function getSampleRequest(endpoint) {
+export function getSampleRequest(endpoint, sampleKey) {
     const imports = ['fmt', 'net/http', 'io/ioutil'];
     const headers = new Map();
     const variables = new Map();
@@ -16,17 +16,17 @@ export function getSampleRequest(endpoint) {
     if (endpoint.body) {
         headers.set('Content-Type', `"${endpoint.body.mediaType}"`);
         if (endpoint.body.mediaType === 'multipart/form-data' &&
-            typeof endpoint.body.sample === 'object') {
+            typeof endpoint.body.samples[sampleKey]?.value === 'object') {
             imports.push('mime/multipart', 'bytes');
             variables.set('payload', `new(bytes.Buffer)`);
             variables.set('mp', 'multipart.NewWriter(payload)');
-            for (const [key, value] of Object.entries(endpoint.body.sample ?? {})) {
+            for (const [key, value] of Object.entries(endpoint.body.samples[sampleKey]?.value ?? {})) {
                 additional.push(`mp.WriteField("${key}", ${inputToString(value, undefined, 'backtick')})`);
             }
         }
         else {
             imports.push('strings');
-            variables.set('payload', `strings.NewReader(${inputToString(endpoint.body.sample, endpoint.body.mediaType, 'backtick').replaceAll('\n', '\n  ')})`);
+            variables.set('payload', `strings.NewReader(${inputToString(endpoint.body.samples[sampleKey]?.value ?? '', endpoint.body.mediaType, 'backtick').replaceAll('\n', '\n  ')})`);
         }
     }
     return `package main

package/dist/requests/javascript.d.ts

@@ -1,3 +1,3 @@
 import { type EndpointSample } from '../utils/generate-sample.js';
-export declare function getSampleRequest(endpoint: EndpointSample): string;
+export declare function getSampleRequest(endpoint: EndpointSample, sampleKey: string): string;
 //# sourceMappingURL=javascript.d.ts.map

package/dist/requests/javascript.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"javascript.d.ts","sourceRoot":"","sources":["../../src/requests/javascript.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAG9D,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,cAAc,GAAG,MAAM,CA4EjE"}
+{"version":3,"file":"javascript.d.ts","sourceRoot":"","sources":["../../src/requests/javascript.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAG9D,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,cAAc,EACxB,SAAS,EAAE,MAAM,GAChB,MAAM,CA8ER"}

package/dist/requests/javascript.js

@@ -1,5 +1,5 @@
 import { inputToString } from '../utils/input-to-string.js';
-export function getSampleRequest(endpoint) {
+export function getSampleRequest(endpoint, sampleKey) {
     const s = [];
     const options = new Map();
     const headers = new Map();
@@ -21,10 +21,10 @@ export function getSampleRequest(endpoint) {
         options.set('headers', JSON.stringify(Object.fromEntries(headers.entries()), null, 2).replaceAll('\n', '\n  '));
     }
     if (endpoint.body?.mediaType === 'multipart/form-data' &&
-        typeof endpoint.body.sample === 'object' &&
-        endpoint.body.sample) {
+        typeof endpoint.body.samples[sampleKey]?.value === 'object' &&
+        endpoint.body.samples[sampleKey]?.value) {
         s.push(`const formData = new FormData();`);
-        for (const [key, value] of Object.entries(endpoint.body.sample))
+        for (const [key, value] of Object.entries(endpoint.body.samples[sampleKey]?.value))
             s.push(`formData.set(${key}, ${inputToString(value)})`);
         options.set('body', 'formData');
     }
@@ -32,12 +32,12 @@ export function getSampleRequest(endpoint) {
         let code;
         if (endpoint.body.mediaType === 'application/json') {
             code =
-                typeof endpoint.body.sample === 'string'
-                    ? inputToString(endpoint.body.sample, endpoint.body.mediaType, 'backtick')
-                    : `JSON.stringify(${JSON.stringify(endpoint.body.sample, null, 2)})`;
+                typeof endpoint.body.samples[sampleKey]?.value === 'string'
+                    ? inputToString(endpoint.body.samples[sampleKey]?.value, endpoint.body.mediaType, 'backtick')
+                    : `JSON.stringify(${JSON.stringify(endpoint.body.samples[sampleKey]?.value, null, 2)})`;
         }
         else {
-            code = inputToString(endpoint.body.sample, endpoint.body.mediaType, 'backtick');
+            code = inputToString(endpoint.body.samples[sampleKey]?.value ?? '', endpoint.body.mediaType, 'backtick');
         }
         options.set('body', code.replaceAll('\n', '\n  '));
     }

package/dist/requests/python.d.ts

@@ -1,3 +1,3 @@
 import { type EndpointSample } from '../utils/generate-sample.js';
-export declare function getSampleRequest(endpoint: EndpointSample): string;
+export declare function getSampleRequest(endpoint: EndpointSample, sampleKey: string): string;
 //# sourceMappingURL=python.d.ts.map

package/dist/requests/python.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"python.d.ts","sourceRoot":"","sources":["../../src/requests/python.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAG9D,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,cAAc,GAAG,MAAM,CA8DjE"}
+{"version":3,"file":"python.d.ts","sourceRoot":"","sources":["../../src/requests/python.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAG9D,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,cAAc,EACxB,SAAS,EAAE,MAAM,GAChB,MAAM,CA4ER"}

package/dist/requests/python.js

@@ -1,5 +1,5 @@
 import { inputToString } from '../utils/input-to-string.js';
-export function getSampleRequest(endpoint) {
+export function getSampleRequest(endpoint, sampleKey) {
     const headers = new Map();
     const cookies = new Map();
     const variables = new Map();
@@ -12,15 +12,15 @@ export function getSampleRequest(endpoint) {
     if (endpoint.body) {
         switch (endpoint.body.mediaType) {
             case 'application/json':
-                variables.set('json', JSON.stringify(endpoint.body.sample, null, 2));
+                variables.set('json', JSON.stringify(endpoint.body.samples[sampleKey]?.value ?? {}, null, 2));
                 break;
             case 'multipart/form-data':
                 headers.set('Content-Type', endpoint.body.mediaType);
-                variables.set('data', JSON.stringify(endpoint.body.sample, null, 2));
+                variables.set('data', JSON.stringify(endpoint.body.samples[sampleKey]?.value ?? {}, null, 2));
                 break;
             default:
                 headers.set('Content-Type', endpoint.body.mediaType);
-                variables.set('data', inputToString(endpoint.body.sample, endpoint.body.mediaType, 'backtick'));
+                variables.set('data', inputToString(endpoint.body.samples[sampleKey]?.value ?? '', endpoint.body.mediaType, 'backtick'));
         }
     }
     if (headers.size > 0) {

package/dist/server/api-page.d.ts

@@ -24,6 +24,14 @@ export interface WebhookItem {
 export interface OperationItem {
     path: string;
     method: OpenAPIV3_1.HttpMethods;
+    /**
+     * The key of the sample to be selected
+     */
+    selectedSampleKey?: string;
+    /**
+     * Only this sample will be shown
+     */
+    exclusiveSampleKey?: string;
 }
 export declare function APIPage(props: ApiPageProps): Promise<import("react/jsx-runtime").JSX.Element>;
 export declare function getContext(schema: ProcessedDocument, options?: ApiPageContextProps & {

package/dist/server/api-page.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-page.d.ts","sourceRoot":"","sources":["../../src/server/api-page.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,OAAO,EAAiB,KAAK,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EACL,KAAK,aAAa,EAElB,KAAK,iBAAiB,EACvB,MAAM,0BAA0B,CAAC;AAGlC,KAAK,mBAAmB,GAAG,IAAI,CAC7B,OAAO,CAAC,aAAa,CAAC,EACpB,cAAc,GACd,0BAA0B,GAC1B,qBAAqB,GACrB,UAAU,GACV,oBAAoB,CACvB,CAAC;AAEF,MAAM,WAAW,YAAa,SAAQ,mBAAmB;IACvD,QAAQ,EAAE,aAAa,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;IAEjB,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE7B;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,EAAE,CAAC;IAE7B,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,CAAC,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,CAAC,WAAW,CAAC;CACjC;AAED,wBAAsB,OAAO,CAAC,KAAK,EAAE,YAAY,oDA0DhD;AAED,wBAAsB,UAAU,CAC9B,MAAM,EAAE,iBAAiB,EACzB,OAAO,GAAE,mBAAmB,GAAG;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;CACzB,GACL,OAAO,CAAC,aAAa,CAAC,CA8BxB"}
+{"version":3,"file":"api-page.d.ts","sourceRoot":"","sources":["../../src/server/api-page.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,OAAO,EAAiB,KAAK,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EACL,KAAK,aAAa,EAElB,KAAK,iBAAiB,EACvB,MAAM,0BAA0B,CAAC;AAGlC,KAAK,mBAAmB,GAAG,IAAI,CAC7B,OAAO,CAAC,aAAa,CAAC,EACpB,cAAc,GACd,0BAA0B,GAC1B,qBAAqB,GACrB,UAAU,GACV,oBAAoB,CACvB,CAAC;AAEF,MAAM,WAAW,YAAa,SAAQ,mBAAmB;IACvD,QAAQ,EAAE,aAAa,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;IAEjB,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE7B;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,EAAE,CAAC;IAE7B,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,CAAC,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,CAAC,WAAW,CAAC;IAChC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,wBAAsB,OAAO,CAAC,KAAK,EAAE,YAAY,oDA4DhD;AAED,wBAAsB,UAAU,CAC9B,MAAM,EAAE,iBAAiB,EACzB,OAAO,GAAE,mBAAmB,GAAG;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;CACzB,GACL,OAAO,CAAC,aAAa,CAAC,CA8BxB"}

package/dist/server/api-page.js

@@ -18,7 +18,7 @@ export async function APIPage(props) {
                 if (!operation)
                     return null;
                 const method = createMethod(item.method, pathItem, operation);
-                return (_jsx(Operation, { method: method, path: item.path, ctx: ctx, hasHead: hasHead }, `${item.path}:${item.method}`));
+                return (_jsx(Operation, { method: method, path: item.path, ctx: ctx, hasHead: hasHead, selectedSampleKey: item.selectedSampleKey, exclusiveSampleKey: item.exclusiveSampleKey }, `${item.path}:${item.method}`));
             }), webhooks?.map((item) => {
                 const webhook = document.webhooks?.[item.name];
                 if (!webhook)

package/dist/utils/generate-sample.d.ts

@@ -1,5 +1,13 @@
 import type { MethodInformation, RenderContext } from '../types.js';
 import { type ParsedSchema } from '../utils/schema.js';
+export interface EndpointSamples {
+    [key: string]: {
+        value?: unknown;
+        description?: string;
+        summary?: string;
+        externalValue?: string;
+    };
+}
 /**
  * Sample info of endpoint
  */
@@ -12,7 +20,7 @@ export interface EndpointSample {
     body?: {
         schema: ParsedSchema;
         mediaType: string;
-        sample: unknown;
+        samples: EndpointSamples;
     };
     responses: Record<string, ResponseSample>;
     parameters: ParameterSample[];

package/dist/utils/generate-sample.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate-sample.d.ts","sourceRoot":"","sources":["../../src/utils/generate-sample.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAChE,OAAO,EAEL,KAAK,YAAY,EAElB,MAAM,gBAAgB,CAAC;AAGxB;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE;QACL,MAAM,EAAE,YAAY,CAAC;QACrB,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,OAAO,CAAC;KACjB,CAAC;IACF,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC1C,UAAU,EAAE,eAAe,EAAE,CAAC;CAC/B;AAED,UAAU,cAAc;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,YAAY,CAAC;CACtB;AAED,UAAU,eAAe;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,wBAAgB,cAAc,CAC5B,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,iBAAiB,EACzB,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,aAAa,GAC/C,cAAc,CAoHhB"}
+{"version":3,"file":"generate-sample.d.ts","sourceRoot":"","sources":["../../src/utils/generate-sample.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAChE,OAAO,EAEL,KAAK,YAAY,EAElB,MAAM,gBAAgB,CAAC;AAExB,MAAM,WAAW,eAAe;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;CACH;AACD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE;QACL,MAAM,EAAE,YAAY,CAAC;QACrB,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE,eAAe,CAAC;KAC1B,CAAC;IACF,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC1C,UAAU,EAAE,eAAe,EAAE,CAAC;CAC/B;AAED,UAAU,cAAc;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,YAAY,CAAC;CACtB;AAED,UAAU,eAAe;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,wBAAgB,cAAc,CAC5B,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,iBAAiB,EACzB,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,aAAa,GAC/C,cAAc,CA0HhB"}

package/dist/utils/generate-sample.js

@@ -55,7 +55,13 @@ export function generateSample(path, method, { baseUrl, schema: { document } })
         bodyOutput = {
             schema,
             mediaType: type,
-            sample: body[type].example ?? generateBody(method.method, schema),
+            samples: body[type].examples
+                ? body[type].examples
+                : {
+                    _default: {
+                        value: body[type].example ?? generateBody(method.method, schema),
+                    },
+                },
         };
     }
     for (const [code, response] of Object.entries(method.responses ?? {})) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "6.0.4",
+  "version": "6.0.5",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "NextJs",
@@ -36,8 +36,8 @@
   ],
   "dependencies": {
     "@fumari/json-schema-to-typescript": "^1.1.2",
-    "@radix-ui/react-select": "^2.1.5",
-    "@radix-ui/react-slot": "^1.1.1",
+    "@radix-ui/react-select": "^2.1.6",
+    "@radix-ui/react-slot": "^1.1.2",
     "@scalar/openapi-parser": "0.10.4",
     "ajv-draft-04": "^1.0.0",
     "class-variance-authority": "^0.7.1",
@@ -51,15 +51,15 @@
     "react-hook-form": "^7.54.2",
     "remark": "^15.0.1",
     "remark-rehype": "^11.1.1",
-    "shiki": "^2.2.0",
+    "shiki": "^2.3.1",
     "xml-js": "^1.6.11",
-    "fumadocs-core": "15.0.3",
-    "fumadocs-ui": "15.0.3"
+    "fumadocs-core": "15.0.4",
+    "fumadocs-ui": "15.0.4"
   },
   "devDependencies": {
-    "@scalar/api-client-react": "^1.1.22",
+    "@scalar/api-client-react": "^1.1.24",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "22.13.0",
+    "@types/node": "22.13.1",
     "@types/openapi-sampler": "^1.0.3",
     "@types/react": "^19.0.8",
     "next": "15.1.6",