@scalar/api-client 2.2.37 → 2.2.38

package/dist/layouts/Web/create-api-client-web.d.ts

@@ -13,7 +13,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
         propertyKey: P;
         value: NonNullable<import("@scalar/object-utils/nested").PathValue<import("@scalar/oas-utils/entities/spec").SecurityScheme, P>>;
     }) => void;
-    route: (params: import("../../libs/index.js").OpenClientPayload) => void;
+    route: (payload?: import("../../libs/index.js").OpenClientPayload) => void;
     open: (payload?: import("../../libs/index.js").OpenClientPayload) => void;
     mount: (mountingEl?: HTMLElement | null) => void;
     modalState: {
@@ -141,6 +141,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                     required?: boolean | undefined;
                     description?: string | undefined;
                     enum?: string[] | undefined;
+                    examples?: string[] | undefined;
                     format?: string | undefined;
                     file?: any;
                     nullable?: boolean | undefined;
@@ -156,6 +157,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                     required?: boolean | undefined;
                     description?: string | undefined;
                     enum?: string[] | undefined;
+                    examples?: string[] | undefined;
                     format?: string | undefined;
                     file?: any;
                     nullable?: boolean | undefined;
@@ -171,6 +173,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                     required?: boolean | undefined;
                     description?: string | undefined;
                     enum?: string[] | undefined;
+                    examples?: string[] | undefined;
                     format?: string | undefined;
                     file?: any;
                     nullable?: boolean | undefined;
@@ -186,6 +189,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                     required?: boolean | undefined;
                     description?: string | undefined;
                     enum?: string[] | undefined;
+                    examples?: string[] | undefined;
                     format?: string | undefined;
                     file?: any;
                     nullable?: boolean | undefined;
@@ -206,6 +210,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -263,8 +268,10 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
             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, {
@@ -361,7 +368,6 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
         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;
@@ -1380,7 +1386,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                 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;
@@ -1495,7 +1501,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                 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;
@@ -1632,6 +1638,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1647,6 +1654,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1662,6 +1670,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1677,6 +1686,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1697,6 +1707,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -1727,6 +1738,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1742,6 +1754,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1757,6 +1770,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1772,6 +1786,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1792,6 +1807,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -1823,6 +1839,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1838,6 +1855,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1853,6 +1871,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1868,6 +1887,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1888,6 +1908,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -1902,7 +1923,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                 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;
@@ -1918,6 +1939,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1933,6 +1955,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1948,6 +1971,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1963,6 +1987,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -1983,6 +2008,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -2012,6 +2038,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2027,6 +2054,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2042,6 +2070,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2057,6 +2086,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2077,6 +2107,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -2106,6 +2137,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2121,6 +2153,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2136,6 +2169,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2151,6 +2185,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2171,6 +2206,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -2185,7 +2221,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                 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;
@@ -2201,6 +2237,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2216,6 +2253,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2231,6 +2269,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2246,6 +2285,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2266,6 +2306,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -2295,6 +2336,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2310,6 +2352,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2325,6 +2368,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2340,6 +2384,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2360,6 +2405,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -2389,6 +2435,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2404,6 +2451,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2419,6 +2467,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2434,6 +2483,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                         required?: boolean | undefined;
                         description?: string | undefined;
                         enum?: string[] | undefined;
+                        examples?: string[] | undefined;
                         format?: string | undefined;
                         file?: any;
                         nullable?: boolean | undefined;
@@ -2454,6 +2504,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                             required?: boolean | undefined;
                             description?: string | undefined;
                             enum?: string[] | undefined;
+                            examples?: string[] | undefined;
                             format?: string | undefined;
                             file?: any;
                             nullable?: boolean | undefined;
@@ -3173,16 +3224,20 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                 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;
@@ -3190,52 +3245,66 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
                 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 import("@scalar/object-utils/nested").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]> ? import("@scalar/object-utils/nested").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 import("@scalar/object-utils/nested").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]> ? import("@scalar/object-utils/nested").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;