@scalar/api-client 2.5.12 → 2.5.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +76 -0
- package/README.md +1 -1
- package/dist/components/AddressBar/AddressBar.vue.js +1 -1
- package/dist/components/AddressBar/AddressBarHistory.vue.js +1 -1
- package/dist/components/AddressBar/AddressBarHistory.vue2.js +1 -1
- package/dist/components/CodeInput/CodeInput.vue.js +2 -2
- package/dist/components/CodeInput/CodeInput.vue2.js +2 -2
- package/dist/components/CommandPalette/CommandActionInput.vue.d.ts.map +1 -1
- package/dist/components/CommandPalette/CommandActionInput.vue.js +11 -10
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts +10 -10
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts.map +1 -1
- package/dist/components/CommandPalette/TheCommandPalette.vue.js +2 -2
- package/dist/components/CommandPalette/TheCommandPalette.vue2.js +129 -116
- package/dist/components/DataTable/DataTableCell.vue.js +8 -8
- package/dist/components/DataTable/DataTableInput.vue.d.ts.map +1 -1
- package/dist/components/DataTable/DataTableInput.vue.js +2 -2
- package/dist/components/ImportCollection/ImportCollectionModal.vue.js +7 -7
- package/dist/components/ImportCollection/PrefetchError.vue.js +1 -1
- package/dist/components/ImportCollection/WorkspaceSelector.vue.js +1 -1
- package/dist/components/ImportCollection/utils/get-openapi-version.d.ts +5 -0
- package/dist/components/ImportCollection/utils/get-openapi-version.d.ts.map +1 -0
- package/dist/components/ImportCollection/utils/get-openapi-version.js +20 -0
- package/dist/components/ImportCollection/utils/get-openapi-version.test.d.ts +2 -0
- package/dist/components/ImportCollection/utils/get-openapi-version.test.d.ts.map +1 -0
- package/dist/components/ImportCollection/utils/import-collection.js +1 -1
- package/dist/components/ImportCollection/utils/{isDocument.d.ts → is-document.d.ts} +2 -2
- package/dist/components/ImportCollection/utils/is-document.d.ts.map +1 -0
- package/dist/components/ImportCollection/utils/is-document.js +9 -0
- package/dist/components/ImportCollection/utils/is-document.test.d.ts +2 -0
- package/dist/components/ImportCollection/utils/is-document.test.d.ts.map +1 -0
- package/dist/components/ImportCollection/utils/is-url.d.ts +5 -0
- package/dist/components/ImportCollection/utils/is-url.d.ts.map +1 -0
- package/dist/components/ImportCollection/utils/is-url.js +9 -0
- package/dist/components/ImportCollection/utils/is-url.test.d.ts +2 -0
- package/dist/components/ImportCollection/utils/is-url.test.d.ts.map +1 -0
- package/dist/components/OpenApiClientButton.vue.js +2 -2
- package/dist/components/Server/ServerDropdown.vue.d.ts.map +1 -1
- package/dist/components/Server/ServerDropdown.vue.js +8 -8
- package/dist/components/Server/ServerSelector.vue.d.ts.map +1 -1
- package/dist/components/Server/ServerSelector.vue.js +13 -13
- package/dist/components/TopNav/TopNav.vue.js +10 -10
- package/dist/components/TopNav/TopNavItem.vue.js +1 -1
- package/dist/components/TopNav/TopNavItem.vue2.js +1 -1
- package/dist/components/ViewLayout/ViewLayoutCollapse.vue.d.ts +5 -1
- package/dist/components/ViewLayout/ViewLayoutCollapse.vue.d.ts.map +1 -1
- package/dist/components/ViewLayout/ViewLayoutCollapse.vue.js +42 -36
- package/dist/components/ViewLayout/ViewLayoutSection.vue.js +4 -4
- package/dist/hooks/useClientConfig.d.ts +42 -36
- package/dist/hooks/useClientConfig.d.ts.map +1 -1
- package/dist/layouts/App/create-api-client-app.d.ts +160 -160
- package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
- package/dist/layouts/Modal/create-api-client-modal.d.ts +320 -320
- package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
- package/dist/layouts/Web/create-api-client-web.d.ts +160 -160
- package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
- package/dist/libs/create-client.d.ts +160 -160
- package/dist/libs/create-client.d.ts.map +1 -1
- package/dist/libs/find-request.d.ts +5 -5
- package/dist/libs/find-request.d.ts.map +1 -1
- package/dist/libs/send-request/create-request-operation.js +10 -10
- package/dist/libs/send-request/create-request-operation.test.d.ts +33 -33
- package/dist/libs/send-request/create-request-operation.test.d.ts.map +1 -1
- package/dist/libs/send-request/set-request-cookies.d.ts +1 -1
- package/dist/libs/send-request/set-request-cookies.d.ts.map +1 -1
- package/dist/plugins/plugin-manager.d.ts +5 -3
- package/dist/plugins/plugin-manager.d.ts.map +1 -1
- package/dist/plugins/plugin-manager.js +17 -9
- package/dist/plugins/plugin-manager.test.d.ts +2 -0
- package/dist/plugins/plugin-manager.test.d.ts.map +1 -0
- package/dist/store/active-entities.d.ts +33 -33
- package/dist/store/active-entities.d.ts.map +1 -1
- package/dist/store/request-example.d.ts +130 -130
- package/dist/store/request-example.d.ts.map +1 -1
- package/dist/store/requests.d.ts +55 -55
- package/dist/store/requests.d.ts.map +1 -1
- package/dist/store/store.d.ts +162 -162
- package/dist/store/store.d.ts.map +1 -1
- package/dist/style.css +1 -1
- package/dist/views/Collection/CollectionInfoForm.vue.js +2 -2
- package/dist/views/Collection/components/EnvironmentForm.vue.js +2 -2
- package/dist/views/Collection/components/MarkdownInput.vue.d.ts.map +1 -1
- package/dist/views/Collection/components/MarkdownInput.vue.js +1 -1
- package/dist/views/Collection/components/MarkdownInput.vue2.js +32 -26
- package/dist/views/Components/CodeSnippet/CodeSnippet.vue.d.ts.map +1 -1
- package/dist/views/Components/CodeSnippet/CodeSnippet.vue.js +15 -14
- package/dist/views/Components/CodeSnippet/helpers/get-snippet.d.ts +2 -9
- package/dist/views/Components/CodeSnippet/helpers/get-snippet.d.ts.map +1 -1
- package/dist/views/Components/CodeSnippet/helpers/get-snippet.js +16 -30
- package/dist/views/Cookies/CookieForm.vue.js +1 -1
- package/dist/views/Cookies/Cookies.vue.d.ts.map +1 -1
- package/dist/views/Cookies/Cookies.vue2.js +67 -61
- package/dist/views/Environment/Environment.vue.d.ts.map +1 -1
- package/dist/views/Environment/Environment.vue2.js +98 -92
- package/dist/views/Environment/EnvironmentVariableDropdown.vue.js +6 -6
- package/dist/views/Request/RequestSection/RequestAuth/DeleteRequestAuthModal.vue.js +1 -1
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue.js +2 -2
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue2.js +125 -121
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuthTab.vue.js +1 -1
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuthTab.vue2.js +22 -22
- package/dist/views/Request/RequestSection/RequestBody.vue.js +1 -1
- package/dist/views/Request/RequestSection/RequestCodeExample.vue.js +2 -2
- package/dist/views/Request/RequestSection/RequestTable.vue.js +1 -1
- package/dist/views/Request/RequestSidebarItem.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSidebarItem.vue.js +2 -2
- package/dist/views/Request/RequestSidebarItem.vue2.js +9 -9
- package/dist/views/Request/ResponseSection/RequestHeaders.vue.js +9 -9
- package/dist/views/Request/ResponseSection/ResponseBody.vue.js +2 -2
- package/dist/views/Request/ResponseSection/ResponseBodyRaw.vue.js +3 -3
- package/dist/views/Request/ResponseSection/ResponseBodyVirtual.vue.js +1 -1
- package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +1 -1
- package/dist/views/Request/ResponseSection/ResponseHeaders.vue.js +9 -9
- package/dist/views/Request/components/WorkspaceDropdown.vue.js +2 -2
- package/dist/views/Settings/SettingsGeneral.vue.js +2 -2
- package/package.json +22 -21
- package/dist/components/ImportCollection/utils/getOpenApiDocumentVersion.d.ts +0 -5
- package/dist/components/ImportCollection/utils/getOpenApiDocumentVersion.d.ts.map +0 -1
- package/dist/components/ImportCollection/utils/getOpenApiDocumentVersion.js +0 -20
- package/dist/components/ImportCollection/utils/isDocument.d.ts.map +0 -1
- package/dist/components/ImportCollection/utils/isDocument.js +0 -7
- package/dist/components/ImportCollection/utils/isUrl.d.ts +0 -3
- package/dist/components/ImportCollection/utils/isUrl.d.ts.map +0 -1
- package/dist/components/ImportCollection/utils/isUrl.js +0 -6
|
@@ -139,34 +139,6 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
139
139
|
uid: string & import("zod").BRAND<"example">;
|
|
140
140
|
name: string;
|
|
141
141
|
type: "requestExample";
|
|
142
|
-
body: {
|
|
143
|
-
activeBody: "binary" | "formData" | "raw";
|
|
144
|
-
binary?: Blob | undefined;
|
|
145
|
-
formData?: {
|
|
146
|
-
value: {
|
|
147
|
-
value: string;
|
|
148
|
-
key: string;
|
|
149
|
-
enabled: boolean;
|
|
150
|
-
minimum?: number | undefined;
|
|
151
|
-
type?: string | string[] | undefined;
|
|
152
|
-
maximum?: number | undefined;
|
|
153
|
-
description?: string | undefined;
|
|
154
|
-
default?: any;
|
|
155
|
-
required?: boolean | undefined;
|
|
156
|
-
enum?: string[] | undefined;
|
|
157
|
-
format?: string | undefined;
|
|
158
|
-
examples?: any[] | undefined;
|
|
159
|
-
file?: any;
|
|
160
|
-
nullable?: boolean | undefined;
|
|
161
|
-
}[];
|
|
162
|
-
encoding: "form-data" | "urlencoded";
|
|
163
|
-
} | undefined;
|
|
164
|
-
raw?: {
|
|
165
|
-
value: string;
|
|
166
|
-
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
167
|
-
mimeType?: string | undefined;
|
|
168
|
-
} | undefined;
|
|
169
|
-
};
|
|
170
142
|
parameters: {
|
|
171
143
|
path: {
|
|
172
144
|
value: string;
|
|
@@ -233,6 +205,34 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
233
205
|
nullable?: boolean | undefined;
|
|
234
206
|
}[];
|
|
235
207
|
};
|
|
208
|
+
body: {
|
|
209
|
+
activeBody: "binary" | "formData" | "raw";
|
|
210
|
+
binary?: Blob | undefined;
|
|
211
|
+
formData?: {
|
|
212
|
+
value: {
|
|
213
|
+
value: string;
|
|
214
|
+
key: string;
|
|
215
|
+
enabled: boolean;
|
|
216
|
+
minimum?: number | undefined;
|
|
217
|
+
type?: string | string[] | undefined;
|
|
218
|
+
maximum?: number | undefined;
|
|
219
|
+
description?: string | undefined;
|
|
220
|
+
default?: any;
|
|
221
|
+
required?: boolean | undefined;
|
|
222
|
+
enum?: string[] | undefined;
|
|
223
|
+
format?: string | undefined;
|
|
224
|
+
examples?: any[] | undefined;
|
|
225
|
+
file?: any;
|
|
226
|
+
nullable?: boolean | undefined;
|
|
227
|
+
}[];
|
|
228
|
+
encoding: "form-data" | "urlencoded";
|
|
229
|
+
} | undefined;
|
|
230
|
+
raw?: {
|
|
231
|
+
value: string;
|
|
232
|
+
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
233
|
+
mimeType?: string | undefined;
|
|
234
|
+
} | undefined;
|
|
235
|
+
};
|
|
236
236
|
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
237
237
|
serverVariables?: Record<string, string[]> | undefined;
|
|
238
238
|
}>;
|
|
@@ -244,7 +244,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
244
244
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
245
245
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
246
246
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
247
|
-
method: "options" | "
|
|
247
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
248
248
|
description?: string | undefined;
|
|
249
249
|
summary?: string | undefined;
|
|
250
250
|
externalDocs?: {
|
|
@@ -257,6 +257,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
257
257
|
tags?: string[] | undefined;
|
|
258
258
|
deprecated?: boolean | undefined;
|
|
259
259
|
operationId?: string | undefined;
|
|
260
|
+
requestBody?: any;
|
|
260
261
|
parameters?: {
|
|
261
262
|
name: string;
|
|
262
263
|
required: boolean;
|
|
@@ -269,16 +270,13 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
269
270
|
summary?: string | undefined;
|
|
270
271
|
externalValue?: string | undefined;
|
|
271
272
|
}> | undefined;
|
|
273
|
+
schema?: unknown;
|
|
272
274
|
content?: unknown;
|
|
273
275
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
274
276
|
explode?: boolean | undefined;
|
|
275
|
-
schema?: unknown;
|
|
276
277
|
}[] | undefined;
|
|
277
|
-
requestBody?: any;
|
|
278
278
|
responses?: Record<string, any> | undefined;
|
|
279
279
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
280
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
281
|
-
'x-post-response'?: string | undefined;
|
|
282
280
|
'x-codeSamples'?: {
|
|
283
281
|
source: string;
|
|
284
282
|
label?: string | undefined;
|
|
@@ -294,6 +292,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
294
292
|
label?: string | undefined;
|
|
295
293
|
lang?: string | undefined;
|
|
296
294
|
}[] | undefined;
|
|
295
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
296
|
+
'x-post-response'?: string | undefined;
|
|
297
297
|
}>;
|
|
298
298
|
servers: Record<string, {
|
|
299
299
|
uid: string & import("zod").BRAND<"server">;
|
|
@@ -408,7 +408,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
408
408
|
proxyUrl: string | undefined;
|
|
409
409
|
hideClientButton: boolean;
|
|
410
410
|
showSidebar: boolean;
|
|
411
|
-
integration: "elysiajs" | "fastify" | "go" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "
|
|
411
|
+
integration: "elysiajs" | "fastify" | "go" | "rust" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "svelte" | "vue" | null | undefined;
|
|
412
412
|
importSpecFile: (_spec: string | Record<string, any> | undefined, workspaceUid: string, options?: Pick<{
|
|
413
413
|
uid?: string | undefined;
|
|
414
414
|
type?: "collection" | undefined;
|
|
@@ -1233,7 +1233,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1233
1233
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1234
1234
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1235
1235
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1236
|
-
method: "options" | "
|
|
1236
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1237
1237
|
description?: string | undefined;
|
|
1238
1238
|
summary?: string | undefined;
|
|
1239
1239
|
externalDocs?: {
|
|
@@ -1246,6 +1246,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1246
1246
|
tags?: string[] | undefined;
|
|
1247
1247
|
deprecated?: boolean | undefined;
|
|
1248
1248
|
operationId?: string | undefined;
|
|
1249
|
+
requestBody?: any;
|
|
1249
1250
|
parameters?: {
|
|
1250
1251
|
name: string;
|
|
1251
1252
|
required: boolean;
|
|
@@ -1258,16 +1259,13 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1258
1259
|
summary?: string | undefined;
|
|
1259
1260
|
externalValue?: string | undefined;
|
|
1260
1261
|
}> | undefined;
|
|
1262
|
+
schema?: unknown;
|
|
1261
1263
|
content?: unknown;
|
|
1262
1264
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1263
1265
|
explode?: boolean | undefined;
|
|
1264
|
-
schema?: unknown;
|
|
1265
1266
|
}[] | undefined;
|
|
1266
|
-
requestBody?: any;
|
|
1267
1267
|
responses?: Record<string, any> | undefined;
|
|
1268
1268
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1269
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1270
|
-
'x-post-response'?: string | undefined;
|
|
1271
1269
|
'x-codeSamples'?: {
|
|
1272
1270
|
source: string;
|
|
1273
1271
|
label?: string | undefined;
|
|
@@ -1283,6 +1281,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1283
1281
|
label?: string | undefined;
|
|
1284
1282
|
lang?: string | undefined;
|
|
1285
1283
|
}[] | undefined;
|
|
1284
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1285
|
+
'x-post-response'?: string | undefined;
|
|
1286
1286
|
}) => void;
|
|
1287
1287
|
add: (payload: import("@scalar/oas-utils/entities/spec").RequestPayload, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void | {
|
|
1288
1288
|
uid: string & import("zod").BRAND<"operation">;
|
|
@@ -1292,7 +1292,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1292
1292
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1293
1293
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1294
1294
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1295
|
-
method: "options" | "
|
|
1295
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1296
1296
|
description?: string | undefined;
|
|
1297
1297
|
summary?: string | undefined;
|
|
1298
1298
|
externalDocs?: {
|
|
@@ -1305,6 +1305,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1305
1305
|
tags?: string[] | undefined;
|
|
1306
1306
|
deprecated?: boolean | undefined;
|
|
1307
1307
|
operationId?: string | undefined;
|
|
1308
|
+
requestBody?: any;
|
|
1308
1309
|
parameters?: {
|
|
1309
1310
|
name: string;
|
|
1310
1311
|
required: boolean;
|
|
@@ -1317,16 +1318,13 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1317
1318
|
summary?: string | undefined;
|
|
1318
1319
|
externalValue?: string | undefined;
|
|
1319
1320
|
}> | undefined;
|
|
1321
|
+
schema?: unknown;
|
|
1320
1322
|
content?: unknown;
|
|
1321
1323
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1322
1324
|
explode?: boolean | undefined;
|
|
1323
|
-
schema?: unknown;
|
|
1324
1325
|
}[] | undefined;
|
|
1325
|
-
requestBody?: any;
|
|
1326
1326
|
responses?: Record<string, any> | undefined;
|
|
1327
1327
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1328
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1329
|
-
'x-post-response'?: string | undefined;
|
|
1330
1328
|
'x-codeSamples'?: {
|
|
1331
1329
|
source: string;
|
|
1332
1330
|
label?: string | undefined;
|
|
@@ -1342,6 +1340,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1342
1340
|
label?: string | undefined;
|
|
1343
1341
|
lang?: string | undefined;
|
|
1344
1342
|
}[] | undefined;
|
|
1343
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1344
|
+
'x-post-response'?: string | undefined;
|
|
1345
1345
|
};
|
|
1346
1346
|
delete: (request: import("@scalar/oas-utils/entities/spec").Request, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void;
|
|
1347
1347
|
set: (item: {
|
|
@@ -1352,7 +1352,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1352
1352
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1353
1353
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1354
1354
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1355
|
-
method: "options" | "
|
|
1355
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1356
1356
|
description?: string | undefined;
|
|
1357
1357
|
summary?: string | undefined;
|
|
1358
1358
|
externalDocs?: {
|
|
@@ -1365,6 +1365,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1365
1365
|
tags?: string[] | undefined;
|
|
1366
1366
|
deprecated?: boolean | undefined;
|
|
1367
1367
|
operationId?: string | undefined;
|
|
1368
|
+
requestBody?: any;
|
|
1368
1369
|
parameters?: {
|
|
1369
1370
|
name: string;
|
|
1370
1371
|
required: boolean;
|
|
@@ -1377,16 +1378,13 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1377
1378
|
summary?: string | undefined;
|
|
1378
1379
|
externalValue?: string | undefined;
|
|
1379
1380
|
}> | undefined;
|
|
1381
|
+
schema?: unknown;
|
|
1380
1382
|
content?: unknown;
|
|
1381
1383
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1382
1384
|
explode?: boolean | undefined;
|
|
1383
|
-
schema?: unknown;
|
|
1384
1385
|
}[] | undefined;
|
|
1385
|
-
requestBody?: any;
|
|
1386
1386
|
responses?: Record<string, any> | undefined;
|
|
1387
1387
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1388
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1389
|
-
'x-post-response'?: string | undefined;
|
|
1390
1388
|
'x-codeSamples'?: {
|
|
1391
1389
|
source: string;
|
|
1392
1390
|
label?: string | undefined;
|
|
@@ -1402,6 +1400,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1402
1400
|
label?: string | undefined;
|
|
1403
1401
|
lang?: string | undefined;
|
|
1404
1402
|
}[] | undefined;
|
|
1403
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1404
|
+
'x-post-response'?: string | undefined;
|
|
1405
1405
|
}) => void;
|
|
1406
1406
|
edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "x-post-response" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.examples` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.required` | `parameters.${number}.explode` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `callbacks.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.lang` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.label` | `x-code-samples.${number}` | `x-code-samples.${number}.lang` | `x-code-samples.${number}.source` | `x-code-samples.${number}.label` | `x-custom-examples.${number}` | `x-custom-examples.${number}.lang` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.label`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? {
|
|
1407
1407
|
uid: string & import("zod").BRAND<"operation">;
|
|
@@ -1411,7 +1411,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1411
1411
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1412
1412
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1413
1413
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1414
|
-
method: "options" | "
|
|
1414
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1415
1415
|
description?: string | undefined;
|
|
1416
1416
|
summary?: string | undefined;
|
|
1417
1417
|
externalDocs?: {
|
|
@@ -1424,6 +1424,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1424
1424
|
tags?: string[] | undefined;
|
|
1425
1425
|
deprecated?: boolean | undefined;
|
|
1426
1426
|
operationId?: string | undefined;
|
|
1427
|
+
requestBody?: any;
|
|
1427
1428
|
parameters?: {
|
|
1428
1429
|
name: string;
|
|
1429
1430
|
required: boolean;
|
|
@@ -1436,16 +1437,13 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1436
1437
|
summary?: string | undefined;
|
|
1437
1438
|
externalValue?: string | undefined;
|
|
1438
1439
|
}> | undefined;
|
|
1440
|
+
schema?: unknown;
|
|
1439
1441
|
content?: unknown;
|
|
1440
1442
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1441
1443
|
explode?: boolean | undefined;
|
|
1442
|
-
schema?: unknown;
|
|
1443
1444
|
}[] | undefined;
|
|
1444
|
-
requestBody?: any;
|
|
1445
1445
|
responses?: Record<string, any> | undefined;
|
|
1446
1446
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1447
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1448
|
-
'x-post-response'?: string | undefined;
|
|
1449
1447
|
'x-codeSamples'?: {
|
|
1450
1448
|
source: string;
|
|
1451
1449
|
label?: string | undefined;
|
|
@@ -1461,6 +1459,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1461
1459
|
label?: string | undefined;
|
|
1462
1460
|
lang?: string | undefined;
|
|
1463
1461
|
}[] | undefined;
|
|
1462
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1463
|
+
'x-post-response'?: string | undefined;
|
|
1464
1464
|
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1465
1465
|
uid: string & import("zod").BRAND<"operation">;
|
|
1466
1466
|
path: string;
|
|
@@ -1469,7 +1469,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1469
1469
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1470
1470
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1471
1471
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1472
|
-
method: "options" | "
|
|
1472
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1473
1473
|
description?: string | undefined;
|
|
1474
1474
|
summary?: string | undefined;
|
|
1475
1475
|
externalDocs?: {
|
|
@@ -1482,6 +1482,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1482
1482
|
tags?: string[] | undefined;
|
|
1483
1483
|
deprecated?: boolean | undefined;
|
|
1484
1484
|
operationId?: string | undefined;
|
|
1485
|
+
requestBody?: any;
|
|
1485
1486
|
parameters?: {
|
|
1486
1487
|
name: string;
|
|
1487
1488
|
required: boolean;
|
|
@@ -1494,16 +1495,13 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1494
1495
|
summary?: string | undefined;
|
|
1495
1496
|
externalValue?: string | undefined;
|
|
1496
1497
|
}> | undefined;
|
|
1498
|
+
schema?: unknown;
|
|
1497
1499
|
content?: unknown;
|
|
1498
1500
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1499
1501
|
explode?: boolean | undefined;
|
|
1500
|
-
schema?: unknown;
|
|
1501
1502
|
}[] | undefined;
|
|
1502
|
-
requestBody?: any;
|
|
1503
1503
|
responses?: Record<string, any> | undefined;
|
|
1504
1504
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1505
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1506
|
-
'x-post-response'?: string | undefined;
|
|
1507
1505
|
'x-codeSamples'?: {
|
|
1508
1506
|
source: string;
|
|
1509
1507
|
label?: string | undefined;
|
|
@@ -1519,6 +1517,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1519
1517
|
label?: string | undefined;
|
|
1520
1518
|
lang?: string | undefined;
|
|
1521
1519
|
}[] | undefined;
|
|
1520
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1521
|
+
'x-post-response'?: string | undefined;
|
|
1522
1522
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
1523
1523
|
uid: string & import("zod").BRAND<"operation">;
|
|
1524
1524
|
path: string;
|
|
@@ -1527,7 +1527,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1527
1527
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1528
1528
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1529
1529
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1530
|
-
method: "options" | "
|
|
1530
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1531
1531
|
description?: string | undefined;
|
|
1532
1532
|
summary?: string | undefined;
|
|
1533
1533
|
externalDocs?: {
|
|
@@ -1540,6 +1540,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1540
1540
|
tags?: string[] | undefined;
|
|
1541
1541
|
deprecated?: boolean | undefined;
|
|
1542
1542
|
operationId?: string | undefined;
|
|
1543
|
+
requestBody?: any;
|
|
1543
1544
|
parameters?: {
|
|
1544
1545
|
name: string;
|
|
1545
1546
|
required: boolean;
|
|
@@ -1552,16 +1553,13 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1552
1553
|
summary?: string | undefined;
|
|
1553
1554
|
externalValue?: string | undefined;
|
|
1554
1555
|
}> | undefined;
|
|
1556
|
+
schema?: unknown;
|
|
1555
1557
|
content?: unknown;
|
|
1556
1558
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1557
1559
|
explode?: boolean | undefined;
|
|
1558
|
-
schema?: unknown;
|
|
1559
1560
|
}[] | undefined;
|
|
1560
|
-
requestBody?: any;
|
|
1561
1561
|
responses?: Record<string, any> | undefined;
|
|
1562
1562
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1563
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1564
|
-
'x-post-response'?: string | undefined;
|
|
1565
1563
|
'x-codeSamples'?: {
|
|
1566
1564
|
source: string;
|
|
1567
1565
|
label?: string | undefined;
|
|
@@ -1577,6 +1575,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1577
1575
|
label?: string | undefined;
|
|
1578
1576
|
lang?: string | undefined;
|
|
1579
1577
|
}[] | undefined;
|
|
1578
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1579
|
+
'x-post-response'?: string | undefined;
|
|
1580
1580
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1581
1581
|
untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "x-post-response" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.examples` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.required` | `parameters.${number}.explode` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `callbacks.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.lang` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.label` | `x-code-samples.${number}` | `x-code-samples.${number}.lang` | `x-code-samples.${number}.source` | `x-code-samples.${number}.label` | `x-custom-examples.${number}` | `x-custom-examples.${number}.lang` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.label`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? {
|
|
1582
1582
|
uid: string & import("zod").BRAND<"operation">;
|
|
@@ -1586,7 +1586,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1586
1586
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1587
1587
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1588
1588
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1589
|
-
method: "options" | "
|
|
1589
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1590
1590
|
description?: string | undefined;
|
|
1591
1591
|
summary?: string | undefined;
|
|
1592
1592
|
externalDocs?: {
|
|
@@ -1599,6 +1599,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1599
1599
|
tags?: string[] | undefined;
|
|
1600
1600
|
deprecated?: boolean | undefined;
|
|
1601
1601
|
operationId?: string | undefined;
|
|
1602
|
+
requestBody?: any;
|
|
1602
1603
|
parameters?: {
|
|
1603
1604
|
name: string;
|
|
1604
1605
|
required: boolean;
|
|
@@ -1611,16 +1612,13 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1611
1612
|
summary?: string | undefined;
|
|
1612
1613
|
externalValue?: string | undefined;
|
|
1613
1614
|
}> | undefined;
|
|
1615
|
+
schema?: unknown;
|
|
1614
1616
|
content?: unknown;
|
|
1615
1617
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1616
1618
|
explode?: boolean | undefined;
|
|
1617
|
-
schema?: unknown;
|
|
1618
1619
|
}[] | undefined;
|
|
1619
|
-
requestBody?: any;
|
|
1620
1620
|
responses?: Record<string, any> | undefined;
|
|
1621
1621
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1622
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1623
|
-
'x-post-response'?: string | undefined;
|
|
1624
1622
|
'x-codeSamples'?: {
|
|
1625
1623
|
source: string;
|
|
1626
1624
|
label?: string | undefined;
|
|
@@ -1636,6 +1634,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1636
1634
|
label?: string | undefined;
|
|
1637
1635
|
lang?: string | undefined;
|
|
1638
1636
|
}[] | undefined;
|
|
1637
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1638
|
+
'x-post-response'?: string | undefined;
|
|
1639
1639
|
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1640
1640
|
uid: string & import("zod").BRAND<"operation">;
|
|
1641
1641
|
path: string;
|
|
@@ -1644,7 +1644,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1644
1644
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1645
1645
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1646
1646
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1647
|
-
method: "options" | "
|
|
1647
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1648
1648
|
description?: string | undefined;
|
|
1649
1649
|
summary?: string | undefined;
|
|
1650
1650
|
externalDocs?: {
|
|
@@ -1657,6 +1657,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1657
1657
|
tags?: string[] | undefined;
|
|
1658
1658
|
deprecated?: boolean | undefined;
|
|
1659
1659
|
operationId?: string | undefined;
|
|
1660
|
+
requestBody?: any;
|
|
1660
1661
|
parameters?: {
|
|
1661
1662
|
name: string;
|
|
1662
1663
|
required: boolean;
|
|
@@ -1669,16 +1670,13 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1669
1670
|
summary?: string | undefined;
|
|
1670
1671
|
externalValue?: string | undefined;
|
|
1671
1672
|
}> | undefined;
|
|
1673
|
+
schema?: unknown;
|
|
1672
1674
|
content?: unknown;
|
|
1673
1675
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1674
1676
|
explode?: boolean | undefined;
|
|
1675
|
-
schema?: unknown;
|
|
1676
1677
|
}[] | undefined;
|
|
1677
|
-
requestBody?: any;
|
|
1678
1678
|
responses?: Record<string, any> | undefined;
|
|
1679
1679
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1680
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1681
|
-
'x-post-response'?: string | undefined;
|
|
1682
1680
|
'x-codeSamples'?: {
|
|
1683
1681
|
source: string;
|
|
1684
1682
|
label?: string | undefined;
|
|
@@ -1694,6 +1692,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1694
1692
|
label?: string | undefined;
|
|
1695
1693
|
lang?: string | undefined;
|
|
1696
1694
|
}[] | undefined;
|
|
1695
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1696
|
+
'x-post-response'?: string | undefined;
|
|
1697
1697
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
1698
1698
|
uid: string & import("zod").BRAND<"operation">;
|
|
1699
1699
|
path: string;
|
|
@@ -1702,7 +1702,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1702
1702
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1703
1703
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1704
1704
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1705
|
-
method: "options" | "
|
|
1705
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1706
1706
|
description?: string | undefined;
|
|
1707
1707
|
summary?: string | undefined;
|
|
1708
1708
|
externalDocs?: {
|
|
@@ -1715,6 +1715,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1715
1715
|
tags?: string[] | undefined;
|
|
1716
1716
|
deprecated?: boolean | undefined;
|
|
1717
1717
|
operationId?: string | undefined;
|
|
1718
|
+
requestBody?: any;
|
|
1718
1719
|
parameters?: {
|
|
1719
1720
|
name: string;
|
|
1720
1721
|
required: boolean;
|
|
@@ -1727,16 +1728,13 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1727
1728
|
summary?: string | undefined;
|
|
1728
1729
|
externalValue?: string | undefined;
|
|
1729
1730
|
}> | undefined;
|
|
1731
|
+
schema?: unknown;
|
|
1730
1732
|
content?: unknown;
|
|
1731
1733
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1732
1734
|
explode?: boolean | undefined;
|
|
1733
|
-
schema?: unknown;
|
|
1734
1735
|
}[] | undefined;
|
|
1735
|
-
requestBody?: any;
|
|
1736
1736
|
responses?: Record<string, any> | undefined;
|
|
1737
1737
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1738
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1739
|
-
'x-post-response'?: string | undefined;
|
|
1740
1738
|
'x-codeSamples'?: {
|
|
1741
1739
|
source: string;
|
|
1742
1740
|
label?: string | undefined;
|
|
@@ -1752,6 +1750,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1752
1750
|
label?: string | undefined;
|
|
1753
1751
|
lang?: string | undefined;
|
|
1754
1752
|
}[] | undefined;
|
|
1753
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1754
|
+
'x-post-response'?: string | undefined;
|
|
1755
1755
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1756
1756
|
undo: (uid: string & import("zod").BRAND<"operation">) => void;
|
|
1757
1757
|
redo: (uid: string & import("zod").BRAND<"operation">) => void;
|
|
@@ -1763,34 +1763,6 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1763
1763
|
uid: string & import("zod").BRAND<"example">;
|
|
1764
1764
|
name: string;
|
|
1765
1765
|
type: "requestExample";
|
|
1766
|
-
body: {
|
|
1767
|
-
activeBody: "binary" | "formData" | "raw";
|
|
1768
|
-
binary?: Blob | undefined;
|
|
1769
|
-
formData?: {
|
|
1770
|
-
value: {
|
|
1771
|
-
value: string;
|
|
1772
|
-
key: string;
|
|
1773
|
-
enabled: boolean;
|
|
1774
|
-
minimum?: number | undefined;
|
|
1775
|
-
type?: string | string[] | undefined;
|
|
1776
|
-
maximum?: number | undefined;
|
|
1777
|
-
description?: string | undefined;
|
|
1778
|
-
default?: any;
|
|
1779
|
-
required?: boolean | undefined;
|
|
1780
|
-
enum?: string[] | undefined;
|
|
1781
|
-
format?: string | undefined;
|
|
1782
|
-
examples?: any[] | undefined;
|
|
1783
|
-
file?: any;
|
|
1784
|
-
nullable?: boolean | undefined;
|
|
1785
|
-
}[];
|
|
1786
|
-
encoding: "form-data" | "urlencoded";
|
|
1787
|
-
} | undefined;
|
|
1788
|
-
raw?: {
|
|
1789
|
-
value: string;
|
|
1790
|
-
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
1791
|
-
mimeType?: string | undefined;
|
|
1792
|
-
} | undefined;
|
|
1793
|
-
};
|
|
1794
1766
|
parameters: {
|
|
1795
1767
|
path: {
|
|
1796
1768
|
value: string;
|
|
@@ -1857,13 +1829,6 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1857
1829
|
nullable?: boolean | undefined;
|
|
1858
1830
|
}[];
|
|
1859
1831
|
};
|
|
1860
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
1861
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1862
|
-
}) => void;
|
|
1863
|
-
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
1864
|
-
uid: string & import("zod").BRAND<"example">;
|
|
1865
|
-
name: string;
|
|
1866
|
-
type: "requestExample";
|
|
1867
1832
|
body: {
|
|
1868
1833
|
activeBody: "binary" | "formData" | "raw";
|
|
1869
1834
|
binary?: Blob | undefined;
|
|
@@ -1892,6 +1857,13 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1892
1857
|
mimeType?: string | undefined;
|
|
1893
1858
|
} | undefined;
|
|
1894
1859
|
};
|
|
1860
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
1861
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1862
|
+
}) => void;
|
|
1863
|
+
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
1864
|
+
uid: string & import("zod").BRAND<"example">;
|
|
1865
|
+
name: string;
|
|
1866
|
+
type: "requestExample";
|
|
1895
1867
|
parameters: {
|
|
1896
1868
|
path: {
|
|
1897
1869
|
value: string;
|
|
@@ -1958,14 +1930,6 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1958
1930
|
nullable?: boolean | undefined;
|
|
1959
1931
|
}[];
|
|
1960
1932
|
};
|
|
1961
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
1962
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1963
|
-
};
|
|
1964
|
-
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
1965
|
-
set: (item: {
|
|
1966
|
-
uid: string & import("zod").BRAND<"example">;
|
|
1967
|
-
name: string;
|
|
1968
|
-
type: "requestExample";
|
|
1969
1933
|
body: {
|
|
1970
1934
|
activeBody: "binary" | "formData" | "raw";
|
|
1971
1935
|
binary?: Blob | undefined;
|
|
@@ -1994,6 +1958,14 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1994
1958
|
mimeType?: string | undefined;
|
|
1995
1959
|
} | undefined;
|
|
1996
1960
|
};
|
|
1961
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
1962
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1963
|
+
};
|
|
1964
|
+
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
1965
|
+
set: (item: {
|
|
1966
|
+
uid: string & import("zod").BRAND<"example">;
|
|
1967
|
+
name: string;
|
|
1968
|
+
type: "requestExample";
|
|
1997
1969
|
parameters: {
|
|
1998
1970
|
path: {
|
|
1999
1971
|
value: string;
|
|
@@ -2060,13 +2032,6 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2060
2032
|
nullable?: boolean | undefined;
|
|
2061
2033
|
}[];
|
|
2062
2034
|
};
|
|
2063
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2064
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2065
|
-
}) => void;
|
|
2066
|
-
edit: <P extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" | "parameters.path" | "parameters.query" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.headers" | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.examples` | `parameters.path.${number}.required` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.default` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.key` | `parameters.path.${number}.file` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.enabled` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.examples.${number}.${string}` | `parameters.path.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.examples` | `parameters.query.${number}.required` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.default` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.key` | `parameters.query.${number}.file` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.examples.${number}.${string}` | `parameters.query.${number}.file.${string}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.examples.${number}.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.default` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.key` | `parameters.headers.${number}.file` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.examples.${number}.${string}` | `parameters.headers.${number}.file.${string}` | "body.binary" | "body.formData" | "body.raw" | "body.activeBody" | "body.binary.size" | "body.binary.slice" | "body.binary.type" | "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}.examples` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.default` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.key` | `body.formData.value.${number}.file` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.format` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.examples.${number}.${string}` | `body.formData.value.${number}.file.${string}` | "body.raw.value" | "body.raw.encoding" | "body.raw.mimeType" | `serverVariables.${string}`>(uid: (string & import("zod").BRAND<"example">) | null | undefined, path: P, value: P extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? {
|
|
2067
|
-
uid: string & import("zod").BRAND<"example">;
|
|
2068
|
-
name: string;
|
|
2069
|
-
type: "requestExample";
|
|
2070
2035
|
body: {
|
|
2071
2036
|
activeBody: "binary" | "formData" | "raw";
|
|
2072
2037
|
binary?: Blob | undefined;
|
|
@@ -2095,6 +2060,13 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2095
2060
|
mimeType?: string | undefined;
|
|
2096
2061
|
} | undefined;
|
|
2097
2062
|
};
|
|
2063
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2064
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2065
|
+
}) => void;
|
|
2066
|
+
edit: <P extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" | "parameters.path" | "parameters.query" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.headers" | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.examples` | `parameters.path.${number}.required` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.default` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.key` | `parameters.path.${number}.file` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.enabled` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.examples.${number}.${string}` | `parameters.path.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.examples` | `parameters.query.${number}.required` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.default` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.key` | `parameters.query.${number}.file` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.examples.${number}.${string}` | `parameters.query.${number}.file.${string}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.examples.${number}.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.default` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.key` | `parameters.headers.${number}.file` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.examples.${number}.${string}` | `parameters.headers.${number}.file.${string}` | "body.binary" | "body.formData" | "body.raw" | "body.activeBody" | "body.binary.size" | "body.binary.slice" | "body.binary.type" | "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}.examples` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.default` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.key` | `body.formData.value.${number}.file` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.format` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.examples.${number}.${string}` | `body.formData.value.${number}.file.${string}` | "body.raw.value" | "body.raw.encoding" | "body.raw.mimeType" | `serverVariables.${string}`>(uid: (string & import("zod").BRAND<"example">) | null | undefined, path: P, value: P extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? {
|
|
2067
|
+
uid: string & import("zod").BRAND<"example">;
|
|
2068
|
+
name: string;
|
|
2069
|
+
type: "requestExample";
|
|
2098
2070
|
parameters: {
|
|
2099
2071
|
path: {
|
|
2100
2072
|
value: string;
|
|
@@ -2161,12 +2133,6 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2161
2133
|
nullable?: boolean | undefined;
|
|
2162
2134
|
}[];
|
|
2163
2135
|
};
|
|
2164
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2165
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2166
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2167
|
-
uid: string & import("zod").BRAND<"example">;
|
|
2168
|
-
name: string;
|
|
2169
|
-
type: "requestExample";
|
|
2170
2136
|
body: {
|
|
2171
2137
|
activeBody: "binary" | "formData" | "raw";
|
|
2172
2138
|
binary?: Blob | undefined;
|
|
@@ -2195,6 +2161,12 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2195
2161
|
mimeType?: string | undefined;
|
|
2196
2162
|
} | undefined;
|
|
2197
2163
|
};
|
|
2164
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2165
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2166
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2167
|
+
uid: string & import("zod").BRAND<"example">;
|
|
2168
|
+
name: string;
|
|
2169
|
+
type: "requestExample";
|
|
2198
2170
|
parameters: {
|
|
2199
2171
|
path: {
|
|
2200
2172
|
value: string;
|
|
@@ -2261,12 +2233,6 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2261
2233
|
nullable?: boolean | undefined;
|
|
2262
2234
|
}[];
|
|
2263
2235
|
};
|
|
2264
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2265
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2266
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2267
|
-
uid: string & import("zod").BRAND<"example">;
|
|
2268
|
-
name: string;
|
|
2269
|
-
type: "requestExample";
|
|
2270
2236
|
body: {
|
|
2271
2237
|
activeBody: "binary" | "formData" | "raw";
|
|
2272
2238
|
binary?: Blob | undefined;
|
|
@@ -2295,6 +2261,12 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2295
2261
|
mimeType?: string | undefined;
|
|
2296
2262
|
} | undefined;
|
|
2297
2263
|
};
|
|
2264
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2265
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2266
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2267
|
+
uid: string & import("zod").BRAND<"example">;
|
|
2268
|
+
name: string;
|
|
2269
|
+
type: "requestExample";
|
|
2298
2270
|
parameters: {
|
|
2299
2271
|
path: {
|
|
2300
2272
|
value: string;
|
|
@@ -2361,13 +2333,6 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2361
2333
|
nullable?: boolean | undefined;
|
|
2362
2334
|
}[];
|
|
2363
2335
|
};
|
|
2364
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2365
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2366
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2367
|
-
untrackedEdit: <P extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" | "parameters.path" | "parameters.query" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.headers" | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.examples` | `parameters.path.${number}.required` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.default` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.key` | `parameters.path.${number}.file` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.enabled` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.examples.${number}.${string}` | `parameters.path.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.examples` | `parameters.query.${number}.required` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.default` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.key` | `parameters.query.${number}.file` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.examples.${number}.${string}` | `parameters.query.${number}.file.${string}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.examples.${number}.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.default` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.key` | `parameters.headers.${number}.file` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.examples.${number}.${string}` | `parameters.headers.${number}.file.${string}` | "body.binary" | "body.formData" | "body.raw" | "body.activeBody" | "body.binary.size" | "body.binary.slice" | "body.binary.type" | "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}.examples` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.default` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.key` | `body.formData.value.${number}.file` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.format` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.examples.${number}.${string}` | `body.formData.value.${number}.file.${string}` | "body.raw.value" | "body.raw.encoding" | "body.raw.mimeType" | `serverVariables.${string}`>(uid: string & import("zod").BRAND<"example">, path: P, value: P extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? {
|
|
2368
|
-
uid: string & import("zod").BRAND<"example">;
|
|
2369
|
-
name: string;
|
|
2370
|
-
type: "requestExample";
|
|
2371
2336
|
body: {
|
|
2372
2337
|
activeBody: "binary" | "formData" | "raw";
|
|
2373
2338
|
binary?: Blob | undefined;
|
|
@@ -2396,6 +2361,13 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2396
2361
|
mimeType?: string | undefined;
|
|
2397
2362
|
} | undefined;
|
|
2398
2363
|
};
|
|
2364
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2365
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2366
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2367
|
+
untrackedEdit: <P extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" | "parameters.path" | "parameters.query" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.headers" | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.examples` | `parameters.path.${number}.required` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.default` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.key` | `parameters.path.${number}.file` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.enabled` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.examples.${number}.${string}` | `parameters.path.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.examples` | `parameters.query.${number}.required` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.default` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.key` | `parameters.query.${number}.file` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.examples.${number}.${string}` | `parameters.query.${number}.file.${string}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.examples.${number}.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.default` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.key` | `parameters.headers.${number}.file` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.examples.${number}.${string}` | `parameters.headers.${number}.file.${string}` | "body.binary" | "body.formData" | "body.raw" | "body.activeBody" | "body.binary.size" | "body.binary.slice" | "body.binary.type" | "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}.examples` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.default` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.key` | `body.formData.value.${number}.file` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.format` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.examples.${number}.${string}` | `body.formData.value.${number}.file.${string}` | "body.raw.value" | "body.raw.encoding" | "body.raw.mimeType" | `serverVariables.${string}`>(uid: string & import("zod").BRAND<"example">, path: P, value: P extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? {
|
|
2368
|
+
uid: string & import("zod").BRAND<"example">;
|
|
2369
|
+
name: string;
|
|
2370
|
+
type: "requestExample";
|
|
2399
2371
|
parameters: {
|
|
2400
2372
|
path: {
|
|
2401
2373
|
value: string;
|
|
@@ -2462,12 +2434,6 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2462
2434
|
nullable?: boolean | undefined;
|
|
2463
2435
|
}[];
|
|
2464
2436
|
};
|
|
2465
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2466
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2467
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2468
|
-
uid: string & import("zod").BRAND<"example">;
|
|
2469
|
-
name: string;
|
|
2470
|
-
type: "requestExample";
|
|
2471
2437
|
body: {
|
|
2472
2438
|
activeBody: "binary" | "formData" | "raw";
|
|
2473
2439
|
binary?: Blob | undefined;
|
|
@@ -2496,6 +2462,12 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2496
2462
|
mimeType?: string | undefined;
|
|
2497
2463
|
} | undefined;
|
|
2498
2464
|
};
|
|
2465
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2466
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2467
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2468
|
+
uid: string & import("zod").BRAND<"example">;
|
|
2469
|
+
name: string;
|
|
2470
|
+
type: "requestExample";
|
|
2499
2471
|
parameters: {
|
|
2500
2472
|
path: {
|
|
2501
2473
|
value: string;
|
|
@@ -2562,12 +2534,6 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2562
2534
|
nullable?: boolean | undefined;
|
|
2563
2535
|
}[];
|
|
2564
2536
|
};
|
|
2565
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2566
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2567
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2568
|
-
uid: string & import("zod").BRAND<"example">;
|
|
2569
|
-
name: string;
|
|
2570
|
-
type: "requestExample";
|
|
2571
2537
|
body: {
|
|
2572
2538
|
activeBody: "binary" | "formData" | "raw";
|
|
2573
2539
|
binary?: Blob | undefined;
|
|
@@ -2596,6 +2562,12 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2596
2562
|
mimeType?: string | undefined;
|
|
2597
2563
|
} | undefined;
|
|
2598
2564
|
};
|
|
2565
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2566
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2567
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2568
|
+
uid: string & import("zod").BRAND<"example">;
|
|
2569
|
+
name: string;
|
|
2570
|
+
type: "requestExample";
|
|
2599
2571
|
parameters: {
|
|
2600
2572
|
path: {
|
|
2601
2573
|
value: string;
|
|
@@ -2662,6 +2634,34 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2662
2634
|
nullable?: boolean | undefined;
|
|
2663
2635
|
}[];
|
|
2664
2636
|
};
|
|
2637
|
+
body: {
|
|
2638
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2639
|
+
binary?: Blob | undefined;
|
|
2640
|
+
formData?: {
|
|
2641
|
+
value: {
|
|
2642
|
+
value: string;
|
|
2643
|
+
key: string;
|
|
2644
|
+
enabled: boolean;
|
|
2645
|
+
minimum?: number | undefined;
|
|
2646
|
+
type?: string | string[] | undefined;
|
|
2647
|
+
maximum?: number | undefined;
|
|
2648
|
+
description?: string | undefined;
|
|
2649
|
+
default?: any;
|
|
2650
|
+
required?: boolean | undefined;
|
|
2651
|
+
enum?: string[] | undefined;
|
|
2652
|
+
format?: string | undefined;
|
|
2653
|
+
examples?: any[] | undefined;
|
|
2654
|
+
file?: any;
|
|
2655
|
+
nullable?: boolean | undefined;
|
|
2656
|
+
}[];
|
|
2657
|
+
encoding: "form-data" | "urlencoded";
|
|
2658
|
+
} | undefined;
|
|
2659
|
+
raw?: {
|
|
2660
|
+
value: string;
|
|
2661
|
+
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
2662
|
+
mimeType?: string | undefined;
|
|
2663
|
+
} | undefined;
|
|
2664
|
+
};
|
|
2665
2665
|
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2666
2666
|
serverVariables?: Record<string, string[]> | undefined;
|
|
2667
2667
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|