@scalar/api-reference
Version:
Generate beautiful API references from OpenAPI documents
66 lines • 4.12 kB
TypeScript
import type { ApiReferenceConfiguration } from '@scalar/types';
/**
* Maps a partial ApiReferenceConfigurationWithSources object to a DocumentConfiguration
* for use in the API Reference. This function transforms configuration options
* into the expected structure for the 'x-scalar-reference-config' property.
*
* @param config - Partial configuration object for the API Reference
* @returns DocumentConfiguration object with mapped settings
*/
export declare const mapConfiguration: (config: Partial<ApiReferenceConfiguration>) => {
'x-scalar-reference-config': {
title: string | undefined;
slug: string | undefined;
features: {
showModels: boolean;
expandAllTagSections: boolean | undefined;
persistAuthenticationState: boolean | undefined;
showDarkModeToggle: boolean;
showDownload: boolean;
showSearch: boolean;
showSidebar: boolean | undefined;
showTestRequestButton: boolean;
};
appearance: {
css: string | undefined;
favicon: string | undefined;
forceColorMode: "dark" | "light" | undefined;
initialColorMode: "dark" | undefined;
layout: "modern" | "classic" | undefined;
loadDefaultFonts: boolean | undefined;
theme: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none" | undefined;
};
routing: {
basePath: string | undefined;
};
settings: {
proxyUrl: string | undefined;
searchKey: "a" | "b" | "i" | "p" | "q" | "s" | "u" | "g" | "c" | "r" | "d" | "e" | "f" | "h" | "j" | "k" | "l" | "m" | "n" | "o" | "t" | "v" | "w" | "x" | "y" | "z" | undefined;
baseServerUrl: string | undefined;
servers: any[] | undefined;
};
meta: any;
tagSort: "alpha" | import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [import("zod").ZodAny, import("zod").ZodAny], null>, import("zod").ZodNumber> | undefined;
operationsSorter: "alpha" | import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [import("zod").ZodAny, import("zod").ZodAny], null>, import("zod").ZodNumber> | "method" | undefined;
generateHeadingSlug: import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
slug: import("zod").ZodDefault<import("zod").ZodString>;
}, import("zod/v4/core").$strip>], null>, import("zod").ZodString> | undefined;
generateModelSlug: import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
name: import("zod").ZodDefault<import("zod").ZodString>;
}, import("zod/v4/core").$strip>], null>, import("zod").ZodString> | undefined;
generateOperationSlug: import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
path: import("zod").ZodString;
operationId: import("zod").ZodOptional<import("zod").ZodString>;
method: import("zod").ZodString;
summary: import("zod").ZodOptional<import("zod").ZodString>;
}, import("zod/v4/core").$strip>], null>, import("zod").ZodString> | undefined;
generateTagSlug: import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
name: import("zod").ZodDefault<import("zod").ZodString>;
}, import("zod/v4/core").$strip>], null>, import("zod").ZodString> | undefined;
generateWebhookSlug: import("zod/v4/core").$InferOuterFunctionType<import("zod").ZodTuple<readonly [import("zod").ZodObject<{
name: import("zod").ZodString;
method: import("zod").ZodOptional<import("zod").ZodString>;
}, import("zod/v4/core").$strip>], null>, import("zod").ZodString> | undefined;
};
};
//# sourceMappingURL=map-configuration.d.ts.map