fumadocs-openapi 6.0.7 → 6.0.9

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;AAC9E,OAAO,KAAK,EAEV,iBAAiB,EAEjB,aAAa,EAEd,MAAM,SAAS,CAAC;AAYjB,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;AAED,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,CA6Lf"}
+{"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;AAC9E,OAAO,KAAK,EAEV,iBAAiB,EAEjB,aAAa,EAEd,MAAM,SAAS,CAAC;AAYjB,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;AASD,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,CAkLf"}

package/dist/render/operation.js

@@ -11,6 +11,12 @@ import { createMethod } from '../server/create-method.js';
 import { methodKeys } from '../build-routes.js';
 import { APIExample } from '../render/operation/api-example.js';
 import { MethodLabel } from '../ui/components/method-label.js';
+const ParamTypes = {
+    path: 'Path Parameters',
+    query: 'Query Parameters',
+    header: 'Header Parameters',
+    cookie: 'Cookie Parameters',
+};
 export function Operation({ type = 'operation', path, method, ctx, hasHead, headingLevel = 2, }) {
     const body = method.requestBody;
     const security = method.security ?? ctx.schema.document.security;
@@ -54,39 +60,28 @@ export function Operation({ type = 'operation', path, method, ctx, hasHead, head
                                 } })] }, status));
                 })] }));
     }
-    const parameterGroups = new Map();
     const endpoint = generateSample(path, method, ctx);
-    for (const param of method.parameters ?? []) {
-        const pInfo = endpoint.parameters.find((item) => item.name === param.name && item.in === param.in);
-        if (!pInfo)
-            continue;
-        const schema = pInfo.schema;
-        const groupName = {
-            path: 'Path Parameters',
-            query: 'Query Parameters',
-            header: 'Header Parameters',
-            cookie: 'Cookie Parameters',
-        }[param.in] ?? 'Other Parameters';
-        const group = parameterGroups.get(groupName) ?? [];
-        group.push(_jsx(Schema, { name: param.name, schema: {
-                ...schema,
-                description: param.description ?? schema.description,
-                deprecated: (param.deprecated ?? false) || (schema.deprecated ?? false),
-            }, ctx: {
-                parseObject: false,
-                readOnly: method.method === 'GET',
-                writeOnly: method.method !== 'GET',
-                required: param.required ?? false,
-                render: ctx,
-            } }, param.name));
-        parameterGroups.set(groupName, group);
-    }
+    const parameterNode = Object.entries(ParamTypes).map(([type, title]) => {
+        const params = endpoint.parameters.filter((param) => param.in === type && !param.isAuthOnly);
+        if (params.length === 0)
+            return;
+        return (_jsxs(Fragment, { children: [heading(headingLevel, title, ctx), _jsx("div", { className: "flex flex-col gap-4", children: params.map((param) => (_jsx(Schema, { name: param.name, schema: {
+                            ...param.schema,
+                            description: param.description ?? param.schema?.description,
+                            deprecated: (param.deprecated ?? false) ||
+                                (param.schema?.deprecated ?? false),
+                        }, ctx: {
+                            parseObject: false,
+                            readOnly: method.method === 'GET',
+                            writeOnly: method.method !== 'GET',
+                            required: param.required ?? false,
+                            render: ctx,
+                        } }, param.name))) })] }, type));
+    });
     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' ? (ctx.disablePlayground ? (_jsxs("div", { className: "flex flex-row items-center gap-2.5 p-3 rounded-xl border bg-fd-card text-fd-card-foreground not-prose", children: [_jsx(MethodLabel, { className: "text-xs", children: method.method }), _jsx("code", { className: "flex-1 overflow-auto text-nowrap text-[13px] text-fd-muted-foreground", children: path })] })) : (_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] }));
+    const info = (_jsxs(ctx.renderer.APIInfo, { head: headNode, method: method.method, route: path, children: [type === 'operation' ? (ctx.disablePlayground ? (_jsxs("div", { className: "flex flex-row items-center gap-2.5 p-3 rounded-xl border bg-fd-card text-fd-card-foreground not-prose", children: [_jsx(MethodLabel, { className: "text-xs", children: method.method }), _jsx("code", { className: "flex-1 overflow-auto text-nowrap text-[13px] text-fd-muted-foreground", children: path })] })) : (_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, parameterNode, responseNode, callbacksNode] }));
     if (type === 'operation') {
         return (_jsxs(ctx.renderer.API, { children: [info, _jsx(APIExample, { method: method, endpoint: endpoint, ctx: ctx })] }));
     }

package/dist/render/schema.js

@@ -54,7 +54,7 @@ export function Schema({ name, schema, ctx, }) {
     if (schema.allOf && parseObject) {
         return (_jsx(Schema, { name: name, schema: combineSchema(schema.allOf), ctx: ctx }));
     }
-    let footer = null;
+    let footer;
     const fields = [];
     for (const [key, value] of Object.entries(keys)) {
         if (key in schema) {
@@ -130,10 +130,16 @@ function getSchemaType(schema, ctx, isRoot = true) {
     if (schema.not)
         return `not ${getSchemaType(schema.not, ctx, false)}`;
     if (schema.anyOf) {
-        return `Any properties in ${schema.anyOf
+        const properties = schema.anyOf
             .map((one) => getSchemaType(one, ctx, false))
-            .filter((v) => v !== 'unknown')
-            .join(', ')}`;
+            .filter((v) => v !== 'unknown');
+        if (properties.length > 1) {
+            return `Any properties in ${properties.join(',')}`;
+        }
+        else if (properties.length === 1) {
+            return properties[0];
+        }
+        // otherwise unknown
     }
     if (schema.type === 'string' && schema.format === 'binary' && ctx.allowFile)
         return 'file';

package/dist/requests/python.js

@@ -20,7 +20,7 @@ export function getSampleRequest(endpoint, sampleKey) {
                 break;
             default:
                 headers.set('Content-Type', endpoint.body.mediaType);
-                variables.set('data', inputToString(endpoint.body.samples[sampleKey]?.value ?? '', endpoint.body.mediaType, 'backtick'));
+                variables.set('data', inputToString(endpoint.body.samples[sampleKey]?.value ?? '', endpoint.body.mediaType, 'python'));
         }
     }
     if (headers.size > 0) {

package/dist/ui/index.js

@@ -17,10 +17,10 @@ export function API({ children, ...props }) {
         }, children: children }));
 }
 export function Property({ name, type, required, deprecated, children, }) {
-    return (_jsxs("div", { className: "rounded-xl border bg-fd-card p-3 prose-no-margin", children: [_jsxs("div", { className: "flex flex-row flex-wrap items-center gap-4", children: [_jsx("code", { children: name }), required ? (_jsx(Badge, { color: "red", className: "text-xs", children: "Required" })) : null, deprecated ? (_jsx(Badge, { color: "yellow", className: "text-xs", children: "Deprecated" })) : null, _jsx("span", { className: "ms-auto text-xs font-mono text-fd-muted-foreground", children: type })] }), children] }));
+    return (_jsxs("div", { className: "rounded-xl border bg-fd-card p-3 prose-no-margin", children: [_jsxs("div", { className: "flex flex-row flex-wrap items-center gap-4 mb-2", children: [_jsx("code", { children: name }), required ? (_jsx(Badge, { color: "red", className: "text-xs", children: "Required" })) : null, deprecated ? (_jsx(Badge, { color: "yellow", className: "text-xs", children: "Deprecated" })) : null, _jsx("span", { className: "ms-auto text-xs font-mono text-fd-muted-foreground", children: type })] }), children] }));
 }
 export function APIExample(props) {
-    return (_jsx("div", { ...props, className: cn('prose-no-margin md:sticky md:top-[var(--fd-api-info-top)] xl:w-[400px]', props.className), children: props.children }));
+    return (_jsx("div", { ...props, className: cn('prose-no-margin md:sticky md:top-(--fd-api-info-top) xl:w-[400px]', props.className), children: props.children }));
 }
 export function ObjectCollapsible(props) {
     return (_jsxs(Collapsible, { ...props, children: [_jsxs(CollapsibleTrigger, { className: cn(buttonVariants({ color: 'outline', size: 'sm' }), 'group rounded-full px-2 py-1.5 text-fd-muted-foreground'), children: [props.name, _jsx(ChevronDown, { className: "size-4 group-data-[state=open]:rotate-180" })] }), _jsx(CollapsibleContent, { className: "-mx-2", children: _jsx("div", { className: "flex flex-col gap-2 p-2", children: props.children }) })] }));

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

@@ -1,6 +1,7 @@
 import type { MethodInformation, RenderContext } from '../types.js';
-import { type ParsedSchema } from '../utils/schema.js';
-export interface EndpointSamples {
+import { type ParsedSchema, type NoReference } from '../utils/schema.js';
+import type { OpenAPIV3_1 } from 'openapi-types';
+export interface Samples {
     [key: string]: {
         value?: unknown;
         description?: string;
@@ -20,7 +21,7 @@ export interface EndpointSample {
     body?: {
         schema: ParsedSchema;
         mediaType: string;
-        samples: EndpointSamples;
+        samples: Samples;
     };
     responses: Record<string, ResponseSample>;
     parameters: ParameterSample[];
@@ -30,11 +31,9 @@ interface ResponseSample {
     sample: unknown;
     schema: ParsedSchema;
 }
-interface ParameterSample {
-    name: string;
-    in: string;
-    schema: ParsedSchema;
+interface ParameterSample extends NoReference<OpenAPIV3_1.ParameterObject> {
     sample: unknown;
+    isAuthOnly: boolean;
 }
 export declare function generateSample(path: string, method: MethodInformation, { baseUrl, schema: { document } }: RenderContext): EndpointSample;
 export {};

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;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"}
+{"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,EACjB,KAAK,WAAW,EACjB,MAAM,gBAAgB,CAAC;AAExB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,MAAM,WAAW,OAAO;IACtB,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,OAAO,CAAC;KAClB,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,eAAgB,SAAQ,WAAW,CAAC,WAAW,CAAC,eAAe,CAAC;IACxE,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,EAAE,OAAO,CAAC;CACrB;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,CAsHhB"}

package/dist/utils/generate-sample.js

@@ -5,31 +5,27 @@ export function generateSample(path, method, { baseUrl, schema: { document } })
     const params = [];
     const responses = {};
     for (const param of method.parameters ?? []) {
-        if (param.schema) {
-            let value = param.example ?? sample(param.schema);
-            if (param.schema.type && param.schema.type === value) {
-                // if no example is defined make sure its visible that there is still a placeholder, equal to auth <token>
-                value = `<${value}>`;
-            }
-            params.push({
-                name: param.name,
-                in: param.in,
-                schema: param.schema,
-                sample: value,
-            });
-        }
-        else if (param.content) {
+        let schema = param.schema, value;
+        if (!schema && param.content) {
             const key = getPreferredType(param.content);
             const content = key ? param.content[key] : undefined;
-            if (!key || !content)
+            if (!content)
                 throw new Error(`Cannot find parameter schema for ${param.name} in ${path} ${method.method}`);
-            params.push({
-                name: param.name,
-                in: param.in,
-                schema: content.schema ?? {},
-                sample: content.example ?? param.example ?? sample(content.schema),
-            });
+            schema = content.schema;
+            value = content.example ?? param.example ?? sample(schema);
+        }
+        else {
+            value = param.example ?? sample(schema);
         }
+        if (schema?.type && param.schema?.type === value) {
+            // if no example is defined make sure its visible that there is still a placeholder, equal to auth <token>
+            value = `<${value}>`;
+        }
+        params.push({
+            ...param,
+            sample: value,
+            isAuthOnly: false,
+        });
     }
     const requirements = method.security ?? document.security;
     if (requirements && requirements.length > 0) {
@@ -42,6 +38,7 @@ export function generateSample(path, method, { baseUrl, schema: { document } })
                 },
                 sample: prefix ? `${prefix} <token>` : '<token>',
                 in: 'header',
+                isAuthOnly: true,
             });
         }
     }
@@ -84,15 +81,10 @@ export function generateSample(path, method, { baseUrl, schema: { document } })
     let pathWithParameters = path;
     const queryParams = new URLSearchParams();
     for (const param of params) {
-        let value = generateBody(method.method, param.schema);
-        if (param.schema.type && param.schema.type === value) {
-            // if no example is defined make sure its visible that there is still a placeholder, equal to auth <token>
-            value = `<${value}>`;
-        }
         if (param.in === 'query')
-            queryParams.append(param.name, String(value));
+            queryParams.append(param.name, String(param.sample));
         if (param.in === 'path')
-            pathWithParameters = pathWithParameters.replace(`{${param.name}}`, String(value));
+            pathWithParameters = pathWithParameters.replace(`{${param.name}}`, String(param.sample));
     }
     if (queryParams.size > 0)
         pathWithParameters = `${pathWithParameters}?${queryParams.toString()}`;

package/dist/utils/input-to-string.d.ts

@@ -1,5 +1,5 @@
 /**
  * Convert input value to hardcoded string (with quotes)
  */
-export declare function inputToString(value: unknown, mediaType?: string, multiLine?: 'single-quote' | 'backtick' | 'none'): string;
+export declare function inputToString(value: unknown, mediaType?: string, multiLine?: 'single-quote' | 'backtick' | 'python' | 'none'): string;
 //# sourceMappingURL=input-to-string.d.ts.map

package/dist/utils/input-to-string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"input-to-string.d.ts","sourceRoot":"","sources":["../../src/utils/input-to-string.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAgB,aAAa,CAC3B,KAAK,EAAE,OAAO,EACd,SAAS,SAAqB,EAC9B,SAAS,GAAE,cAAc,GAAG,UAAU,GAAG,MAAe,GACvD,MAAM,CAqBR"}
+{"version":3,"file":"input-to-string.d.ts","sourceRoot":"","sources":["../../src/utils/input-to-string.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAgB,aAAa,CAC3B,KAAK,EAAE,OAAO,EACd,SAAS,SAAqB,EAC9B,SAAS,GAAE,cAAc,GAAG,UAAU,GAAG,QAAQ,GAAG,MAAe,GAClE,MAAM,CAwBR"}

package/dist/utils/input-to-string.js

@@ -6,7 +6,7 @@ export function inputToString(value, mediaType = 'application/json', multiLine =
     const getStr = (v) => {
         if (multiLine === 'none')
             return JSON.stringify(v);
-        const delimit = multiLine === 'backtick' ? `\`` : `'`;
+        const delimit = { backtick: `\``, 'single-quote': `'`, python: `"""` }[multiLine];
         return `${delimit}${v.replaceAll(delimit, `\\${delimit}`)}${delimit}`;
     };
     if (typeof value === 'string')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-openapi",
-  "version": "6.0.7",
+  "version": "6.0.9",
   "description": "Generate MDX docs for your OpenAPI spec",
   "keywords": [
     "NextJs",
@@ -57,8 +57,8 @@
     "remark-rehype": "^11.1.1",
     "shiki": "^2.3.2",
     "xml-js": "^1.6.11",
-    "fumadocs-core": "15.0.6",
-    "fumadocs-ui": "15.0.6"
+    "fumadocs-core": "15.0.8",
+    "fumadocs-ui": "15.0.8"
   },
   "devDependencies": {
     "@scalar/api-client-react": "^1.1.25",