@scalar/api-client 2.2.37 → 2.2.38

package/dist/libs/create-client.d.ts

@@ -1,9 +1,8 @@
 import { type ClientLayout } from '../hooks/useLayout.js';
 import { type WorkspaceStore } from '../store/store.js';
-import type { RequestMethod, SecurityScheme } from '@scalar/oas-utils/entities/spec';
+import type { SecurityScheme } from '@scalar/oas-utils/entities/spec';
 import type { Path, PathValue } from '@scalar/object-utils/nested';
-import type { ReferenceConfiguration, SpecConfiguration } from '@scalar/types/legacy';
-import type { LiteralUnion } from 'type-fest';
+import type { OpenAPI, ReferenceConfiguration, SpecConfiguration } from '@scalar/types/legacy';
 import { type Component } from 'vue';
 import type { Router } from 'vue-router';
 /** Configuration options for the Scalar API client */
@@ -11,9 +10,15 @@ export type ClientConfiguration = {
     proxyUrl?: ReferenceConfiguration['proxyUrl'];
     themeId?: ReferenceConfiguration['theme'];
 } & Pick<ReferenceConfiguration, 'spec' | 'showSidebar' | 'servers' | 'searchHotKey' | 'authentication' | 'baseServerURL' | 'hideClientButton' | '_integration'>;
-export type OpenClientPayload = {
+export type OpenClientPayload = ({
     path: string;
-    method: LiteralUnion<RequestMethod | Lowercase<RequestMethod>, string>;
+    method: OpenAPI.HttpMethod | Lowercase<OpenAPI.HttpMethod>;
+    requestUid?: never;
+} | {
+    path?: never;
+    method?: never;
+    requestUid: string;
+}) & {
     _source?: 'api-reference' | 'gitbook';
 };
 export type CreateApiClientParams = {
@@ -57,7 +62,7 @@ export type ApiClient = Omit<Awaited<ReturnType<typeof createApiClient>>, 'app'
      * The main workspace store from the client
      * These refs don't wanna play nice with typescript, if we need them we can de-reference them
      */
-    store: Omit<WorkspaceStore, 'isReadOnly' | 'router' | 'events' | 'sidebarWidth' | 'proxyUrl' | 'requestHistory'>;
+    store: Omit<WorkspaceStore, 'router' | 'events' | 'sidebarWidth' | 'proxyUrl' | 'requestHistory'>;
 };
 /**
  * Sync method to create the api client vue app and store
@@ -87,7 +92,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
         value: NonNullable<PathValue<SecurityScheme, P>>;
     }) => void;
     /** Route to a method + path */
-    route: (params: OpenClientPayload) => void;
+    route: (payload?: OpenClientPayload) => void;
     /** Open the API client modal and optionally route to a request */
     open: (payload?: OpenClientPayload) => void;
     /** Mount the references to a given element */
@@ -218,6 +223,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                     required?: boolean | undefined;
                     description?: string | undefined;
                     enum?: string[] | undefined;
+                    examples?: string[] | undefined;
                     format?: string | undefined;
                     file?: any;
                     nullable?: boolean | undefined;
@@ -233,6 +239,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                     required?: boolean | undefined;
                     description?: string | undefined;
                     enum?: string[] | undefined;
+                    examples?: string[] | undefined;
                     format?: string | undefined;
                     file?: any;
                     nullable?: boolean | undefined;
@@ -248,6 +255,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                     required?: boolean | undefined;
                     description?: string | undefined;
                     enum?: string[] | undefined;
+                    examples?: string[] | undefined;
                     format?: string | undefined;
                     file?: any;
                     nullable?: boolean | undefined;
@@ -263,6 +271,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                     required?: boolean | undefined;
                     description?: string | undefined;
                     enum?: string[] | undefined;
+                    examples?: string[] | undefined;
                     format?: string | undefined;
                     file?: any;
                     nullable?: boolean | undefined;
@@ -283,6 +292,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -340,8 +350,10 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
             uid: string;
             url: string;
             description?: string | undefined;
-            variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
-                enum?: [string, ...string[]];
+            variables?: Record<string, {
+                default?: string | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
             }> | undefined;
         }>;
         securitySchemes: Record<string, {
@@ -438,7 +450,6 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
         sidebarWidth: import("vue").Ref<string, string>;
         setSidebarWidth: (width: string) => void;
         proxyUrl: string | undefined;
-        isReadOnly: boolean;
         hideClientButton: boolean | undefined;
         showSidebar: boolean;
         integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
@@ -1457,7 +1468,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
             }) => void;
-            edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | "method" | "path" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? {
+            edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | "method" | "path" | "examples" | `examples.${number}` | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.examples` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? {
                 path: string;
                 type: "request";
                 uid: string;
@@ -1572,7 +1583,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
-            untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | "method" | "path" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? {
+            untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | "method" | "path" | "examples" | `examples.${number}` | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.examples` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? {
                 path: string;
                 type: "request";
                 uid: string;
@@ -1709,6 +1720,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1724,6 +1736,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1739,6 +1752,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1754,6 +1768,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1774,6 +1789,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -1804,6 +1820,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1819,6 +1836,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1834,6 +1852,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1849,6 +1868,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1869,6 +1889,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -1900,6 +1921,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1915,6 +1937,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1930,6 +1953,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1945,6 +1969,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1965,6 +1990,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -1979,7 +2005,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                 requestUid: string;
                 serverVariables?: Record<string, string[]> | undefined;
             }) => void;
-            edit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
+            edit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.examples` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.examples` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
                 type: "requestExample";
                 uid: string;
                 name: string;
@@ -1995,6 +2021,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2010,6 +2037,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2025,6 +2053,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2040,6 +2069,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2060,6 +2090,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -2089,6 +2120,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2104,6 +2136,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2119,6 +2152,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2134,6 +2168,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2154,6 +2189,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -2183,6 +2219,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2198,6 +2235,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2213,6 +2251,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2228,6 +2267,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2248,6 +2288,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -2262,7 +2303,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                 requestUid: string;
                 serverVariables?: Record<string, string[]> | undefined;
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
-            untrackedEdit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
+            untrackedEdit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.examples` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.examples` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
                 type: "requestExample";
                 uid: string;
                 name: string;
@@ -2278,6 +2319,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2293,6 +2335,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2308,6 +2351,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2323,6 +2367,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2343,6 +2388,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -2372,6 +2418,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2387,6 +2434,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2402,6 +2450,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2417,6 +2466,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2437,6 +2487,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -2466,6 +2517,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2481,6 +2533,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2496,6 +2549,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2511,6 +2565,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2531,6 +2586,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -3250,16 +3306,20 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                 uid: string;
                 url: string;
                 description?: string | undefined;
-                variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
-                    enum?: [string, ...string[]];
+                variables?: Record<string, {
+                    default?: string | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
                 }> | undefined;
             }) => void;
             add: (payload: import("@scalar/oas-utils/entities/spec").ServerPayload, parentUid: string) => {
                 uid: string;
                 url: string;
                 description?: string | undefined;
-                variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
-                    enum?: [string, ...string[]];
+                variables?: Record<string, {
+                    default?: string | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
                 }> | undefined;
             };
             delete: (serverUid: string, collectionUid: string) => void;
@@ -3267,52 +3327,66 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
                 uid: string;
                 url: string;
                 description?: string | undefined;
-                variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
-                    enum?: [string, ...string[]];
+                variables?: Record<string, {
+                    default?: string | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
                 }> | undefined;
             }) => void;
             edit: <P extends "description" | "uid" | "url" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "description" | "uid" | "url" | "variables" ? {
                 uid: string;
                 url: string;
                 description?: string | undefined;
-                variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
-                    enum?: [string, ...string[]];
+                variables?: Record<string, {
+                    default?: string | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
                 }> | undefined;
             }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "uid" | "url" | "variables" ? R extends Path<{
                 uid: string;
                 url: string;
                 description?: string | undefined;
-                variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
-                    enum?: [string, ...string[]];
+                variables?: Record<string, {
+                    default?: string | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
                 }> | undefined;
             }[K]> ? PathValue<{
                 uid: string;
                 url: string;
                 description?: string | undefined;
-                variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
-                    enum?: [string, ...string[]];
+                variables?: Record<string, {
+                    default?: string | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
                 }> | undefined;
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             untrackedEdit: <P extends "description" | "uid" | "url" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "description" | "uid" | "url" | "variables" ? {
                 uid: string;
                 url: string;
                 description?: string | undefined;
-                variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
-                    enum?: [string, ...string[]];
+                variables?: Record<string, {
+                    default?: string | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
                 }> | undefined;
             }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "uid" | "url" | "variables" ? R extends Path<{
                 uid: string;
                 url: string;
                 description?: string | undefined;
-                variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
-                    enum?: [string, ...string[]];
+                variables?: Record<string, {
+                    default?: string | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
                 }> | undefined;
             }[K]> ? PathValue<{
                 uid: string;
                 url: string;
                 description?: string | undefined;
-                variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
-                    enum?: [string, ...string[]];
+                variables?: Record<string, {
+                    default?: string | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
                 }> | undefined;
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;