@scalar/types
Version:
Types to work with Scalar packages
1,175 lines • 68.9 kB
TypeScript
import { z } from 'zod';
/** Configuration for the OpenAPI/Swagger specification */
export declare const specConfigurationSchema: z.ZodObject<{
/**
* URL to an OpenAPI/Swagger document
*
* @deprecated Please move `url` to the top level and remove the `spec` prefix.
*
* @example
* ```ts
* const oldConfiguration = {
* spec: {
* url: 'https://example.com/openapi.json',
* },
* }
*
* const newConfiguration = {
* url: 'https://example.com/openapi.json',
* }
* ```
**/
url: z.ZodOptional<z.ZodString>;
/**
* Directly embed the OpenAPI document.
* Can be a string, object, function returning an object, or null.
*
* @remarks It's recommended to pass a URL instead of content.
*
* @deprecated Please move `content` to the top level and remove the `spec` prefix.
*
* @example
* ```ts
* const oldConfiguration = {
* spec: {
* content: '…',
* },
* }
*
* const newConfiguration = {
* content: '…',
* }
* ```
**/
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
/**
* The title of the OpenAPI document.
*
* @example 'Scalar Galaxy'
*
* @deprecated Please move `title` to the top level and remove the `spec` prefix.
*/
title: z.ZodOptional<z.ZodString>;
/**
* The slug of the OpenAPI document used in the URL.
*
* If none is passed, the title will be used.
*
* If no title is used, it’ll just use the index.
*
* @example 'scalar-galaxy'
*
* @deprecated Please move `slug` to the top level and remove the `spec` prefix.
*/
slug: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
}, {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
}>;
export type SpecConfiguration = z.infer<typeof specConfigurationSchema>;
/** Configuration for the Api Client */
export declare const apiClientConfigurationSchema: z.ZodObject<{
/**
* URL to an OpenAPI/Swagger document
**/
url: z.ZodOptional<z.ZodString>;
/**
* Directly embed the OpenAPI document.
* Can be a string, object, function returning an object, or null.
*
* @remarks It’s recommended to pass a URL instead of content.
**/
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
/**
* The title of the OpenAPI document.
*
* @example 'Scalar Galaxy'
*/
title: z.ZodOptional<z.ZodString>;
/**
* The slug of the OpenAPI document used in the URL.
*
* If none is passed, the title will be used.
*
* If no title is used, it’ll just use the index.
*
* @example 'scalar-galaxy'
*/
slug: z.ZodOptional<z.ZodString>;
/**
* The OpenAPI/Swagger document to render
*
* @deprecated Use `url` and `content` on the top level instead.
**/
spec: z.ZodOptional<z.ZodObject<{
/**
* URL to an OpenAPI/Swagger document
*
* @deprecated Please move `url` to the top level and remove the `spec` prefix.
*
* @example
* ```ts
* const oldConfiguration = {
* spec: {
* url: 'https://example.com/openapi.json',
* },
* }
*
* const newConfiguration = {
* url: 'https://example.com/openapi.json',
* }
* ```
**/
url: z.ZodOptional<z.ZodString>;
/**
* Directly embed the OpenAPI document.
* Can be a string, object, function returning an object, or null.
*
* @remarks It's recommended to pass a URL instead of content.
*
* @deprecated Please move `content` to the top level and remove the `spec` prefix.
*
* @example
* ```ts
* const oldConfiguration = {
* spec: {
* content: '…',
* },
* }
*
* const newConfiguration = {
* content: '…',
* }
* ```
**/
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
/**
* The title of the OpenAPI document.
*
* @example 'Scalar Galaxy'
*
* @deprecated Please move `title` to the top level and remove the `spec` prefix.
*/
title: z.ZodOptional<z.ZodString>;
/**
* The slug of the OpenAPI document used in the URL.
*
* If none is passed, the title will be used.
*
* If no title is used, it’ll just use the index.
*
* @example 'scalar-galaxy'
*
* @deprecated Please move `slug` to the top level and remove the `spec` prefix.
*/
slug: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
}, {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
}>>;
/** Prefill authentication */
authentication: z.ZodOptional<z.ZodAny>;
/** Base URL for the API server */
baseServerURL: z.ZodOptional<z.ZodString>;
/**
* Whether to hide the client button
* @default false
*/
hideClientButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/** URL to a request proxy for the API client */
proxyUrl: z.ZodOptional<z.ZodString>;
/** Key used with CTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k) */
searchHotKey: z.ZodOptional<z.ZodEnum<["a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z"]>>;
/** List of OpenAPI server objects */
servers: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
/**
* Whether to show the sidebar
* @default true
*/
showSidebar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/** A string to use one of the color presets */
theme: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<["alternate", "default", "moon", "purple", "solarized", "bluePlanet", "deepSpace", "saturn", "kepler", "elysiajs", "fastify", "mars", "none"]>>>>;
/** Integration type identifier */
_integration: z.ZodOptional<z.ZodNullable<z.ZodEnum<["adonisjs", "docusaurus", "dotnet", "elysiajs", "express", "fastapi", "fastify", "go", "hono", "html", "laravel", "litestar", "nestjs", "nextjs", "nitro", "nuxt", "platformatic", "react", "rust", "vue"]>>>;
}, "strip", z.ZodTypeAny, {
hideClientButton: boolean;
showSidebar: boolean;
theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
spec?: {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
} | undefined;
authentication?: any;
baseServerURL?: string | undefined;
proxyUrl?: string | undefined;
searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
servers?: any[] | undefined;
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
}, {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
spec?: {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
} | undefined;
authentication?: any;
baseServerURL?: string | undefined;
hideClientButton?: unknown;
proxyUrl?: string | undefined;
searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
servers?: any[] | undefined;
showSidebar?: unknown;
theme?: unknown;
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
}>;
export type ApiClientConfiguration = z.infer<typeof apiClientConfigurationSchema>;
/** Configuration for the Api Reference */
export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendShape<{
/**
* URL to an OpenAPI/Swagger document
**/
url: z.ZodOptional<z.ZodString>;
/**
* Directly embed the OpenAPI document.
* Can be a string, object, function returning an object, or null.
*
* @remarks It’s recommended to pass a URL instead of content.
**/
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
/**
* The title of the OpenAPI document.
*
* @example 'Scalar Galaxy'
*/
title: z.ZodOptional<z.ZodString>;
/**
* The slug of the OpenAPI document used in the URL.
*
* If none is passed, the title will be used.
*
* If no title is used, it’ll just use the index.
*
* @example 'scalar-galaxy'
*/
slug: z.ZodOptional<z.ZodString>;
/**
* The OpenAPI/Swagger document to render
*
* @deprecated Use `url` and `content` on the top level instead.
**/
spec: z.ZodOptional<z.ZodObject<{
/**
* URL to an OpenAPI/Swagger document
*
* @deprecated Please move `url` to the top level and remove the `spec` prefix.
*
* @example
* ```ts
* const oldConfiguration = {
* spec: {
* url: 'https://example.com/openapi.json',
* },
* }
*
* const newConfiguration = {
* url: 'https://example.com/openapi.json',
* }
* ```
**/
url: z.ZodOptional<z.ZodString>;
/**
* Directly embed the OpenAPI document.
* Can be a string, object, function returning an object, or null.
*
* @remarks It's recommended to pass a URL instead of content.
*
* @deprecated Please move `content` to the top level and remove the `spec` prefix.
*
* @example
* ```ts
* const oldConfiguration = {
* spec: {
* content: '…',
* },
* }
*
* const newConfiguration = {
* content: '…',
* }
* ```
**/
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
/**
* The title of the OpenAPI document.
*
* @example 'Scalar Galaxy'
*
* @deprecated Please move `title` to the top level and remove the `spec` prefix.
*/
title: z.ZodOptional<z.ZodString>;
/**
* The slug of the OpenAPI document used in the URL.
*
* If none is passed, the title will be used.
*
* If no title is used, it’ll just use the index.
*
* @example 'scalar-galaxy'
*
* @deprecated Please move `slug` to the top level and remove the `spec` prefix.
*/
slug: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
}, {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
}>>;
/** Prefill authentication */
authentication: z.ZodOptional<z.ZodAny>;
/** Base URL for the API server */
baseServerURL: z.ZodOptional<z.ZodString>;
/**
* Whether to hide the client button
* @default false
*/
hideClientButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/** URL to a request proxy for the API client */
proxyUrl: z.ZodOptional<z.ZodString>;
/** Key used with CTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k) */
searchHotKey: z.ZodOptional<z.ZodEnum<["a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z"]>>;
/** List of OpenAPI server objects */
servers: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
/**
* Whether to show the sidebar
* @default true
*/
showSidebar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/** A string to use one of the color presets */
theme: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<["alternate", "default", "moon", "purple", "solarized", "bluePlanet", "deepSpace", "saturn", "kepler", "elysiajs", "fastify", "mars", "none"]>>>>;
/** Integration type identifier */
_integration: z.ZodOptional<z.ZodNullable<z.ZodEnum<["adonisjs", "docusaurus", "dotnet", "elysiajs", "express", "fastapi", "fastify", "go", "hono", "html", "laravel", "litestar", "nestjs", "nextjs", "nitro", "nuxt", "platformatic", "react", "rust", "vue"]>>>;
}, {
/**
* The layout to use for the references
* @default 'modern'
*/
layout: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<["modern", "classic"]>>>>;
/**
* URL to a request proxy for the API client
* @deprecated Use proxyUrl instead
*/
proxy: z.ZodOptional<z.ZodString>;
/**
* Whether the spec input should show
* @default false
*/
isEditable: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/**
* Whether to show models in the sidebar, search, and content.
* @default false
*/
hideModels: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/**
* Whether to show the "Download OpenAPI Document" button
* @default false
*/
hideDownloadButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/**
* Whether to show the "Test Request" button
* @default false
*/
hideTestRequestButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/**
* Whether to show the sidebar search bar
* @default false
*/
hideSearch: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/** Whether dark mode is on or off initially (light mode) */
darkMode: z.ZodOptional<z.ZodBoolean>;
/** forceDarkModeState makes it always this state no matter what */
forceDarkModeState: z.ZodOptional<z.ZodEnum<["dark", "light"]>>;
/**
* Whether to show the dark mode toggle
* @default false
*/
hideDarkModeToggle: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/**
* If used, passed data will be added to the HTML header
* @see https://unhead.unjs.io/usage/composables/use-seo-meta
*/
metaData: z.ZodOptional<z.ZodAny>;
/**
* Path to a favicon image
* @default undefined
* @example '/favicon.svg'
*/
favicon: z.ZodOptional<z.ZodString>;
/**
* List of httpsnippet clients to hide from the clients menu
* By default hides Unirest, pass `[]` to show all clients
*/
hiddenClients: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>, z.ZodArray<z.ZodString, "many">, z.ZodLiteral<true>]>>;
/** Determine the HTTP client that's selected by default */
defaultHttpClient: z.ZodOptional<z.ZodObject<{
targetKey: z.ZodType<"c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart", z.ZodTypeDef, "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart">;
clientKey: z.ZodString;
}, "strip", z.ZodTypeAny, {
targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
clientKey: string;
}, {
targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
clientKey: string;
}>>;
/** Custom CSS to be added to the page */
customCss: z.ZodOptional<z.ZodString>;
/** onSpecUpdate is fired on spec/swagger content change */
onSpecUpdate: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>>;
/** onServerChange is fired on selected server change */
onServerChange: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>>;
/**
* Route using paths instead of hashes, your server MUST support this
* @example '/standalone-api-reference/:custom(.*)?'
* @experimental
* @default undefined
*/
pathRouting: z.ZodOptional<z.ZodObject<{
/** Base path for the API reference */
basePath: z.ZodString;
}, "strip", z.ZodTypeAny, {
basePath: string;
}, {
basePath: string;
}>>;
/**
* Customize the heading portion of the hash
* @param heading - The heading object
* @returns A string ID used to generate the URL hash
* @default (heading) => `#description/${heading.slug}`
*/
generateHeadingSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
slug: z.ZodDefault<z.ZodString>;
}, "strip", z.ZodTypeAny, {
slug: string;
}, {
slug?: string | undefined;
}>], z.ZodUnknown>, z.ZodString>>;
/**
* Customize the model portion of the hash
* @param model - The model object with a name property
* @returns A string ID used to generate the URL hash
* @default (model) => slug(model.name)
*/
generateModelSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
name: z.ZodDefault<z.ZodString>;
}, "strip", z.ZodTypeAny, {
name: string;
}, {
name?: string | undefined;
}>], z.ZodUnknown>, z.ZodString>>;
/**
* Customize the tag portion of the hash
* @param tag - The tag object
* @returns A string ID used to generate the URL hash
* @default (tag) => slug(tag.name)
*/
generateTagSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
name: z.ZodDefault<z.ZodString>;
}, "strip", z.ZodTypeAny, {
name: string;
}, {
name?: string | undefined;
}>], z.ZodUnknown>, z.ZodString>>;
/**
* Customize the operation portion of the hash
* @param operation - The operation object
* @returns A string ID used to generate the URL hash
* @default (operation) => `${operation.method}${operation.path}`
*/
generateOperationSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
path: z.ZodString;
operationId: z.ZodOptional<z.ZodString>;
method: z.ZodString;
summary: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
path: string;
method: string;
operationId?: string | undefined;
summary?: string | undefined;
}, {
path: string;
method: string;
operationId?: string | undefined;
summary?: string | undefined;
}>], z.ZodUnknown>, z.ZodString>>;
/**
* Customize the webhook portion of the hash
* @param webhook - The webhook object
* @returns A string ID used to generate the URL hash
* @default (webhook) => slug(webhook.name)
*/
generateWebhookSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
name: z.ZodString;
method: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
name: string;
method?: string | undefined;
}, {
name: string;
method?: string | undefined;
}>], z.ZodUnknown>, z.ZodString>>;
/** Callback fired when the reference is fully loaded */
onLoaded: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
/**
* To handle redirects, pass a function that will recieve:
* - The current path with hash if pathRouting is enabled
* - The current hash if hashRouting (default)
* And then passes that to history.replaceState
*
* @example hashRouting (default)
* ```ts
* redirect: (hash: string) => hash.replace('#v1/old-path', '#v2/new-path')
* ```
* @example pathRouting
* ```ts
* redirect: (pathWithHash: string) => {
* if (pathWithHash.includes('#')) {
* return pathWithHash.replace('/v1/tags/user#operation/get-user', '/v1/tags/user/operation/get-user')
* }
* return null
* }
* ```
*/
redirect: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodOptional<z.ZodNullable<z.ZodString>>>>;
/**
* Whether to include default fonts
* @default true
*/
withDefaultFonts: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/** Whether to expand all tags by default */
defaultOpenAllTags: z.ZodOptional<z.ZodBoolean>;
/**
* Function to sort tags
* @default 'alpha' for alphabetical sorting
*/
tagsSorter: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"alpha">, z.ZodFunction<z.ZodTuple<[z.ZodAny, z.ZodAny], z.ZodUnknown>, z.ZodNumber>]>>;
/**
* Function to sort operations
* @default 'alpha' for alphabetical sorting
*/
operationsSorter: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"alpha">, z.ZodLiteral<"method">, z.ZodFunction<z.ZodTuple<[z.ZodAny, z.ZodAny], z.ZodUnknown>, z.ZodNumber>]>>;
}>, "strip", z.ZodTypeAny, {
hideClientButton: boolean;
showSidebar: boolean;
theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
layout: "modern" | "classic";
isEditable: boolean;
hideModels: boolean;
hideDownloadButton: boolean;
hideTestRequestButton: boolean;
hideSearch: boolean;
hideDarkModeToggle: boolean;
withDefaultFonts: boolean;
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
spec?: {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
} | undefined;
authentication?: any;
baseServerURL?: string | undefined;
proxyUrl?: string | undefined;
searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
servers?: any[] | undefined;
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
proxy?: string | undefined;
darkMode?: boolean | undefined;
forceDarkModeState?: "dark" | "light" | undefined;
metaData?: any;
favicon?: string | undefined;
hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
defaultHttpClient?: {
targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
clientKey: string;
} | undefined;
customCss?: string | undefined;
onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
pathRouting?: {
basePath: string;
} | undefined;
generateHeadingSlug?: ((args_0: {
slug?: string | undefined;
}, ...args: unknown[]) => string) | undefined;
generateModelSlug?: ((args_0: {
name?: string | undefined;
}, ...args: unknown[]) => string) | undefined;
generateTagSlug?: ((args_0: {
name?: string | undefined;
}, ...args: unknown[]) => string) | undefined;
generateOperationSlug?: ((args_0: {
path: string;
method: string;
operationId?: string | undefined;
summary?: string | undefined;
}, ...args: unknown[]) => string) | undefined;
generateWebhookSlug?: ((args_0: {
name: string;
method?: string | undefined;
}, ...args: unknown[]) => string) | undefined;
onLoaded?: ((...args: unknown[]) => void) | undefined;
redirect?: ((args_0: string, ...args: unknown[]) => string | null | undefined) | undefined;
defaultOpenAllTags?: boolean | undefined;
tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
}, {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
spec?: {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
} | undefined;
authentication?: any;
baseServerURL?: string | undefined;
hideClientButton?: unknown;
proxyUrl?: string | undefined;
searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
servers?: any[] | undefined;
showSidebar?: unknown;
theme?: unknown;
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
layout?: unknown;
proxy?: string | undefined;
isEditable?: unknown;
hideModels?: unknown;
hideDownloadButton?: unknown;
hideTestRequestButton?: unknown;
hideSearch?: unknown;
darkMode?: boolean | undefined;
forceDarkModeState?: "dark" | "light" | undefined;
hideDarkModeToggle?: unknown;
metaData?: any;
favicon?: string | undefined;
hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
defaultHttpClient?: {
targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
clientKey: string;
} | undefined;
customCss?: string | undefined;
onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
pathRouting?: {
basePath: string;
} | undefined;
generateHeadingSlug?: ((args_0: {
slug: string;
}, ...args: unknown[]) => string) | undefined;
generateModelSlug?: ((args_0: {
name: string;
}, ...args: unknown[]) => string) | undefined;
generateTagSlug?: ((args_0: {
name: string;
}, ...args: unknown[]) => string) | undefined;
generateOperationSlug?: ((args_0: {
path: string;
method: string;
operationId?: string | undefined;
summary?: string | undefined;
}, ...args: unknown[]) => string) | undefined;
generateWebhookSlug?: ((args_0: {
name: string;
method?: string | undefined;
}, ...args: unknown[]) => string) | undefined;
onLoaded?: ((...args: unknown[]) => void) | undefined;
redirect?: ((args_0: string, ...args: unknown[]) => string | null | undefined) | undefined;
withDefaultFonts?: unknown;
defaultOpenAllTags?: boolean | undefined;
tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
}>, {
hideClientButton: boolean;
showSidebar: boolean;
theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
layout: "modern" | "classic";
isEditable: boolean;
hideModels: boolean;
hideDownloadButton: boolean;
hideTestRequestButton: boolean;
hideSearch: boolean;
hideDarkModeToggle: boolean;
withDefaultFonts: boolean;
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
spec?: {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
} | undefined;
authentication?: any;
baseServerURL?: string | undefined;
proxyUrl?: string | undefined;
searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
servers?: any[] | undefined;
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
proxy?: string | undefined;
darkMode?: boolean | undefined;
forceDarkModeState?: "dark" | "light" | undefined;
metaData?: any;
favicon?: string | undefined;
hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
defaultHttpClient?: {
targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
clientKey: string;
} | undefined;
customCss?: string | undefined;
onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
pathRouting?: {
basePath: string;
} | undefined;
generateHeadingSlug?: ((args_0: {
slug?: string | undefined;
}, ...args: unknown[]) => string) | undefined;
generateModelSlug?: ((args_0: {
name?: string | undefined;
}, ...args: unknown[]) => string) | undefined;
generateTagSlug?: ((args_0: {
name?: string | undefined;
}, ...args: unknown[]) => string) | undefined;
generateOperationSlug?: ((args_0: {
path: string;
method: string;
operationId?: string | undefined;
summary?: string | undefined;
}, ...args: unknown[]) => string) | undefined;
generateWebhookSlug?: ((args_0: {
name: string;
method?: string | undefined;
}, ...args: unknown[]) => string) | undefined;
onLoaded?: ((...args: unknown[]) => void) | undefined;
redirect?: ((args_0: string, ...args: unknown[]) => string | null | undefined) | undefined;
defaultOpenAllTags?: boolean | undefined;
tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
}, {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
spec?: {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
} | undefined;
authentication?: any;
baseServerURL?: string | undefined;
hideClientButton?: unknown;
proxyUrl?: string | undefined;
searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
servers?: any[] | undefined;
showSidebar?: unknown;
theme?: unknown;
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
layout?: unknown;
proxy?: string | undefined;
isEditable?: unknown;
hideModels?: unknown;
hideDownloadButton?: unknown;
hideTestRequestButton?: unknown;
hideSearch?: unknown;
darkMode?: boolean | undefined;
forceDarkModeState?: "dark" | "light" | undefined;
hideDarkModeToggle?: unknown;
metaData?: any;
favicon?: string | undefined;
hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
defaultHttpClient?: {
targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
clientKey: string;
} | undefined;
customCss?: string | undefined;
onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
pathRouting?: {
basePath: string;
} | undefined;
generateHeadingSlug?: ((args_0: {
slug: string;
}, ...args: unknown[]) => string) | undefined;
generateModelSlug?: ((args_0: {
name: string;
}, ...args: unknown[]) => string) | undefined;
generateTagSlug?: ((args_0: {
name: string;
}, ...args: unknown[]) => string) | undefined;
generateOperationSlug?: ((args_0: {
path: string;
method: string;
operationId?: string | undefined;
summary?: string | undefined;
}, ...args: unknown[]) => string) | undefined;
generateWebhookSlug?: ((args_0: {
name: string;
method?: string | undefined;
}, ...args: unknown[]) => string) | undefined;
onLoaded?: ((...args: unknown[]) => void) | undefined;
redirect?: ((args_0: string, ...args: unknown[]) => string | null | undefined) | undefined;
withDefaultFonts?: unknown;
defaultOpenAllTags?: boolean | undefined;
tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
}>;
/** Configuration after parsing, this is the main type */
export type ApiReferenceConfiguration = Omit<z.infer<typeof apiReferenceConfigurationSchema>, 'proxy' | 'spec'>;
/** Props for the ApiReference components, coming from user input */
export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
/**
* URL to an OpenAPI/Swagger document
**/
url: z.ZodOptional<z.ZodString>;
/**
* Directly embed the OpenAPI document.
* Can be a string, object, function returning an object, or null.
*
* @remarks It’s recommended to pass a URL instead of content.
**/
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
/**
* The title of the OpenAPI document.
*
* @example 'Scalar Galaxy'
*/
title: z.ZodOptional<z.ZodString>;
/**
* The slug of the OpenAPI document used in the URL.
*
* If none is passed, the title will be used.
*
* If no title is used, it’ll just use the index.
*
* @example 'scalar-galaxy'
*/
slug: z.ZodOptional<z.ZodString>;
/**
* The OpenAPI/Swagger document to render
*
* @deprecated Use `url` and `content` on the top level instead.
**/
spec: z.ZodOptional<z.ZodObject<{
/**
* URL to an OpenAPI/Swagger document
*
* @deprecated Please move `url` to the top level and remove the `spec` prefix.
*
* @example
* ```ts
* const oldConfiguration = {
* spec: {
* url: 'https://example.com/openapi.json',
* },
* }
*
* const newConfiguration = {
* url: 'https://example.com/openapi.json',
* }
* ```
**/
url: z.ZodOptional<z.ZodString>;
/**
* Directly embed the OpenAPI document.
* Can be a string, object, function returning an object, or null.
*
* @remarks It's recommended to pass a URL instead of content.
*
* @deprecated Please move `content` to the top level and remove the `spec` prefix.
*
* @example
* ```ts
* const oldConfiguration = {
* spec: {
* content: '…',
* },
* }
*
* const newConfiguration = {
* content: '…',
* }
* ```
**/
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
/**
* The title of the OpenAPI document.
*
* @example 'Scalar Galaxy'
*
* @deprecated Please move `title` to the top level and remove the `spec` prefix.
*/
title: z.ZodOptional<z.ZodString>;
/**
* The slug of the OpenAPI document used in the URL.
*
* If none is passed, the title will be used.
*
* If no title is used, it’ll just use the index.
*
* @example 'scalar-galaxy'
*
* @deprecated Please move `slug` to the top level and remove the `spec` prefix.
*/
slug: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
}, {
url?: string | undefined;
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
title?: string | undefined;
slug?: string | undefined;
}>>;
/** Prefill authentication */
authentication: z.ZodOptional<z.ZodAny>;
/** Base URL for the API server */
baseServerURL: z.ZodOptional<z.ZodString>;
/**
* Whether to hide the client button
* @default false
*/
hideClientButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/** URL to a request proxy for the API client */
proxyUrl: z.ZodOptional<z.ZodString>;
/** Key used with CTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k) */
searchHotKey: z.ZodOptional<z.ZodEnum<["a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z"]>>;
/** List of OpenAPI server objects */
servers: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
/**
* Whether to show the sidebar
* @default true
*/
showSidebar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/** A string to use one of the color presets */
theme: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<["alternate", "default", "moon", "purple", "solarized", "bluePlanet", "deepSpace", "saturn", "kepler", "elysiajs", "fastify", "mars", "none"]>>>>;
/** Integration type identifier */
_integration: z.ZodOptional<z.ZodNullable<z.ZodEnum<["adonisjs", "docusaurus", "dotnet", "elysiajs", "express", "fastapi", "fastify", "go", "hono", "html", "laravel", "litestar", "nestjs", "nextjs", "nitro", "nuxt", "platformatic", "react", "rust", "vue"]>>>;
}, {
/**
* The layout to use for the references
* @default 'modern'
*/
layout: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<["modern", "classic"]>>>>;
/**
* URL to a request proxy for the API client
* @deprecated Use proxyUrl instead
*/
proxy: z.ZodOptional<z.ZodString>;
/**
* Whether the spec input should show
* @default false
*/
isEditable: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/**
* Whether to show models in the sidebar, search, and content.
* @default false
*/
hideModels: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/**
* Whether to show the "Download OpenAPI Document" button
* @default false
*/
hideDownloadButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/**
* Whether to show the "Test Request" button
* @default false
*/
hideTestRequestButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/**
* Whether to show the sidebar search bar
* @default false
*/
hideSearch: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/** Whether dark mode is on or off initially (light mode) */
darkMode: z.ZodOptional<z.ZodBoolean>;
/** forceDarkModeState makes it always this state no matter what */
forceDarkModeState: z.ZodOptional<z.ZodEnum<["dark", "light"]>>;
/**
* Whether to show the dark mode toggle
* @default false
*/
hideDarkModeToggle: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
/**
* If used, passed data will be added to the HTML header
* @see https://unhead.unjs.io/usage/composables/use-seo-meta
*/
metaData: z.ZodOptional<z.ZodAny>;
/**
* Path to a favicon image
* @default undefined
* @example '/favicon.svg'
*/
favicon: z.ZodOptional<z.ZodString>;
/**
* List of httpsnippet clients to hide from the clients menu
* By default hides Unirest, pass `[]` to show all clients
*/
hiddenClients: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>, z.ZodArray<z.ZodString, "many">, z.ZodLiteral<true>]>>;
/** Determine the HTTP client that's selected by default */
defaultHttpClient: z.ZodOptional<z.ZodObject<{
targetKey: z.ZodType<"c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart", z.ZodTypeDef, "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart">;
clientKey: z.ZodString;
}, "strip", z.ZodTypeAny, {
targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
clientKey: string;
}, {
targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
clientKey: string;
}>>;
/** Custom CSS to be added to the page */
customCss: z.ZodOptional<z.ZodString>;
/** onSpecUpdate is fired on spec/swagger content change */
onSpecUpdate: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>>;
/** onServerChange is fired on selected server change */
onServerChange: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>>;
/**
* Route using paths instead of hashes, your server MUST support this
* @example '/standalone-api-reference/:custom(.*)?'
* @experimental
* @default undefined
*/
pathRouting: z.ZodOptional<z.ZodObject<{
/** Base path for the API reference */
basePath: z.ZodString;
}, "strip", z.ZodTypeAny, {
basePath: string;
}, {
basePath: string;
}>>;
/**
* Customize the heading portion of the hash
* @param heading - The heading object
* @returns A string ID used to generate the URL hash
* @default (heading) => `#description/${heading.slug}`
*/
generateHeadingSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
slug: z.ZodDefault<z.ZodString>;
}, "strip", z.ZodTypeAny, {
slug: string;
}, {
slug?: string | undefined;
}>], z.ZodUnknown>, z.ZodString>>;
/**
* Customize the model portion of the hash
* @param model - The model object with a name property
* @returns A string ID used to generate the URL hash
* @default (model) => slug(model.name)
*/
generateModelSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
name: z.ZodDefault<z.ZodString>;
}, "strip", z.ZodTypeAny, {
name: string;
}, {
name?: string | undefined;
}>], z.ZodUnknown>, z.ZodString>>;
/**
* Customize the tag portion of the hash
* @param tag - The tag object
* @returns A string ID used to generate the URL hash
* @default (tag) => slug(tag.name)
*/
generateTagSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
name: z.ZodDefault<z.ZodString>;
}, "strip", z.ZodTypeAny, {
name: string;
}, {
name?: string | undefined;
}>], z.ZodUnknown>, z.ZodString>>;
/**
* Customize the operation portion of the hash
* @param operation - The operation object
* @returns A string ID used to generate the URL hash
* @default (operation) => `${operation.method}${operation.path}`
*/
generateOperationSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
path: z.ZodString;
operationId: z.ZodOptional<z.ZodString>;
method: z.ZodString;
summary: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
path: string;
method: string;
operationId?: string | undefined;
summary?: string | undefined;
}, {
path: string;
method: string;
operationId?: string | undefined;
summary?: string | undefined;
}>], z.ZodUnknown>, z.ZodString>>;
/**
* Customize the webhook portion of the hash
* @param webhook - The webhook object
* @returns A string ID used to generate the URL hash
* @default (webhook) => slug(webhook.name)
*/
generateWebhookSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
name: z.ZodString;
method: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
name: string;
method?: string | undefined;
}, {
name: string;
method?: string | undefined;
}>], z.ZodUnknown>, z.ZodString>>;
/** Callback fired when the reference is fully loaded */
onLoaded: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
/**
* To handle redirects, pass a function that will recieve:
* - The current path with hash if pathRouting is enabled
* - The current hash if hashRouting (default)
* And then passes that to history.replaceState
*
* @example hashRouting (default)
* ```ts
* redirect: (