import type { RequestEvent, SecurityScheme } from '@scalar/oas-utils/entities/spec';
import type { Path, PathValue } from '@scalar/object-utils/nested';
import type { ApiReferenceConfiguration } from '@scalar/types/api-reference';
export type UpdateScheme =
>(path: P, value: NonNullable>) => void;
declare global {
interface Window {
dataDump: () => void;
}
}
export type CreateWorkspaceStoreOptions = {
/**
* When true, changes made to the store will be saved in the browser's localStorage.
*
* @default true
*/
useLocalStorage: boolean;
} & Pick;
/**
* Factory function for creating the centralized store for the API client.
*
* This store manages all data and state for the application.
* It should be instantiated once and injected into the app's root component.
*/
export declare const createWorkspaceStore: ({ useLocalStorage, showSidebar, proxyUrl, theme, hideClientButton, _integration, }: CreateWorkspaceStoreOptions) => {
workspaces: Record;
name: string;
description: string;
collections: (string & import("zod").$brand<"collection">)[];
environments: Record;
activeEnvironmentId: string;
cookies: (string & import("zod").$brand<"cookie">)[];
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none";
selectedHttpClient: {
targetKey: string;
clientKey: string;
};
hotKeyConfig?: {
modifiers: ("default" | "Meta" | "Control" | "Shift" | "Alt")[];
hotKeys?: Partial> | undefined;
} | undefined;
proxyUrl?: string | undefined;
}>;
collections: Record[];
'x-scalar-icon': string;
uid: string & import("zod").$brand<"collection">;
securitySchemes: string[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
servers: (string & import("zod").$brand<"server">)[];
requests: (string & import("zod").$brand<"operation">)[];
tags: (string & import("zod").$brand<"tag">)[];
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
watchMode: boolean;
useCollectionSecurity: boolean;
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
jsonSchemaDialect?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
components?: Record | undefined;
webhooks?: Record | undefined;
'x-scalar-active-environment'?: string | undefined;
'x-scalar-environments'?: Record;
description?: string | undefined;
color?: string | undefined;
}> | undefined;
'x-scalar-secrets'?: Record | undefined;
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
documentUrl?: string | undefined;
integration?: string | null | undefined;
}>;
tags: Record;
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
description?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
'x-scalar-children'?: {
tagName: string;
}[] | undefined;
'x-internal'?: boolean | undefined;
'x-scalar-ignore'?: boolean | undefined;
}>;
cookies: Record;
name: string;
value: string;
domain?: string | undefined;
path?: string | undefined;
}>;
environments: Record;
name: string;
color: string;
value: string;
isDefault?: boolean | undefined;
}>;
requestExamples: Record;
type: "requestExample";
name: string;
body: {
activeBody: "raw" | "formData" | "binary";
raw?: {
encoding: "html" | "text" | "xml" | "json" | "javascript" | "yaml" | "edn";
value: string;
mimeType?: string | undefined;
} | undefined;
formData?: {
encoding: "form-data" | "urlencoded";
value: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
} | undefined;
binary?: Blob | undefined;
};
parameters: {
path: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
query: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
headers: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
cookies: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
};
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
serverVariables?: Record | undefined;
}>;
requests: Record;
path: string;
method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
servers: (string & import("zod").$brand<"server">)[];
selectedServerUid: (string & import("zod").$brand<"server">) | null;
examples: (string & import("zod").$brand<"example">)[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
description?: string | undefined;
summary?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
'x-internal'?: boolean | undefined;
'x-scalar-ignore'?: boolean | undefined;
security?: Record[] | undefined;
tags?: string[] | undefined;
deprecated?: boolean | undefined;
operationId?: string | undefined;
requestBody?: any;
parameters?: {
in: "path" | "cookie" | "query" | "header";
name: string;
required: boolean;
deprecated: boolean;
description?: string | undefined;
schema?: unknown;
content?: unknown;
style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
explode?: boolean | undefined;
example?: unknown;
examples?: Record | unknown[] | undefined;
}[] | undefined;
responses?: Record | undefined;
callbacks?: Record>> | undefined;
'x-codeSamples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-code-samples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-custom-examples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-scalar-stability'?: import("@scalar/types/legacy").XScalarStability | undefined;
'x-post-response'?: string | undefined;
}>;
servers: Record;
description?: string | undefined;
variables?: Record | undefined;
}>;
securitySchemes: Record;
nameKey: string;
value: string;
description?: string | undefined;
} | {
type: "http";
scheme: "basic" | "bearer";
bearerFormat: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
username: string;
password: string;
token: string;
description?: string | undefined;
} | {
type: "openIdConnect";
openIdConnectUrl: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
} | {
type: "oauth2";
flows: {
implicit?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "implicit";
authorizationUrl: string;
"x-scalar-redirect-uri": string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
} | undefined;
password?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "password";
tokenUrl: string;
clientSecret: string;
username: string;
password: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
clientCredentials?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "clientCredentials";
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
authorizationCode?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "authorizationCode";
authorizationUrl: string;
"x-usePkce": "SHA-256" | "plain" | "no";
"x-scalar-redirect-uri": string;
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
};
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
'x-default-scopes'?: string[] | undefined;
}>;
modalState: {
open: boolean;
show: () => void;
hide: () => void;
};
events: {
executeRequest: import("../libs/index.js").EventBus<{
requestUid?: string;
}>;
focusAddressBar: import("../libs/index.js").EventBus;
cancelRequest: import("../libs/index.js").EventBus;
requestStatus: import("../libs/index.js").EventBus;
commandPalette: import("../libs/index.js").EventBus;
hotKeys: import("../libs/index.js").EventBus>>;
};
sidebarWidth: import("vue").Ref;
setSidebarWidth: (width: string) => void;
proxyUrl: string | undefined;
hideClientButton: boolean;
showSidebar: boolean;
integration: "elysiajs" | "fastify" | "adonisjs" | "astro" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "svelte" | "vue" | null | undefined;
importSpecFile: (_spec: string | Record | undefined, workspaceUid: string, options?: Pick<{
info: {
title: string;
version: string;
summary?: string | undefined;
description?: string | undefined;
termsOfService?: string | undefined;
contact?: {
name?: string | undefined;
url?: string | undefined;
email?: string | undefined;
} | undefined;
license?: {
name?: string | null | undefined;
identifier?: string | undefined;
url?: string | undefined;
} | undefined;
'x-scalar-sdk-installation'?: {
lang: string;
source?: string | undefined;
description?: string | undefined;
}[] | undefined;
};
type?: "collection" | undefined;
openapi?: string | undefined;
jsonSchemaDialect?: string | undefined;
security?: Record[] | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
components?: Record | undefined;
webhooks?: Record | undefined;
'x-scalar-icon'?: string | undefined;
'x-scalar-active-environment'?: string | undefined;
'x-scalar-environments'?: Record;
description?: string | undefined;
color?: string | undefined;
}> | undefined;
'x-scalar-secrets'?: Record | undefined;
uid?: string | undefined;
securitySchemes?: string[] | undefined;
selectedSecuritySchemeUids?: (string | string[])[] | undefined;
selectedServerUid?: string | undefined;
servers?: string[] | undefined;
requests?: string[] | undefined;
tags?: string[] | undefined;
children?: string[] | undefined;
documentUrl?: string | undefined;
watchMode?: boolean | undefined;
integration?: string | null | undefined;
useCollectionSecurity?: boolean | undefined;
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
}, "documentUrl" | "watchMode"> & Pick & {
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
useCollectionSecurity?: boolean;
shouldLoad?: boolean;
} & Pick & {
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
}) => Promise<{
error: false;
collection: import("@scalar/oas-utils/entities/spec").Collection;
requests: import("@scalar/oas-utils/entities/spec").Request[];
schema: import("@scalar/openapi-types").OpenAPIV3_1.Document;
examples: import("@scalar/oas-utils/entities/spec").RequestExample[];
servers: import("@scalar/oas-utils/entities/spec").Server[];
tags: import("@scalar/oas-utils/entities/spec").Tag[];
securitySchemes: SecurityScheme[];
} | undefined>;
importSpecFromUrl: (url: string, workspaceUid: string, { proxyUrl, ...options }?: Omit[] | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
components?: Record | undefined;
webhooks?: Record | undefined;
'x-scalar-icon'?: string | undefined;
'x-scalar-active-environment'?: string | undefined;
'x-scalar-environments'?: Record;
description?: string | undefined;
color?: string | undefined;
}> | undefined;
'x-scalar-secrets'?: Record | undefined;
uid?: string | undefined;
securitySchemes?: string[] | undefined;
selectedSecuritySchemeUids?: (string | string[])[] | undefined;
selectedServerUid?: string | undefined;
servers?: string[] | undefined;
requests?: string[] | undefined;
tags?: string[] | undefined;
children?: string[] | undefined;
documentUrl?: string | undefined;
watchMode?: boolean | undefined;
integration?: string | null | undefined;
useCollectionSecurity?: boolean | undefined;
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
}, "documentUrl" | "watchMode"> & Pick & {
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
useCollectionSecurity?: boolean;
shouldLoad?: boolean;
} & Pick & {
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
}, "documentUrl"> & Pick) => Promise | undefined, workspaceUid: string, options?: Pick<{
info: {
title: string;
version: string;
summary?: string | undefined;
description?: string | undefined;
termsOfService?: string | undefined;
contact?: {
name?: string | undefined;
url?: string | undefined;
email?: string | undefined;
} | undefined;
license?: {
name?: string | null | undefined;
identifier?: string | undefined;
url?: string | undefined;
} | undefined;
'x-scalar-sdk-installation'?: {
lang: string;
source?: string | undefined;
description?: string | undefined;
}[] | undefined;
};
type?: "collection" | undefined;
openapi?: string | undefined;
jsonSchemaDialect?: string | undefined;
security?: Record[] | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
components?: Record | undefined;
webhooks?: Record | undefined;
'x-scalar-icon'?: string | undefined;
'x-scalar-active-environment'?: string | undefined;
'x-scalar-environments'?: Record;
description?: string | undefined;
color?: string | undefined;
}> | undefined;
'x-scalar-secrets'?: Record | undefined;
uid?: string | undefined;
securitySchemes?: string[] | undefined;
selectedSecuritySchemeUids?: (string | string[])[] | undefined;
selectedServerUid?: string | undefined;
servers?: string[] | undefined;
requests?: string[] | undefined;
tags?: string[] | undefined;
children?: string[] | undefined;
documentUrl?: string | undefined;
watchMode?: boolean | undefined;
integration?: string | null | undefined;
useCollectionSecurity?: boolean | undefined;
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
}, "documentUrl" | "watchMode"> & Pick & {
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
useCollectionSecurity?: boolean;
shouldLoad?: boolean;
} & Pick & {
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
}) => Promise<{
error: false;
collection: import("@scalar/oas-utils/entities/spec").Collection;
requests: import("@scalar/oas-utils/entities/spec").Request[];
schema: import("@scalar/openapi-types").OpenAPIV3_1.Document;
examples: import("@scalar/oas-utils/entities/spec").RequestExample[];
servers: import("@scalar/oas-utils/entities/spec").Server[];
tags: import("@scalar/oas-utils/entities/spec").Tag[];
securitySchemes: SecurityScheme[];
} | undefined>>>>>;
cookieMutators: {
add: (item: {
uid: string & import("zod").$brand<"cookie">;
name: string;
value: string;
domain?: string | undefined;
path?: string | undefined;
}) => void;
delete: (uid: (string & import("zod").$brand<"cookie">) | null | undefined) => void;
set: (item: {
uid: string & import("zod").$brand<"cookie">;
name: string;
value: string;
domain?: string | undefined;
path?: string | undefined;
}) => void;
edit: (uid: (string & import("zod").$brand<"cookie">) | null | undefined, path: P, value: P extends "path" | "value" | "uid" | "name" | "domain" ? {
uid: string & import("zod").$brand<"cookie">;
name: string;
value: string;
domain?: string | undefined;
path?: string | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "path" | "value" | "uid" | "name" | "domain" ? R extends Path<{
uid: string & import("zod").$brand<"cookie">;
name: string;
value: string;
domain?: string | undefined;
path?: string | undefined;
}[K]> ? PathValue<{
uid: string & import("zod").$brand<"cookie">;
name: string;
value: string;
domain?: string | undefined;
path?: string | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
untrackedEdit:
(uid: string & import("zod").$brand<"cookie">, path: P, value: P extends "path" | "value" | "uid" | "name" | "domain" ? {
uid: string & import("zod").$brand<"cookie">;
name: string;
value: string;
domain?: string | undefined;
path?: string | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "path" | "value" | "uid" | "name" | "domain" ? R extends Path<{
uid: string & import("zod").$brand<"cookie">;
name: string;
value: string;
domain?: string | undefined;
path?: string | undefined;
}[K]> ? PathValue<{
uid: string & import("zod").$brand<"cookie">;
name: string;
value: string;
domain?: string | undefined;
path?: string | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
undo: (uid: string & import("zod").$brand<"cookie">) => void;
redo: (uid: string & import("zod").$brand<"cookie">) => void;
reset: () => void;
};
collectionMutators: {
rawAdd: (item: {
type: "collection";
openapi: string;
info: {
title: string;
version: string;
summary?: string | undefined;
description?: string | undefined;
termsOfService?: string | undefined;
contact?: {
name?: string | undefined;
url?: string | undefined;
email?: string | undefined;
} | undefined;
license?: {
name?: string | null | undefined;
identifier?: string | undefined;
url?: string | undefined;
} | undefined;
'x-scalar-sdk-installation'?: {
lang: string;
source?: string | undefined;
description?: string | undefined;
}[] | undefined;
};
security: Record[];
'x-scalar-icon': string;
uid: string & import("zod").$brand<"collection">;
securitySchemes: string[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
servers: (string & import("zod").$brand<"server">)[];
requests: (string & import("zod").$brand<"operation">)[];
tags: (string & import("zod").$brand<"tag">)[];
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
watchMode: boolean;
useCollectionSecurity: boolean;
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
jsonSchemaDialect?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
components?: Record | undefined;
webhooks?: Record | undefined;
'x-scalar-active-environment'?: string | undefined;
'x-scalar-environments'?: Record;
description?: string | undefined;
color?: string | undefined;
}> | undefined;
'x-scalar-secrets'?: Record | undefined;
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
documentUrl?: string | undefined;
integration?: string | null | undefined;
}) => void;
add: (payload: import("@scalar/oas-utils/entities/spec").CollectionPayload, workspaceUid: import("@scalar/oas-utils/entities/workspace").Workspace["uid"]) => {
type: "collection";
openapi: string;
info: {
title: string;
version: string;
summary?: string | undefined;
description?: string | undefined;
termsOfService?: string | undefined;
contact?: {
name?: string | undefined;
url?: string | undefined;
email?: string | undefined;
} | undefined;
license?: {
name?: string | null | undefined;
identifier?: string | undefined;
url?: string | undefined;
} | undefined;
'x-scalar-sdk-installation'?: {
lang: string;
source?: string | undefined;
description?: string | undefined;
}[] | undefined;
};
security: Record[];
'x-scalar-icon': string;
uid: string & import("zod").$brand<"collection">;
securitySchemes: string[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
servers: (string & import("zod").$brand<"server">)[];
requests: (string & import("zod").$brand<"operation">)[];
tags: (string & import("zod").$brand<"tag">)[];
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
watchMode: boolean;
useCollectionSecurity: boolean;
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
jsonSchemaDialect?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
components?: Record | undefined;
webhooks?: Record | undefined;
'x-scalar-active-environment'?: string | undefined;
'x-scalar-environments'?: Record;
description?: string | undefined;
color?: string | undefined;
}> | undefined;
'x-scalar-secrets'?: Record | undefined;
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
documentUrl?: string | undefined;
integration?: string | null | undefined;
};
delete: (collection: import("@scalar/oas-utils/entities/spec").Collection, workspace: import("@scalar/oas-utils/entities/workspace").Workspace) => void;
addEnvironment: (environmentName: string, environment: import("@scalar/oas-utils/entities/spec").XScalarEnvironment, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void;
removeEnvironment: (environmentName: string, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void;
set: (item: {
type: "collection";
openapi: string;
info: {
title: string;
version: string;
summary?: string | undefined;
description?: string | undefined;
termsOfService?: string | undefined;
contact?: {
name?: string | undefined;
url?: string | undefined;
email?: string | undefined;
} | undefined;
license?: {
name?: string | null | undefined;
identifier?: string | undefined;
url?: string | undefined;
} | undefined;
'x-scalar-sdk-installation'?: {
lang: string;
source?: string | undefined;
description?: string | undefined;
}[] | undefined;
};
security: Record[];
'x-scalar-icon': string;
uid: string & import("zod").$brand<"collection">;
securitySchemes: string[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
servers: (string & import("zod").$brand<"server">)[];
requests: (string & import("zod").$brand<"operation">)[];
tags: (string & import("zod").$brand<"tag">)[];
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
watchMode: boolean;
useCollectionSecurity: boolean;
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
jsonSchemaDialect?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
components?: Record | undefined;
webhooks?: Record | undefined;
'x-scalar-active-environment'?: string | undefined;
'x-scalar-environments'?: Record;
description?: string | undefined;
color?: string | undefined;
}> | undefined;
'x-scalar-secrets'?: Record | undefined;
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
documentUrl?: string | undefined;
integration?: string | null | undefined;
}) => void;
edit: (uid: (string & import("zod").$brand<"collection">) | null | undefined, path: P, value: P extends "servers" | "externalDocs" | "security" | "tags" | "type" | "uid" | "selectedServerUid" | "selectedSecuritySchemeUids" | "securitySchemes" | "openapi" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-icon" | "x-scalar-active-environment" | "x-scalar-environments" | "x-scalar-secrets" | "requests" | "children" | "documentUrl" | "watchMode" | "integration" | "useCollectionSecurity" | "watchModeStatus" ? {
type: "collection";
openapi: string;
info: {
title: string;
version: string;
summary?: string | undefined;
description?: string | undefined;
termsOfService?: string | undefined;
contact?: {
name?: string | undefined;
url?: string | undefined;
email?: string | undefined;
} | undefined;
license?: {
name?: string | null | undefined;
identifier?: string | undefined;
url?: string | undefined;
} | undefined;
'x-scalar-sdk-installation'?: {
lang: string;
source?: string | undefined;
description?: string | undefined;
}[] | undefined;
};
security: Record[];
'x-scalar-icon': string;
uid: string & import("zod").$brand<"collection">;
securitySchemes: string[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
servers: (string & import("zod").$brand<"server">)[];
requests: (string & import("zod").$brand<"operation">)[];
tags: (string & import("zod").$brand<"tag">)[];
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
watchMode: boolean;
useCollectionSecurity: boolean;
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
jsonSchemaDialect?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
components?: Record | undefined;
webhooks?: Record | undefined;
'x-scalar-active-environment'?: string | undefined;
'x-scalar-environments'?: Record;
description?: string | undefined;
color?: string | undefined;
}> | undefined;
'x-scalar-secrets'?: Record | undefined;
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
documentUrl?: string | undefined;
integration?: string | null | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "externalDocs" | "security" | "tags" | "type" | "uid" | "selectedServerUid" | "selectedSecuritySchemeUids" | "securitySchemes" | "openapi" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-icon" | "x-scalar-active-environment" | "x-scalar-environments" | "x-scalar-secrets" | "requests" | "children" | "documentUrl" | "watchMode" | "integration" | "useCollectionSecurity" | "watchModeStatus" ? R extends Path<{
type: "collection";
openapi: string;
info: {
title: string;
version: string;
summary?: string | undefined;
description?: string | undefined;
termsOfService?: string | undefined;
contact?: {
name?: string | undefined;
url?: string | undefined;
email?: string | undefined;
} | undefined;
license?: {
name?: string | null | undefined;
identifier?: string | undefined;
url?: string | undefined;
} | undefined;
'x-scalar-sdk-installation'?: {
lang: string;
source?: string | undefined;
description?: string | undefined;
}[] | undefined;
};
security: Record[];
'x-scalar-icon': string;
uid: string & import("zod").$brand<"collection">;
securitySchemes: string[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
servers: (string & import("zod").$brand<"server">)[];
requests: (string & import("zod").$brand<"operation">)[];
tags: (string & import("zod").$brand<"tag">)[];
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
watchMode: boolean;
useCollectionSecurity: boolean;
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
jsonSchemaDialect?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
components?: Record | undefined;
webhooks?: Record | undefined;
'x-scalar-active-environment'?: string | undefined;
'x-scalar-environments'?: Record;
description?: string | undefined;
color?: string | undefined;
}> | undefined;
'x-scalar-secrets'?: Record | undefined;
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
documentUrl?: string | undefined;
integration?: string | null | undefined;
}[K]> ? PathValue<{
type: "collection";
openapi: string;
info: {
title: string;
version: string;
summary?: string | undefined;
description?: string | undefined;
termsOfService?: string | undefined;
contact?: {
name?: string | undefined;
url?: string | undefined;
email?: string | undefined;
} | undefined;
license?: {
name?: string | null | undefined;
identifier?: string | undefined;
url?: string | undefined;
} | undefined;
'x-scalar-sdk-installation'?: {
lang: string;
source?: string | undefined;
description?: string | undefined;
}[] | undefined;
};
security: Record[];
'x-scalar-icon': string;
uid: string & import("zod").$brand<"collection">;
securitySchemes: string[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
servers: (string & import("zod").$brand<"server">)[];
requests: (string & import("zod").$brand<"operation">)[];
tags: (string & import("zod").$brand<"tag">)[];
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
watchMode: boolean;
useCollectionSecurity: boolean;
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
jsonSchemaDialect?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
components?: Record | undefined;
webhooks?: Record | undefined;
'x-scalar-active-environment'?: string | undefined;
'x-scalar-environments'?: Record;
description?: string | undefined;
color?: string | undefined;
}> | undefined;
'x-scalar-secrets'?: Record | undefined;
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
documentUrl?: string | undefined;
integration?: string | null | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
untrackedEdit: (uid: string & import("zod").$brand<"collection">, path: P, value: P extends "servers" | "externalDocs" | "security" | "tags" | "type" | "uid" | "selectedServerUid" | "selectedSecuritySchemeUids" | "securitySchemes" | "openapi" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-icon" | "x-scalar-active-environment" | "x-scalar-environments" | "x-scalar-secrets" | "requests" | "children" | "documentUrl" | "watchMode" | "integration" | "useCollectionSecurity" | "watchModeStatus" ? {
type: "collection";
openapi: string;
info: {
title: string;
version: string;
summary?: string | undefined;
description?: string | undefined;
termsOfService?: string | undefined;
contact?: {
name?: string | undefined;
url?: string | undefined;
email?: string | undefined;
} | undefined;
license?: {
name?: string | null | undefined;
identifier?: string | undefined;
url?: string | undefined;
} | undefined;
'x-scalar-sdk-installation'?: {
lang: string;
source?: string | undefined;
description?: string | undefined;
}[] | undefined;
};
security: Record[];
'x-scalar-icon': string;
uid: string & import("zod").$brand<"collection">;
securitySchemes: string[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
servers: (string & import("zod").$brand<"server">)[];
requests: (string & import("zod").$brand<"operation">)[];
tags: (string & import("zod").$brand<"tag">)[];
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
watchMode: boolean;
useCollectionSecurity: boolean;
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
jsonSchemaDialect?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
components?: Record | undefined;
webhooks?: Record | undefined;
'x-scalar-active-environment'?: string | undefined;
'x-scalar-environments'?: Record;
description?: string | undefined;
color?: string | undefined;
}> | undefined;
'x-scalar-secrets'?: Record | undefined;
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
documentUrl?: string | undefined;
integration?: string | null | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "externalDocs" | "security" | "tags" | "type" | "uid" | "selectedServerUid" | "selectedSecuritySchemeUids" | "securitySchemes" | "openapi" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-icon" | "x-scalar-active-environment" | "x-scalar-environments" | "x-scalar-secrets" | "requests" | "children" | "documentUrl" | "watchMode" | "integration" | "useCollectionSecurity" | "watchModeStatus" ? R extends Path<{
type: "collection";
openapi: string;
info: {
title: string;
version: string;
summary?: string | undefined;
description?: string | undefined;
termsOfService?: string | undefined;
contact?: {
name?: string | undefined;
url?: string | undefined;
email?: string | undefined;
} | undefined;
license?: {
name?: string | null | undefined;
identifier?: string | undefined;
url?: string | undefined;
} | undefined;
'x-scalar-sdk-installation'?: {
lang: string;
source?: string | undefined;
description?: string | undefined;
}[] | undefined;
};
security: Record[];
'x-scalar-icon': string;
uid: string & import("zod").$brand<"collection">;
securitySchemes: string[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
servers: (string & import("zod").$brand<"server">)[];
requests: (string & import("zod").$brand<"operation">)[];
tags: (string & import("zod").$brand<"tag">)[];
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
watchMode: boolean;
useCollectionSecurity: boolean;
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
jsonSchemaDialect?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
components?: Record | undefined;
webhooks?: Record | undefined;
'x-scalar-active-environment'?: string | undefined;
'x-scalar-environments'?: Record;
description?: string | undefined;
color?: string | undefined;
}> | undefined;
'x-scalar-secrets'?: Record | undefined;
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
documentUrl?: string | undefined;
integration?: string | null | undefined;
}[K]> ? PathValue<{
type: "collection";
openapi: string;
info: {
title: string;
version: string;
summary?: string | undefined;
description?: string | undefined;
termsOfService?: string | undefined;
contact?: {
name?: string | undefined;
url?: string | undefined;
email?: string | undefined;
} | undefined;
license?: {
name?: string | null | undefined;
identifier?: string | undefined;
url?: string | undefined;
} | undefined;
'x-scalar-sdk-installation'?: {
lang: string;
source?: string | undefined;
description?: string | undefined;
}[] | undefined;
};
security: Record[];
'x-scalar-icon': string;
uid: string & import("zod").$brand<"collection">;
securitySchemes: string[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
servers: (string & import("zod").$brand<"server">)[];
requests: (string & import("zod").$brand<"operation">)[];
tags: (string & import("zod").$brand<"tag">)[];
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
watchMode: boolean;
useCollectionSecurity: boolean;
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
jsonSchemaDialect?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
components?: Record | undefined;
webhooks?: Record | undefined;
'x-scalar-active-environment'?: string | undefined;
'x-scalar-environments'?: Record;
description?: string | undefined;
color?: string | undefined;
}> | undefined;
'x-scalar-secrets'?: Record | undefined;
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
documentUrl?: string | undefined;
integration?: string | null | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
undo: (uid: string & import("zod").$brand<"collection">) => void;
redo: (uid: string & import("zod").$brand<"collection">) => void;
reset: () => void;
};
environmentMutators: {
delete: (uid: import("@scalar/oas-utils/entities/environment").Environment["uid"]) => void;
add: (item: {
uid: string & import("zod").$brand<"environment">;
name: string;
color: string;
value: string;
isDefault?: boolean | undefined;
}) => void;
set: (item: {
uid: string & import("zod").$brand<"environment">;
name: string;
color: string;
value: string;
isDefault?: boolean | undefined;
}) => void;
edit: (uid: (string & import("zod").$brand<"environment">) | null | undefined, path: P, value: P extends "value" | "uid" | "name" | "color" | "isDefault" ? {
uid: string & import("zod").$brand<"environment">;
name: string;
color: string;
value: string;
isDefault?: boolean | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "uid" | "name" | "color" | "isDefault" ? R extends Path<{
uid: string & import("zod").$brand<"environment">;
name: string;
color: string;
value: string;
isDefault?: boolean | undefined;
}[K]> ? PathValue<{
uid: string & import("zod").$brand<"environment">;
name: string;
color: string;
value: string;
isDefault?: boolean | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
untrackedEdit:
(uid: string & import("zod").$brand<"environment">, path: P, value: P extends "value" | "uid" | "name" | "color" | "isDefault" ? {
uid: string & import("zod").$brand<"environment">;
name: string;
color: string;
value: string;
isDefault?: boolean | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "uid" | "name" | "color" | "isDefault" ? R extends Path<{
uid: string & import("zod").$brand<"environment">;
name: string;
color: string;
value: string;
isDefault?: boolean | undefined;
}[K]> ? PathValue<{
uid: string & import("zod").$brand<"environment">;
name: string;
color: string;
value: string;
isDefault?: boolean | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
undo: (uid: string & import("zod").$brand<"environment">) => void;
redo: (uid: string & import("zod").$brand<"environment">) => void;
reset: () => void;
};
requestMutators: {
rawAdd: (item: {
type: "request";
uid: string & import("zod").$brand<"operation">;
path: string;
method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
servers: (string & import("zod").$brand<"server">)[];
selectedServerUid: (string & import("zod").$brand<"server">) | null;
examples: (string & import("zod").$brand<"example">)[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
description?: string | undefined;
summary?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
'x-internal'?: boolean | undefined;
'x-scalar-ignore'?: boolean | undefined;
security?: Record[] | undefined;
tags?: string[] | undefined;
deprecated?: boolean | undefined;
operationId?: string | undefined;
requestBody?: any;
parameters?: {
in: "path" | "cookie" | "query" | "header";
name: string;
required: boolean;
deprecated: boolean;
description?: string | undefined;
schema?: unknown;
content?: unknown;
style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
explode?: boolean | undefined;
example?: unknown;
examples?: Record | unknown[] | undefined;
}[] | undefined;
responses?: Record | undefined;
callbacks?: Record>> | undefined;
'x-codeSamples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-code-samples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-custom-examples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-scalar-stability'?: import("@scalar/types/legacy").XScalarStability | undefined;
'x-post-response'?: string | undefined;
}) => void;
add: (payload: import("@scalar/oas-utils/entities/spec").RequestPayload, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void | {
type: "request";
uid: string & import("zod").$brand<"operation">;
path: string;
method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
servers: (string & import("zod").$brand<"server">)[];
selectedServerUid: (string & import("zod").$brand<"server">) | null;
examples: (string & import("zod").$brand<"example">)[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
description?: string | undefined;
summary?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
'x-internal'?: boolean | undefined;
'x-scalar-ignore'?: boolean | undefined;
security?: Record[] | undefined;
tags?: string[] | undefined;
deprecated?: boolean | undefined;
operationId?: string | undefined;
requestBody?: any;
parameters?: {
in: "path" | "cookie" | "query" | "header";
name: string;
required: boolean;
deprecated: boolean;
description?: string | undefined;
schema?: unknown;
content?: unknown;
style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
explode?: boolean | undefined;
example?: unknown;
examples?: Record | unknown[] | undefined;
}[] | undefined;
responses?: Record | undefined;
callbacks?: Record>> | undefined;
'x-codeSamples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-code-samples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-custom-examples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-scalar-stability'?: import("@scalar/types/legacy").XScalarStability | undefined;
'x-post-response'?: string | undefined;
};
delete: (request: import("@scalar/oas-utils/entities/spec").Request, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void;
set: (item: {
type: "request";
uid: string & import("zod").$brand<"operation">;
path: string;
method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
servers: (string & import("zod").$brand<"server">)[];
selectedServerUid: (string & import("zod").$brand<"server">) | null;
examples: (string & import("zod").$brand<"example">)[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
description?: string | undefined;
summary?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
'x-internal'?: boolean | undefined;
'x-scalar-ignore'?: boolean | undefined;
security?: Record[] | undefined;
tags?: string[] | undefined;
deprecated?: boolean | undefined;
operationId?: string | undefined;
requestBody?: any;
parameters?: {
in: "path" | "cookie" | "query" | "header";
name: string;
required: boolean;
deprecated: boolean;
description?: string | undefined;
schema?: unknown;
content?: unknown;
style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
explode?: boolean | undefined;
example?: unknown;
examples?: Record | unknown[] | undefined;
}[] | undefined;
responses?: Record | undefined;
callbacks?: Record>> | undefined;
'x-codeSamples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-code-samples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-custom-examples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-scalar-stability'?: import("@scalar/types/legacy").XScalarStability | undefined;
'x-post-response'?: string | undefined;
}) => void;
edit: (uid: (string & import("zod").$brand<"operation">) | null | undefined, path: P, value: P extends "servers" | "summary" | "path" | "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "security" | "tags" | "deprecated" | "operationId" | "requestBody" | "parameters" | "responses" | "callbacks" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? {
type: "request";
uid: string & import("zod").$brand<"operation">;
path: string;
method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
servers: (string & import("zod").$brand<"server">)[];
selectedServerUid: (string & import("zod").$brand<"server">) | null;
examples: (string & import("zod").$brand<"example">)[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
description?: string | undefined;
summary?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
'x-internal'?: boolean | undefined;
'x-scalar-ignore'?: boolean | undefined;
security?: Record[] | undefined;
tags?: string[] | undefined;
deprecated?: boolean | undefined;
operationId?: string | undefined;
requestBody?: any;
parameters?: {
in: "path" | "cookie" | "query" | "header";
name: string;
required: boolean;
deprecated: boolean;
description?: string | undefined;
schema?: unknown;
content?: unknown;
style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
explode?: boolean | undefined;
example?: unknown;
examples?: Record | unknown[] | undefined;
}[] | undefined;
responses?: Record | undefined;
callbacks?: Record>> | undefined;
'x-codeSamples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-code-samples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-custom-examples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-scalar-stability'?: import("@scalar/types/legacy").XScalarStability | undefined;
'x-post-response'?: string | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "summary" | "path" | "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "security" | "tags" | "deprecated" | "operationId" | "requestBody" | "parameters" | "responses" | "callbacks" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? R extends Path<{
type: "request";
uid: string & import("zod").$brand<"operation">;
path: string;
method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
servers: (string & import("zod").$brand<"server">)[];
selectedServerUid: (string & import("zod").$brand<"server">) | null;
examples: (string & import("zod").$brand<"example">)[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
description?: string | undefined;
summary?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
'x-internal'?: boolean | undefined;
'x-scalar-ignore'?: boolean | undefined;
security?: Record[] | undefined;
tags?: string[] | undefined;
deprecated?: boolean | undefined;
operationId?: string | undefined;
requestBody?: any;
parameters?: {
in: "path" | "cookie" | "query" | "header";
name: string;
required: boolean;
deprecated: boolean;
description?: string | undefined;
schema?: unknown;
content?: unknown;
style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
explode?: boolean | undefined;
example?: unknown;
examples?: Record | unknown[] | undefined;
}[] | undefined;
responses?: Record | undefined;
callbacks?: Record>> | undefined;
'x-codeSamples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-code-samples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-custom-examples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-scalar-stability'?: import("@scalar/types/legacy").XScalarStability | undefined;
'x-post-response'?: string | undefined;
}[K]> ? PathValue<{
type: "request";
uid: string & import("zod").$brand<"operation">;
path: string;
method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
servers: (string & import("zod").$brand<"server">)[];
selectedServerUid: (string & import("zod").$brand<"server">) | null;
examples: (string & import("zod").$brand<"example">)[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
description?: string | undefined;
summary?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
'x-internal'?: boolean | undefined;
'x-scalar-ignore'?: boolean | undefined;
security?: Record[] | undefined;
tags?: string[] | undefined;
deprecated?: boolean | undefined;
operationId?: string | undefined;
requestBody?: any;
parameters?: {
in: "path" | "cookie" | "query" | "header";
name: string;
required: boolean;
deprecated: boolean;
description?: string | undefined;
schema?: unknown;
content?: unknown;
style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
explode?: boolean | undefined;
example?: unknown;
examples?: Record | unknown[] | undefined;
}[] | undefined;
responses?: Record | undefined;
callbacks?: Record>> | undefined;
'x-codeSamples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-code-samples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-custom-examples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-scalar-stability'?: import("@scalar/types/legacy").XScalarStability | undefined;
'x-post-response'?: string | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
untrackedEdit: (uid: string & import("zod").$brand<"operation">, path: P, value: P extends "servers" | "summary" | "path" | "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "security" | "tags" | "deprecated" | "operationId" | "requestBody" | "parameters" | "responses" | "callbacks" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? {
type: "request";
uid: string & import("zod").$brand<"operation">;
path: string;
method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
servers: (string & import("zod").$brand<"server">)[];
selectedServerUid: (string & import("zod").$brand<"server">) | null;
examples: (string & import("zod").$brand<"example">)[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
description?: string | undefined;
summary?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
'x-internal'?: boolean | undefined;
'x-scalar-ignore'?: boolean | undefined;
security?: Record[] | undefined;
tags?: string[] | undefined;
deprecated?: boolean | undefined;
operationId?: string | undefined;
requestBody?: any;
parameters?: {
in: "path" | "cookie" | "query" | "header";
name: string;
required: boolean;
deprecated: boolean;
description?: string | undefined;
schema?: unknown;
content?: unknown;
style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
explode?: boolean | undefined;
example?: unknown;
examples?: Record | unknown[] | undefined;
}[] | undefined;
responses?: Record | undefined;
callbacks?: Record>> | undefined;
'x-codeSamples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-code-samples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-custom-examples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-scalar-stability'?: import("@scalar/types/legacy").XScalarStability | undefined;
'x-post-response'?: string | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "summary" | "path" | "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "security" | "tags" | "deprecated" | "operationId" | "requestBody" | "parameters" | "responses" | "callbacks" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? R extends Path<{
type: "request";
uid: string & import("zod").$brand<"operation">;
path: string;
method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
servers: (string & import("zod").$brand<"server">)[];
selectedServerUid: (string & import("zod").$brand<"server">) | null;
examples: (string & import("zod").$brand<"example">)[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
description?: string | undefined;
summary?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
'x-internal'?: boolean | undefined;
'x-scalar-ignore'?: boolean | undefined;
security?: Record[] | undefined;
tags?: string[] | undefined;
deprecated?: boolean | undefined;
operationId?: string | undefined;
requestBody?: any;
parameters?: {
in: "path" | "cookie" | "query" | "header";
name: string;
required: boolean;
deprecated: boolean;
description?: string | undefined;
schema?: unknown;
content?: unknown;
style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
explode?: boolean | undefined;
example?: unknown;
examples?: Record | unknown[] | undefined;
}[] | undefined;
responses?: Record | undefined;
callbacks?: Record>> | undefined;
'x-codeSamples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-code-samples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-custom-examples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-scalar-stability'?: import("@scalar/types/legacy").XScalarStability | undefined;
'x-post-response'?: string | undefined;
}[K]> ? PathValue<{
type: "request";
uid: string & import("zod").$brand<"operation">;
path: string;
method: "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
servers: (string & import("zod").$brand<"server">)[];
selectedServerUid: (string & import("zod").$brand<"server">) | null;
examples: (string & import("zod").$brand<"example">)[];
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
description?: string | undefined;
summary?: string | undefined;
externalDocs?: {
url: string;
description?: string | undefined;
} | undefined;
'x-internal'?: boolean | undefined;
'x-scalar-ignore'?: boolean | undefined;
security?: Record[] | undefined;
tags?: string[] | undefined;
deprecated?: boolean | undefined;
operationId?: string | undefined;
requestBody?: any;
parameters?: {
in: "path" | "cookie" | "query" | "header";
name: string;
required: boolean;
deprecated: boolean;
description?: string | undefined;
schema?: unknown;
content?: unknown;
style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
explode?: boolean | undefined;
example?: unknown;
examples?: Record | unknown[] | undefined;
}[] | undefined;
responses?: Record | undefined;
callbacks?: Record>> | undefined;
'x-codeSamples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-code-samples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-custom-examples'?: {
source: string;
lang?: string | undefined;
label?: string | undefined;
}[] | undefined;
'x-scalar-stability'?: import("@scalar/types/legacy").XScalarStability | undefined;
'x-post-response'?: string | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
undo: (uid: string & import("zod").$brand<"operation">) => void;
redo: (uid: string & import("zod").$brand<"operation">) => void;
reset: () => void;
};
findRequestParents: (r: import("@scalar/oas-utils/entities/spec").Request) => string[];
requestExampleMutators: {
rawAdd: (item: {
uid: string & import("zod").$brand<"example">;
type: "requestExample";
name: string;
body: {
activeBody: "raw" | "formData" | "binary";
raw?: {
encoding: "html" | "text" | "xml" | "json" | "javascript" | "yaml" | "edn";
value: string;
mimeType?: string | undefined;
} | undefined;
formData?: {
encoding: "form-data" | "urlencoded";
value: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
} | undefined;
binary?: Blob | undefined;
};
parameters: {
path: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
query: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
headers: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
cookies: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
};
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
serverVariables?: Record | undefined;
}) => void;
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
uid: string & import("zod").$brand<"example">;
type: "requestExample";
name: string;
body: {
activeBody: "raw" | "formData" | "binary";
raw?: {
encoding: "html" | "text" | "xml" | "json" | "javascript" | "yaml" | "edn";
value: string;
mimeType?: string | undefined;
} | undefined;
formData?: {
encoding: "form-data" | "urlencoded";
value: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
} | undefined;
binary?: Blob | undefined;
};
parameters: {
path: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
query: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
headers: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
cookies: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
};
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
serverVariables?: Record | undefined;
};
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
set: (item: {
uid: string & import("zod").$brand<"example">;
type: "requestExample";
name: string;
body: {
activeBody: "raw" | "formData" | "binary";
raw?: {
encoding: "html" | "text" | "xml" | "json" | "javascript" | "yaml" | "edn";
value: string;
mimeType?: string | undefined;
} | undefined;
formData?: {
encoding: "form-data" | "urlencoded";
value: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
} | undefined;
binary?: Blob | undefined;
};
parameters: {
path: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
query: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
headers: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
cookies: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
};
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
serverVariables?: Record | undefined;
}) => void;
edit: (uid: (string & import("zod").$brand<"example">) | null | undefined, path: P, value: P extends "parameters" | "type" | "uid" | "name" | "requestUid" | "body" | "serverVariables" ? {
uid: string & import("zod").$brand<"example">;
type: "requestExample";
name: string;
body: {
activeBody: "raw" | "formData" | "binary";
raw?: {
encoding: "html" | "text" | "xml" | "json" | "javascript" | "yaml" | "edn";
value: string;
mimeType?: string | undefined;
} | undefined;
formData?: {
encoding: "form-data" | "urlencoded";
value: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
} | undefined;
binary?: Blob | undefined;
};
parameters: {
path: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
query: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
headers: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
cookies: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
};
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
serverVariables?: Record | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "name" | "requestUid" | "body" | "serverVariables" ? R extends Path<{
uid: string & import("zod").$brand<"example">;
type: "requestExample";
name: string;
body: {
activeBody: "raw" | "formData" | "binary";
raw?: {
encoding: "html" | "text" | "xml" | "json" | "javascript" | "yaml" | "edn";
value: string;
mimeType?: string | undefined;
} | undefined;
formData?: {
encoding: "form-data" | "urlencoded";
value: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
} | undefined;
binary?: Blob | undefined;
};
parameters: {
path: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
query: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
headers: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
cookies: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
};
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
serverVariables?: Record | undefined;
}[K]> ? PathValue<{
uid: string & import("zod").$brand<"example">;
type: "requestExample";
name: string;
body: {
activeBody: "raw" | "formData" | "binary";
raw?: {
encoding: "html" | "text" | "xml" | "json" | "javascript" | "yaml" | "edn";
value: string;
mimeType?: string | undefined;
} | undefined;
formData?: {
encoding: "form-data" | "urlencoded";
value: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
} | undefined;
binary?: Blob | undefined;
};
parameters: {
path: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
query: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
headers: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
cookies: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
};
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
serverVariables?: Record | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
untrackedEdit: (uid: string & import("zod").$brand<"example">, path: P, value: P extends "parameters" | "type" | "uid" | "name" | "requestUid" | "body" | "serverVariables" ? {
uid: string & import("zod").$brand<"example">;
type: "requestExample";
name: string;
body: {
activeBody: "raw" | "formData" | "binary";
raw?: {
encoding: "html" | "text" | "xml" | "json" | "javascript" | "yaml" | "edn";
value: string;
mimeType?: string | undefined;
} | undefined;
formData?: {
encoding: "form-data" | "urlencoded";
value: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
} | undefined;
binary?: Blob | undefined;
};
parameters: {
path: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
query: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
headers: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
cookies: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
};
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
serverVariables?: Record | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "name" | "requestUid" | "body" | "serverVariables" ? R extends Path<{
uid: string & import("zod").$brand<"example">;
type: "requestExample";
name: string;
body: {
activeBody: "raw" | "formData" | "binary";
raw?: {
encoding: "html" | "text" | "xml" | "json" | "javascript" | "yaml" | "edn";
value: string;
mimeType?: string | undefined;
} | undefined;
formData?: {
encoding: "form-data" | "urlencoded";
value: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
} | undefined;
binary?: Blob | undefined;
};
parameters: {
path: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
query: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
headers: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
cookies: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
};
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
serverVariables?: Record | undefined;
}[K]> ? PathValue<{
uid: string & import("zod").$brand<"example">;
type: "requestExample";
name: string;
body: {
activeBody: "raw" | "formData" | "binary";
raw?: {
encoding: "html" | "text" | "xml" | "json" | "javascript" | "yaml" | "edn";
value: string;
mimeType?: string | undefined;
} | undefined;
formData?: {
encoding: "form-data" | "urlencoded";
value: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
} | undefined;
binary?: Blob | undefined;
};
parameters: {
path: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
query: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
headers: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
cookies: {
key: string;
value: string;
enabled: boolean;
file?: any;
description?: string | undefined;
required?: boolean | undefined;
enum?: string[] | undefined;
examples?: any[] | undefined;
type?: string | string[] | undefined;
format?: string | undefined;
minimum?: number | undefined;
maximum?: number | undefined;
default?: any;
nullable?: boolean | undefined;
}[];
};
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
serverVariables?: Record | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
undo: (uid: string & import("zod").$brand<"example">) => void;
redo: (uid: string & import("zod").$brand<"example">) => void;
reset: () => void;
};
requestHistory: import("vue").Reactive;
securitySchemeMutators: {
rawAdd: (item: {
type: "apiKey";
name: string;
in: "cookie" | "query" | "header";
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
value: string;
description?: string | undefined;
} | {
type: "http";
scheme: "basic" | "bearer";
bearerFormat: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
username: string;
password: string;
token: string;
description?: string | undefined;
} | {
type: "openIdConnect";
openIdConnectUrl: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
} | {
type: "oauth2";
flows: {
implicit?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "implicit";
authorizationUrl: string;
"x-scalar-redirect-uri": string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
} | undefined;
password?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "password";
tokenUrl: string;
clientSecret: string;
username: string;
password: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
clientCredentials?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "clientCredentials";
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
authorizationCode?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "authorizationCode";
authorizationUrl: string;
"x-usePkce": "SHA-256" | "plain" | "no";
"x-scalar-redirect-uri": string;
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
};
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
'x-default-scopes'?: string[] | undefined;
}) => void;
add: (payload: import("@scalar/types/entities").SecuritySchemePayload, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => {
type: "apiKey";
name: string;
in: "cookie" | "query" | "header";
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
value: string;
description?: string | undefined;
} | {
type: "http";
scheme: "basic" | "bearer";
bearerFormat: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
username: string;
password: string;
token: string;
description?: string | undefined;
} | {
type: "openIdConnect";
openIdConnectUrl: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
} | {
type: "oauth2";
flows: {
implicit?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "implicit";
authorizationUrl: string;
"x-scalar-redirect-uri": string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
} | undefined;
password?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "password";
tokenUrl: string;
clientSecret: string;
username: string;
password: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
clientCredentials?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "clientCredentials";
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
authorizationCode?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "authorizationCode";
authorizationUrl: string;
"x-usePkce": "SHA-256" | "plain" | "no";
"x-scalar-redirect-uri": string;
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
};
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
'x-default-scopes'?: string[] | undefined;
};
delete: (schemeUid: SecurityScheme["uid"]) => void;
set: (item: {
type: "apiKey";
name: string;
in: "cookie" | "query" | "header";
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
value: string;
description?: string | undefined;
} | {
type: "http";
scheme: "basic" | "bearer";
bearerFormat: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
username: string;
password: string;
token: string;
description?: string | undefined;
} | {
type: "openIdConnect";
openIdConnectUrl: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
} | {
type: "oauth2";
flows: {
implicit?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "implicit";
authorizationUrl: string;
"x-scalar-redirect-uri": string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
} | undefined;
password?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "password";
tokenUrl: string;
clientSecret: string;
username: string;
password: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
clientCredentials?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "clientCredentials";
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
authorizationCode?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "authorizationCode";
authorizationUrl: string;
"x-usePkce": "SHA-256" | "plain" | "no";
"x-scalar-redirect-uri": string;
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
};
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
'x-default-scopes'?: string[] | undefined;
}) => void;
edit: (uid: (string & import("zod").$brand<"securityScheme">) | null | undefined, path: P, value: (P extends "in" | "value" | "description" | "type" | "uid" | "name" | "nameKey" ? {
type: "apiKey";
name: string;
in: "cookie" | "query" | "header";
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
value: string;
description?: string | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "in" | "value" | "description" | "type" | "uid" | "name" | "nameKey" ? R extends Path<{
type: "apiKey";
name: string;
in: "cookie" | "query" | "header";
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
value: string;
description?: string | undefined;
}[K]> ? PathValue<{
type: "apiKey";
name: string;
in: "cookie" | "query" | "header";
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
value: string;
description?: string | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "username" | "password" | "token" ? {
type: "http";
scheme: "basic" | "bearer";
bearerFormat: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
username: string;
password: string;
token: string;
description?: string | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "type" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "username" | "password" | "token" ? R extends Path<{
type: "http";
scheme: "basic" | "bearer";
bearerFormat: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
username: string;
password: string;
token: string;
description?: string | undefined;
}[K]> ? PathValue<{
type: "http";
scheme: "basic" | "bearer";
bearerFormat: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
username: string;
password: string;
token: string;
description?: string | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "openIdConnectUrl" ? {
type: "openIdConnect";
openIdConnectUrl: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "type" | "uid" | "nameKey" | "openIdConnectUrl" ? R extends Path<{
type: "openIdConnect";
openIdConnectUrl: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
}[K]> ? PathValue<{
type: "openIdConnect";
openIdConnectUrl: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "x-default-scopes" | "flows" ? {
type: "oauth2";
flows: {
implicit?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "implicit";
authorizationUrl: string;
"x-scalar-redirect-uri": string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
} | undefined;
password?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "password";
tokenUrl: string;
clientSecret: string;
username: string;
password: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
clientCredentials?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "clientCredentials";
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
authorizationCode?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "authorizationCode";
authorizationUrl: string;
"x-usePkce": "SHA-256" | "plain" | "no";
"x-scalar-redirect-uri": string;
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
};
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
'x-default-scopes'?: string[] | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "type" | "uid" | "nameKey" | "x-default-scopes" | "flows" ? R extends Path<{
type: "oauth2";
flows: {
implicit?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "implicit";
authorizationUrl: string;
"x-scalar-redirect-uri": string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
} | undefined;
password?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "password";
tokenUrl: string;
clientSecret: string;
username: string;
password: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
clientCredentials?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "clientCredentials";
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
authorizationCode?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "authorizationCode";
authorizationUrl: string;
"x-usePkce": "SHA-256" | "plain" | "no";
"x-scalar-redirect-uri": string;
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
};
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
'x-default-scopes'?: string[] | undefined;
}[K]> ? PathValue<{
type: "oauth2";
flows: {
implicit?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "implicit";
authorizationUrl: string;
"x-scalar-redirect-uri": string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
} | undefined;
password?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "password";
tokenUrl: string;
clientSecret: string;
username: string;
password: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
clientCredentials?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "clientCredentials";
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
authorizationCode?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "authorizationCode";
authorizationUrl: string;
"x-usePkce": "SHA-256" | "plain" | "no";
"x-scalar-redirect-uri": string;
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
};
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
'x-default-scopes'?: string[] | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never)) => void;
untrackedEdit: (uid: string & import("zod").$brand<"securityScheme">, path: P, value: (P extends "in" | "value" | "description" | "type" | "uid" | "name" | "nameKey" ? {
type: "apiKey";
name: string;
in: "cookie" | "query" | "header";
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
value: string;
description?: string | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "in" | "value" | "description" | "type" | "uid" | "name" | "nameKey" ? R extends Path<{
type: "apiKey";
name: string;
in: "cookie" | "query" | "header";
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
value: string;
description?: string | undefined;
}[K]> ? PathValue<{
type: "apiKey";
name: string;
in: "cookie" | "query" | "header";
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
value: string;
description?: string | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "username" | "password" | "token" ? {
type: "http";
scheme: "basic" | "bearer";
bearerFormat: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
username: string;
password: string;
token: string;
description?: string | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "type" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "username" | "password" | "token" ? R extends Path<{
type: "http";
scheme: "basic" | "bearer";
bearerFormat: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
username: string;
password: string;
token: string;
description?: string | undefined;
}[K]> ? PathValue<{
type: "http";
scheme: "basic" | "bearer";
bearerFormat: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
username: string;
password: string;
token: string;
description?: string | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "openIdConnectUrl" ? {
type: "openIdConnect";
openIdConnectUrl: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "type" | "uid" | "nameKey" | "openIdConnectUrl" ? R extends Path<{
type: "openIdConnect";
openIdConnectUrl: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
}[K]> ? PathValue<{
type: "openIdConnect";
openIdConnectUrl: string;
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "x-default-scopes" | "flows" ? {
type: "oauth2";
flows: {
implicit?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "implicit";
authorizationUrl: string;
"x-scalar-redirect-uri": string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
} | undefined;
password?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "password";
tokenUrl: string;
clientSecret: string;
username: string;
password: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
clientCredentials?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "clientCredentials";
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
authorizationCode?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "authorizationCode";
authorizationUrl: string;
"x-usePkce": "SHA-256" | "plain" | "no";
"x-scalar-redirect-uri": string;
tokenUrl: string;
clientSecret: string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record | undefined;
"x-tokenName"?: string | undefined;
"x-scalar-credentials-location"?: "header" | "body" | undefined;
} | undefined;
};
uid: string & import("zod").$brand<"securityScheme">;
nameKey: string;
description?: string | undefined;
'x-default-scopes'?: string[] | undefined;
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "type" | "uid" | "nameKey" | "x-default-scopes" | "flows" ? R extends Path<{
type: "oauth2";
flows: {
implicit?: {
refreshUrl: string;
scopes: Record;
selectedScopes: string[];
"x-scalar-client-id": string;
token: string;
type: "implicit";
authorizationUrl: string;
"x-scalar-redirect-uri": string;
"x-scalar-security-query"?: Record | undefined;
"x-scalar-security-body"?: Record