@scalar/api-client 2.5.13 → 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 +52 -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/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/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 +18 -18
- 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
|
@@ -141,34 +141,6 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
141
141
|
uid: string & import("zod").BRAND<"example">;
|
|
142
142
|
name: string;
|
|
143
143
|
type: "requestExample";
|
|
144
|
-
body: {
|
|
145
|
-
activeBody: "binary" | "formData" | "raw";
|
|
146
|
-
binary?: Blob | undefined;
|
|
147
|
-
formData?: {
|
|
148
|
-
value: {
|
|
149
|
-
value: string;
|
|
150
|
-
key: string;
|
|
151
|
-
enabled: boolean;
|
|
152
|
-
minimum?: number | undefined;
|
|
153
|
-
type?: string | string[] | undefined;
|
|
154
|
-
maximum?: number | undefined;
|
|
155
|
-
description?: string | undefined;
|
|
156
|
-
default?: any;
|
|
157
|
-
required?: boolean | undefined;
|
|
158
|
-
enum?: string[] | undefined;
|
|
159
|
-
format?: string | undefined;
|
|
160
|
-
examples?: any[] | undefined;
|
|
161
|
-
file?: any;
|
|
162
|
-
nullable?: boolean | undefined;
|
|
163
|
-
}[];
|
|
164
|
-
encoding: "form-data" | "urlencoded";
|
|
165
|
-
} | undefined;
|
|
166
|
-
raw?: {
|
|
167
|
-
value: string;
|
|
168
|
-
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
169
|
-
mimeType?: string | undefined;
|
|
170
|
-
} | undefined;
|
|
171
|
-
};
|
|
172
144
|
parameters: {
|
|
173
145
|
path: {
|
|
174
146
|
value: string;
|
|
@@ -235,6 +207,34 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
235
207
|
nullable?: boolean | undefined;
|
|
236
208
|
}[];
|
|
237
209
|
};
|
|
210
|
+
body: {
|
|
211
|
+
activeBody: "binary" | "formData" | "raw";
|
|
212
|
+
binary?: Blob | undefined;
|
|
213
|
+
formData?: {
|
|
214
|
+
value: {
|
|
215
|
+
value: string;
|
|
216
|
+
key: string;
|
|
217
|
+
enabled: boolean;
|
|
218
|
+
minimum?: number | undefined;
|
|
219
|
+
type?: string | string[] | undefined;
|
|
220
|
+
maximum?: number | undefined;
|
|
221
|
+
description?: string | undefined;
|
|
222
|
+
default?: any;
|
|
223
|
+
required?: boolean | undefined;
|
|
224
|
+
enum?: string[] | undefined;
|
|
225
|
+
format?: string | undefined;
|
|
226
|
+
examples?: any[] | undefined;
|
|
227
|
+
file?: any;
|
|
228
|
+
nullable?: boolean | undefined;
|
|
229
|
+
}[];
|
|
230
|
+
encoding: "form-data" | "urlencoded";
|
|
231
|
+
} | undefined;
|
|
232
|
+
raw?: {
|
|
233
|
+
value: string;
|
|
234
|
+
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
235
|
+
mimeType?: string | undefined;
|
|
236
|
+
} | undefined;
|
|
237
|
+
};
|
|
238
238
|
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
239
239
|
serverVariables?: Record<string, string[]> | undefined;
|
|
240
240
|
}>;
|
|
@@ -246,7 +246,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
246
246
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
247
247
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
248
248
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
249
|
-
method: "options" | "
|
|
249
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
250
250
|
description?: string | undefined;
|
|
251
251
|
summary?: string | undefined;
|
|
252
252
|
externalDocs?: {
|
|
@@ -259,6 +259,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
259
259
|
tags?: string[] | undefined;
|
|
260
260
|
deprecated?: boolean | undefined;
|
|
261
261
|
operationId?: string | undefined;
|
|
262
|
+
requestBody?: any;
|
|
262
263
|
parameters?: {
|
|
263
264
|
name: string;
|
|
264
265
|
required: boolean;
|
|
@@ -271,16 +272,13 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
271
272
|
summary?: string | undefined;
|
|
272
273
|
externalValue?: string | undefined;
|
|
273
274
|
}> | undefined;
|
|
275
|
+
schema?: unknown;
|
|
274
276
|
content?: unknown;
|
|
275
277
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
276
278
|
explode?: boolean | undefined;
|
|
277
|
-
schema?: unknown;
|
|
278
279
|
}[] | undefined;
|
|
279
|
-
requestBody?: any;
|
|
280
280
|
responses?: Record<string, any> | undefined;
|
|
281
281
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
282
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
283
|
-
'x-post-response'?: string | undefined;
|
|
284
282
|
'x-codeSamples'?: {
|
|
285
283
|
source: string;
|
|
286
284
|
label?: string | undefined;
|
|
@@ -296,6 +294,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
296
294
|
label?: string | undefined;
|
|
297
295
|
lang?: string | undefined;
|
|
298
296
|
}[] | undefined;
|
|
297
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
298
|
+
'x-post-response'?: string | undefined;
|
|
299
299
|
}>;
|
|
300
300
|
servers: Record<string, {
|
|
301
301
|
uid: string & import("zod").BRAND<"server">;
|
|
@@ -410,7 +410,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
410
410
|
proxyUrl: string | undefined;
|
|
411
411
|
hideClientButton: boolean;
|
|
412
412
|
showSidebar: boolean;
|
|
413
|
-
integration: "elysiajs" | "fastify" | "go" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "
|
|
413
|
+
integration: "elysiajs" | "fastify" | "go" | "rust" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "svelte" | "vue" | null | undefined;
|
|
414
414
|
importSpecFile: (_spec: string | Record<string, any> | undefined, workspaceUid: string, options?: Pick<{
|
|
415
415
|
uid?: string | undefined;
|
|
416
416
|
type?: "collection" | undefined;
|
|
@@ -1235,7 +1235,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1235
1235
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1236
1236
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1237
1237
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1238
|
-
method: "options" | "
|
|
1238
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1239
1239
|
description?: string | undefined;
|
|
1240
1240
|
summary?: string | undefined;
|
|
1241
1241
|
externalDocs?: {
|
|
@@ -1248,6 +1248,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1248
1248
|
tags?: string[] | undefined;
|
|
1249
1249
|
deprecated?: boolean | undefined;
|
|
1250
1250
|
operationId?: string | undefined;
|
|
1251
|
+
requestBody?: any;
|
|
1251
1252
|
parameters?: {
|
|
1252
1253
|
name: string;
|
|
1253
1254
|
required: boolean;
|
|
@@ -1260,16 +1261,13 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1260
1261
|
summary?: string | undefined;
|
|
1261
1262
|
externalValue?: string | undefined;
|
|
1262
1263
|
}> | undefined;
|
|
1264
|
+
schema?: unknown;
|
|
1263
1265
|
content?: unknown;
|
|
1264
1266
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1265
1267
|
explode?: boolean | undefined;
|
|
1266
|
-
schema?: unknown;
|
|
1267
1268
|
}[] | undefined;
|
|
1268
|
-
requestBody?: any;
|
|
1269
1269
|
responses?: Record<string, any> | undefined;
|
|
1270
1270
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1271
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1272
|
-
'x-post-response'?: string | undefined;
|
|
1273
1271
|
'x-codeSamples'?: {
|
|
1274
1272
|
source: string;
|
|
1275
1273
|
label?: string | undefined;
|
|
@@ -1285,6 +1283,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1285
1283
|
label?: string | undefined;
|
|
1286
1284
|
lang?: string | undefined;
|
|
1287
1285
|
}[] | undefined;
|
|
1286
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1287
|
+
'x-post-response'?: string | undefined;
|
|
1288
1288
|
}) => void;
|
|
1289
1289
|
add: (payload: import("@scalar/oas-utils/entities/spec").RequestPayload, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void | {
|
|
1290
1290
|
uid: string & import("zod").BRAND<"operation">;
|
|
@@ -1294,7 +1294,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1294
1294
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1295
1295
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1296
1296
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1297
|
-
method: "options" | "
|
|
1297
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1298
1298
|
description?: string | undefined;
|
|
1299
1299
|
summary?: string | undefined;
|
|
1300
1300
|
externalDocs?: {
|
|
@@ -1307,6 +1307,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1307
1307
|
tags?: string[] | undefined;
|
|
1308
1308
|
deprecated?: boolean | undefined;
|
|
1309
1309
|
operationId?: string | undefined;
|
|
1310
|
+
requestBody?: any;
|
|
1310
1311
|
parameters?: {
|
|
1311
1312
|
name: string;
|
|
1312
1313
|
required: boolean;
|
|
@@ -1319,16 +1320,13 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1319
1320
|
summary?: string | undefined;
|
|
1320
1321
|
externalValue?: string | undefined;
|
|
1321
1322
|
}> | undefined;
|
|
1323
|
+
schema?: unknown;
|
|
1322
1324
|
content?: unknown;
|
|
1323
1325
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1324
1326
|
explode?: boolean | undefined;
|
|
1325
|
-
schema?: unknown;
|
|
1326
1327
|
}[] | undefined;
|
|
1327
|
-
requestBody?: any;
|
|
1328
1328
|
responses?: Record<string, any> | undefined;
|
|
1329
1329
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1330
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1331
|
-
'x-post-response'?: string | undefined;
|
|
1332
1330
|
'x-codeSamples'?: {
|
|
1333
1331
|
source: string;
|
|
1334
1332
|
label?: string | undefined;
|
|
@@ -1344,6 +1342,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1344
1342
|
label?: string | undefined;
|
|
1345
1343
|
lang?: string | undefined;
|
|
1346
1344
|
}[] | undefined;
|
|
1345
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1346
|
+
'x-post-response'?: string | undefined;
|
|
1347
1347
|
};
|
|
1348
1348
|
delete: (request: import("@scalar/oas-utils/entities/spec").Request, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void;
|
|
1349
1349
|
set: (item: {
|
|
@@ -1354,7 +1354,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1354
1354
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1355
1355
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1356
1356
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1357
|
-
method: "options" | "
|
|
1357
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1358
1358
|
description?: string | undefined;
|
|
1359
1359
|
summary?: string | undefined;
|
|
1360
1360
|
externalDocs?: {
|
|
@@ -1367,6 +1367,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1367
1367
|
tags?: string[] | undefined;
|
|
1368
1368
|
deprecated?: boolean | undefined;
|
|
1369
1369
|
operationId?: string | undefined;
|
|
1370
|
+
requestBody?: any;
|
|
1370
1371
|
parameters?: {
|
|
1371
1372
|
name: string;
|
|
1372
1373
|
required: boolean;
|
|
@@ -1379,16 +1380,13 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1379
1380
|
summary?: string | undefined;
|
|
1380
1381
|
externalValue?: string | undefined;
|
|
1381
1382
|
}> | undefined;
|
|
1383
|
+
schema?: unknown;
|
|
1382
1384
|
content?: unknown;
|
|
1383
1385
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1384
1386
|
explode?: boolean | undefined;
|
|
1385
|
-
schema?: unknown;
|
|
1386
1387
|
}[] | undefined;
|
|
1387
|
-
requestBody?: any;
|
|
1388
1388
|
responses?: Record<string, any> | undefined;
|
|
1389
1389
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1390
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1391
|
-
'x-post-response'?: string | undefined;
|
|
1392
1390
|
'x-codeSamples'?: {
|
|
1393
1391
|
source: string;
|
|
1394
1392
|
label?: string | undefined;
|
|
@@ -1404,6 +1402,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1404
1402
|
label?: string | undefined;
|
|
1405
1403
|
lang?: string | undefined;
|
|
1406
1404
|
}[] | undefined;
|
|
1405
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1406
|
+
'x-post-response'?: string | undefined;
|
|
1407
1407
|
}) => void;
|
|
1408
1408
|
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" ? {
|
|
1409
1409
|
uid: string & import("zod").BRAND<"operation">;
|
|
@@ -1413,7 +1413,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1413
1413
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1414
1414
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1415
1415
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1416
|
-
method: "options" | "
|
|
1416
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1417
1417
|
description?: string | undefined;
|
|
1418
1418
|
summary?: string | undefined;
|
|
1419
1419
|
externalDocs?: {
|
|
@@ -1426,6 +1426,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1426
1426
|
tags?: string[] | undefined;
|
|
1427
1427
|
deprecated?: boolean | undefined;
|
|
1428
1428
|
operationId?: string | undefined;
|
|
1429
|
+
requestBody?: any;
|
|
1429
1430
|
parameters?: {
|
|
1430
1431
|
name: string;
|
|
1431
1432
|
required: boolean;
|
|
@@ -1438,16 +1439,13 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1438
1439
|
summary?: string | undefined;
|
|
1439
1440
|
externalValue?: string | undefined;
|
|
1440
1441
|
}> | undefined;
|
|
1442
|
+
schema?: unknown;
|
|
1441
1443
|
content?: unknown;
|
|
1442
1444
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1443
1445
|
explode?: boolean | undefined;
|
|
1444
|
-
schema?: unknown;
|
|
1445
1446
|
}[] | undefined;
|
|
1446
|
-
requestBody?: any;
|
|
1447
1447
|
responses?: Record<string, any> | undefined;
|
|
1448
1448
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1449
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1450
|
-
'x-post-response'?: string | undefined;
|
|
1451
1449
|
'x-codeSamples'?: {
|
|
1452
1450
|
source: string;
|
|
1453
1451
|
label?: string | undefined;
|
|
@@ -1463,6 +1461,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1463
1461
|
label?: string | undefined;
|
|
1464
1462
|
lang?: string | undefined;
|
|
1465
1463
|
}[] | undefined;
|
|
1464
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1465
|
+
'x-post-response'?: string | undefined;
|
|
1466
1466
|
}[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<{
|
|
1467
1467
|
uid: string & import("zod").BRAND<"operation">;
|
|
1468
1468
|
path: string;
|
|
@@ -1471,7 +1471,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1471
1471
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1472
1472
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1473
1473
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1474
|
-
method: "options" | "
|
|
1474
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1475
1475
|
description?: string | undefined;
|
|
1476
1476
|
summary?: string | undefined;
|
|
1477
1477
|
externalDocs?: {
|
|
@@ -1484,6 +1484,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1484
1484
|
tags?: string[] | undefined;
|
|
1485
1485
|
deprecated?: boolean | undefined;
|
|
1486
1486
|
operationId?: string | undefined;
|
|
1487
|
+
requestBody?: any;
|
|
1487
1488
|
parameters?: {
|
|
1488
1489
|
name: string;
|
|
1489
1490
|
required: boolean;
|
|
@@ -1496,16 +1497,13 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1496
1497
|
summary?: string | undefined;
|
|
1497
1498
|
externalValue?: string | undefined;
|
|
1498
1499
|
}> | undefined;
|
|
1500
|
+
schema?: unknown;
|
|
1499
1501
|
content?: unknown;
|
|
1500
1502
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1501
1503
|
explode?: boolean | undefined;
|
|
1502
|
-
schema?: unknown;
|
|
1503
1504
|
}[] | undefined;
|
|
1504
|
-
requestBody?: any;
|
|
1505
1505
|
responses?: Record<string, any> | undefined;
|
|
1506
1506
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1507
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1508
|
-
'x-post-response'?: string | undefined;
|
|
1509
1507
|
'x-codeSamples'?: {
|
|
1510
1508
|
source: string;
|
|
1511
1509
|
label?: string | undefined;
|
|
@@ -1521,6 +1519,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1521
1519
|
label?: string | undefined;
|
|
1522
1520
|
lang?: string | undefined;
|
|
1523
1521
|
}[] | undefined;
|
|
1522
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1523
|
+
'x-post-response'?: string | undefined;
|
|
1524
1524
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
1525
1525
|
uid: string & import("zod").BRAND<"operation">;
|
|
1526
1526
|
path: string;
|
|
@@ -1529,7 +1529,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1529
1529
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1530
1530
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1531
1531
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1532
|
-
method: "options" | "
|
|
1532
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1533
1533
|
description?: string | undefined;
|
|
1534
1534
|
summary?: string | undefined;
|
|
1535
1535
|
externalDocs?: {
|
|
@@ -1542,6 +1542,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1542
1542
|
tags?: string[] | undefined;
|
|
1543
1543
|
deprecated?: boolean | undefined;
|
|
1544
1544
|
operationId?: string | undefined;
|
|
1545
|
+
requestBody?: any;
|
|
1545
1546
|
parameters?: {
|
|
1546
1547
|
name: string;
|
|
1547
1548
|
required: boolean;
|
|
@@ -1554,16 +1555,13 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1554
1555
|
summary?: string | undefined;
|
|
1555
1556
|
externalValue?: string | undefined;
|
|
1556
1557
|
}> | undefined;
|
|
1558
|
+
schema?: unknown;
|
|
1557
1559
|
content?: unknown;
|
|
1558
1560
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1559
1561
|
explode?: boolean | undefined;
|
|
1560
|
-
schema?: unknown;
|
|
1561
1562
|
}[] | undefined;
|
|
1562
|
-
requestBody?: any;
|
|
1563
1563
|
responses?: Record<string, any> | undefined;
|
|
1564
1564
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1565
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1566
|
-
'x-post-response'?: string | undefined;
|
|
1567
1565
|
'x-codeSamples'?: {
|
|
1568
1566
|
source: string;
|
|
1569
1567
|
label?: string | undefined;
|
|
@@ -1579,6 +1577,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1579
1577
|
label?: string | undefined;
|
|
1580
1578
|
lang?: string | undefined;
|
|
1581
1579
|
}[] | undefined;
|
|
1580
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1581
|
+
'x-post-response'?: string | undefined;
|
|
1582
1582
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1583
1583
|
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" ? {
|
|
1584
1584
|
uid: string & import("zod").BRAND<"operation">;
|
|
@@ -1588,7 +1588,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1588
1588
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1589
1589
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1590
1590
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1591
|
-
method: "options" | "
|
|
1591
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1592
1592
|
description?: string | undefined;
|
|
1593
1593
|
summary?: string | undefined;
|
|
1594
1594
|
externalDocs?: {
|
|
@@ -1601,6 +1601,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1601
1601
|
tags?: string[] | undefined;
|
|
1602
1602
|
deprecated?: boolean | undefined;
|
|
1603
1603
|
operationId?: string | undefined;
|
|
1604
|
+
requestBody?: any;
|
|
1604
1605
|
parameters?: {
|
|
1605
1606
|
name: string;
|
|
1606
1607
|
required: boolean;
|
|
@@ -1613,16 +1614,13 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1613
1614
|
summary?: string | undefined;
|
|
1614
1615
|
externalValue?: string | undefined;
|
|
1615
1616
|
}> | undefined;
|
|
1617
|
+
schema?: unknown;
|
|
1616
1618
|
content?: unknown;
|
|
1617
1619
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1618
1620
|
explode?: boolean | undefined;
|
|
1619
|
-
schema?: unknown;
|
|
1620
1621
|
}[] | undefined;
|
|
1621
|
-
requestBody?: any;
|
|
1622
1622
|
responses?: Record<string, any> | undefined;
|
|
1623
1623
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1624
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1625
|
-
'x-post-response'?: string | undefined;
|
|
1626
1624
|
'x-codeSamples'?: {
|
|
1627
1625
|
source: string;
|
|
1628
1626
|
label?: string | undefined;
|
|
@@ -1638,6 +1636,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1638
1636
|
label?: string | undefined;
|
|
1639
1637
|
lang?: string | undefined;
|
|
1640
1638
|
}[] | undefined;
|
|
1639
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1640
|
+
'x-post-response'?: string | undefined;
|
|
1641
1641
|
}[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<{
|
|
1642
1642
|
uid: string & import("zod").BRAND<"operation">;
|
|
1643
1643
|
path: string;
|
|
@@ -1646,7 +1646,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1646
1646
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1647
1647
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1648
1648
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1649
|
-
method: "options" | "
|
|
1649
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1650
1650
|
description?: string | undefined;
|
|
1651
1651
|
summary?: string | undefined;
|
|
1652
1652
|
externalDocs?: {
|
|
@@ -1659,6 +1659,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1659
1659
|
tags?: string[] | undefined;
|
|
1660
1660
|
deprecated?: boolean | undefined;
|
|
1661
1661
|
operationId?: string | undefined;
|
|
1662
|
+
requestBody?: any;
|
|
1662
1663
|
parameters?: {
|
|
1663
1664
|
name: string;
|
|
1664
1665
|
required: boolean;
|
|
@@ -1671,16 +1672,13 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1671
1672
|
summary?: string | undefined;
|
|
1672
1673
|
externalValue?: string | undefined;
|
|
1673
1674
|
}> | undefined;
|
|
1675
|
+
schema?: unknown;
|
|
1674
1676
|
content?: unknown;
|
|
1675
1677
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1676
1678
|
explode?: boolean | undefined;
|
|
1677
|
-
schema?: unknown;
|
|
1678
1679
|
}[] | undefined;
|
|
1679
|
-
requestBody?: any;
|
|
1680
1680
|
responses?: Record<string, any> | undefined;
|
|
1681
1681
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1682
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1683
|
-
'x-post-response'?: string | undefined;
|
|
1684
1682
|
'x-codeSamples'?: {
|
|
1685
1683
|
source: string;
|
|
1686
1684
|
label?: string | undefined;
|
|
@@ -1696,6 +1694,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1696
1694
|
label?: string | undefined;
|
|
1697
1695
|
lang?: string | undefined;
|
|
1698
1696
|
}[] | undefined;
|
|
1697
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1698
|
+
'x-post-response'?: string | undefined;
|
|
1699
1699
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
1700
1700
|
uid: string & import("zod").BRAND<"operation">;
|
|
1701
1701
|
path: string;
|
|
@@ -1704,7 +1704,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1704
1704
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
1705
1705
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
1706
1706
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
1707
|
-
method: "options" | "
|
|
1707
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
1708
1708
|
description?: string | undefined;
|
|
1709
1709
|
summary?: string | undefined;
|
|
1710
1710
|
externalDocs?: {
|
|
@@ -1717,6 +1717,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1717
1717
|
tags?: string[] | undefined;
|
|
1718
1718
|
deprecated?: boolean | undefined;
|
|
1719
1719
|
operationId?: string | undefined;
|
|
1720
|
+
requestBody?: any;
|
|
1720
1721
|
parameters?: {
|
|
1721
1722
|
name: string;
|
|
1722
1723
|
required: boolean;
|
|
@@ -1729,16 +1730,13 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1729
1730
|
summary?: string | undefined;
|
|
1730
1731
|
externalValue?: string | undefined;
|
|
1731
1732
|
}> | undefined;
|
|
1733
|
+
schema?: unknown;
|
|
1732
1734
|
content?: unknown;
|
|
1733
1735
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
1734
1736
|
explode?: boolean | undefined;
|
|
1735
|
-
schema?: unknown;
|
|
1736
1737
|
}[] | undefined;
|
|
1737
|
-
requestBody?: any;
|
|
1738
1738
|
responses?: Record<string, any> | undefined;
|
|
1739
1739
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
1740
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1741
|
-
'x-post-response'?: string | undefined;
|
|
1742
1740
|
'x-codeSamples'?: {
|
|
1743
1741
|
source: string;
|
|
1744
1742
|
label?: string | undefined;
|
|
@@ -1754,6 +1752,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1754
1752
|
label?: string | undefined;
|
|
1755
1753
|
lang?: string | undefined;
|
|
1756
1754
|
}[] | undefined;
|
|
1755
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1756
|
+
'x-post-response'?: string | undefined;
|
|
1757
1757
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1758
1758
|
undo: (uid: string & import("zod").BRAND<"operation">) => void;
|
|
1759
1759
|
redo: (uid: string & import("zod").BRAND<"operation">) => void;
|
|
@@ -1765,34 +1765,6 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1765
1765
|
uid: string & import("zod").BRAND<"example">;
|
|
1766
1766
|
name: string;
|
|
1767
1767
|
type: "requestExample";
|
|
1768
|
-
body: {
|
|
1769
|
-
activeBody: "binary" | "formData" | "raw";
|
|
1770
|
-
binary?: Blob | undefined;
|
|
1771
|
-
formData?: {
|
|
1772
|
-
value: {
|
|
1773
|
-
value: string;
|
|
1774
|
-
key: string;
|
|
1775
|
-
enabled: boolean;
|
|
1776
|
-
minimum?: number | undefined;
|
|
1777
|
-
type?: string | string[] | undefined;
|
|
1778
|
-
maximum?: number | undefined;
|
|
1779
|
-
description?: string | undefined;
|
|
1780
|
-
default?: any;
|
|
1781
|
-
required?: boolean | undefined;
|
|
1782
|
-
enum?: string[] | undefined;
|
|
1783
|
-
format?: string | undefined;
|
|
1784
|
-
examples?: any[] | undefined;
|
|
1785
|
-
file?: any;
|
|
1786
|
-
nullable?: boolean | undefined;
|
|
1787
|
-
}[];
|
|
1788
|
-
encoding: "form-data" | "urlencoded";
|
|
1789
|
-
} | undefined;
|
|
1790
|
-
raw?: {
|
|
1791
|
-
value: string;
|
|
1792
|
-
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
1793
|
-
mimeType?: string | undefined;
|
|
1794
|
-
} | undefined;
|
|
1795
|
-
};
|
|
1796
1768
|
parameters: {
|
|
1797
1769
|
path: {
|
|
1798
1770
|
value: string;
|
|
@@ -1859,13 +1831,6 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1859
1831
|
nullable?: boolean | undefined;
|
|
1860
1832
|
}[];
|
|
1861
1833
|
};
|
|
1862
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
1863
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1864
|
-
}) => void;
|
|
1865
|
-
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
1866
|
-
uid: string & import("zod").BRAND<"example">;
|
|
1867
|
-
name: string;
|
|
1868
|
-
type: "requestExample";
|
|
1869
1834
|
body: {
|
|
1870
1835
|
activeBody: "binary" | "formData" | "raw";
|
|
1871
1836
|
binary?: Blob | undefined;
|
|
@@ -1894,6 +1859,13 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1894
1859
|
mimeType?: string | undefined;
|
|
1895
1860
|
} | undefined;
|
|
1896
1861
|
};
|
|
1862
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
1863
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1864
|
+
}) => void;
|
|
1865
|
+
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
1866
|
+
uid: string & import("zod").BRAND<"example">;
|
|
1867
|
+
name: string;
|
|
1868
|
+
type: "requestExample";
|
|
1897
1869
|
parameters: {
|
|
1898
1870
|
path: {
|
|
1899
1871
|
value: string;
|
|
@@ -1960,14 +1932,6 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1960
1932
|
nullable?: boolean | undefined;
|
|
1961
1933
|
}[];
|
|
1962
1934
|
};
|
|
1963
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
1964
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1965
|
-
};
|
|
1966
|
-
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
1967
|
-
set: (item: {
|
|
1968
|
-
uid: string & import("zod").BRAND<"example">;
|
|
1969
|
-
name: string;
|
|
1970
|
-
type: "requestExample";
|
|
1971
1935
|
body: {
|
|
1972
1936
|
activeBody: "binary" | "formData" | "raw";
|
|
1973
1937
|
binary?: Blob | undefined;
|
|
@@ -1996,6 +1960,14 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1996
1960
|
mimeType?: string | undefined;
|
|
1997
1961
|
} | undefined;
|
|
1998
1962
|
};
|
|
1963
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
1964
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1965
|
+
};
|
|
1966
|
+
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
1967
|
+
set: (item: {
|
|
1968
|
+
uid: string & import("zod").BRAND<"example">;
|
|
1969
|
+
name: string;
|
|
1970
|
+
type: "requestExample";
|
|
1999
1971
|
parameters: {
|
|
2000
1972
|
path: {
|
|
2001
1973
|
value: string;
|
|
@@ -2062,13 +2034,6 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2062
2034
|
nullable?: boolean | undefined;
|
|
2063
2035
|
}[];
|
|
2064
2036
|
};
|
|
2065
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2066
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2067
|
-
}) => void;
|
|
2068
|
-
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" ? {
|
|
2069
|
-
uid: string & import("zod").BRAND<"example">;
|
|
2070
|
-
name: string;
|
|
2071
|
-
type: "requestExample";
|
|
2072
2037
|
body: {
|
|
2073
2038
|
activeBody: "binary" | "formData" | "raw";
|
|
2074
2039
|
binary?: Blob | undefined;
|
|
@@ -2097,6 +2062,13 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2097
2062
|
mimeType?: string | undefined;
|
|
2098
2063
|
} | undefined;
|
|
2099
2064
|
};
|
|
2065
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2066
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2067
|
+
}) => void;
|
|
2068
|
+
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" ? {
|
|
2069
|
+
uid: string & import("zod").BRAND<"example">;
|
|
2070
|
+
name: string;
|
|
2071
|
+
type: "requestExample";
|
|
2100
2072
|
parameters: {
|
|
2101
2073
|
path: {
|
|
2102
2074
|
value: string;
|
|
@@ -2163,12 +2135,6 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2163
2135
|
nullable?: boolean | undefined;
|
|
2164
2136
|
}[];
|
|
2165
2137
|
};
|
|
2166
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2167
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2168
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2169
|
-
uid: string & import("zod").BRAND<"example">;
|
|
2170
|
-
name: string;
|
|
2171
|
-
type: "requestExample";
|
|
2172
2138
|
body: {
|
|
2173
2139
|
activeBody: "binary" | "formData" | "raw";
|
|
2174
2140
|
binary?: Blob | undefined;
|
|
@@ -2197,6 +2163,12 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2197
2163
|
mimeType?: string | undefined;
|
|
2198
2164
|
} | undefined;
|
|
2199
2165
|
};
|
|
2166
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2167
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2168
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2169
|
+
uid: string & import("zod").BRAND<"example">;
|
|
2170
|
+
name: string;
|
|
2171
|
+
type: "requestExample";
|
|
2200
2172
|
parameters: {
|
|
2201
2173
|
path: {
|
|
2202
2174
|
value: string;
|
|
@@ -2263,12 +2235,6 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2263
2235
|
nullable?: boolean | undefined;
|
|
2264
2236
|
}[];
|
|
2265
2237
|
};
|
|
2266
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2267
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2268
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2269
|
-
uid: string & import("zod").BRAND<"example">;
|
|
2270
|
-
name: string;
|
|
2271
|
-
type: "requestExample";
|
|
2272
2238
|
body: {
|
|
2273
2239
|
activeBody: "binary" | "formData" | "raw";
|
|
2274
2240
|
binary?: Blob | undefined;
|
|
@@ -2297,6 +2263,12 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2297
2263
|
mimeType?: string | undefined;
|
|
2298
2264
|
} | undefined;
|
|
2299
2265
|
};
|
|
2266
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2267
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2268
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2269
|
+
uid: string & import("zod").BRAND<"example">;
|
|
2270
|
+
name: string;
|
|
2271
|
+
type: "requestExample";
|
|
2300
2272
|
parameters: {
|
|
2301
2273
|
path: {
|
|
2302
2274
|
value: string;
|
|
@@ -2363,13 +2335,6 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2363
2335
|
nullable?: boolean | undefined;
|
|
2364
2336
|
}[];
|
|
2365
2337
|
};
|
|
2366
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2367
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2368
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2369
|
-
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" ? {
|
|
2370
|
-
uid: string & import("zod").BRAND<"example">;
|
|
2371
|
-
name: string;
|
|
2372
|
-
type: "requestExample";
|
|
2373
2338
|
body: {
|
|
2374
2339
|
activeBody: "binary" | "formData" | "raw";
|
|
2375
2340
|
binary?: Blob | undefined;
|
|
@@ -2398,6 +2363,13 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2398
2363
|
mimeType?: string | undefined;
|
|
2399
2364
|
} | undefined;
|
|
2400
2365
|
};
|
|
2366
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2367
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2368
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2369
|
+
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" ? {
|
|
2370
|
+
uid: string & import("zod").BRAND<"example">;
|
|
2371
|
+
name: string;
|
|
2372
|
+
type: "requestExample";
|
|
2401
2373
|
parameters: {
|
|
2402
2374
|
path: {
|
|
2403
2375
|
value: string;
|
|
@@ -2464,12 +2436,6 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2464
2436
|
nullable?: boolean | undefined;
|
|
2465
2437
|
}[];
|
|
2466
2438
|
};
|
|
2467
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2468
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2469
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2470
|
-
uid: string & import("zod").BRAND<"example">;
|
|
2471
|
-
name: string;
|
|
2472
|
-
type: "requestExample";
|
|
2473
2439
|
body: {
|
|
2474
2440
|
activeBody: "binary" | "formData" | "raw";
|
|
2475
2441
|
binary?: Blob | undefined;
|
|
@@ -2498,6 +2464,12 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2498
2464
|
mimeType?: string | undefined;
|
|
2499
2465
|
} | undefined;
|
|
2500
2466
|
};
|
|
2467
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2468
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2469
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2470
|
+
uid: string & import("zod").BRAND<"example">;
|
|
2471
|
+
name: string;
|
|
2472
|
+
type: "requestExample";
|
|
2501
2473
|
parameters: {
|
|
2502
2474
|
path: {
|
|
2503
2475
|
value: string;
|
|
@@ -2564,12 +2536,6 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2564
2536
|
nullable?: boolean | undefined;
|
|
2565
2537
|
}[];
|
|
2566
2538
|
};
|
|
2567
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2568
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2569
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2570
|
-
uid: string & import("zod").BRAND<"example">;
|
|
2571
|
-
name: string;
|
|
2572
|
-
type: "requestExample";
|
|
2573
2539
|
body: {
|
|
2574
2540
|
activeBody: "binary" | "formData" | "raw";
|
|
2575
2541
|
binary?: Blob | undefined;
|
|
@@ -2598,6 +2564,12 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2598
2564
|
mimeType?: string | undefined;
|
|
2599
2565
|
} | undefined;
|
|
2600
2566
|
};
|
|
2567
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2568
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2569
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2570
|
+
uid: string & import("zod").BRAND<"example">;
|
|
2571
|
+
name: string;
|
|
2572
|
+
type: "requestExample";
|
|
2601
2573
|
parameters: {
|
|
2602
2574
|
path: {
|
|
2603
2575
|
value: string;
|
|
@@ -2664,6 +2636,34 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2664
2636
|
nullable?: boolean | undefined;
|
|
2665
2637
|
}[];
|
|
2666
2638
|
};
|
|
2639
|
+
body: {
|
|
2640
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2641
|
+
binary?: Blob | undefined;
|
|
2642
|
+
formData?: {
|
|
2643
|
+
value: {
|
|
2644
|
+
value: string;
|
|
2645
|
+
key: string;
|
|
2646
|
+
enabled: boolean;
|
|
2647
|
+
minimum?: number | undefined;
|
|
2648
|
+
type?: string | string[] | undefined;
|
|
2649
|
+
maximum?: number | undefined;
|
|
2650
|
+
description?: string | undefined;
|
|
2651
|
+
default?: any;
|
|
2652
|
+
required?: boolean | undefined;
|
|
2653
|
+
enum?: string[] | undefined;
|
|
2654
|
+
format?: string | undefined;
|
|
2655
|
+
examples?: any[] | undefined;
|
|
2656
|
+
file?: any;
|
|
2657
|
+
nullable?: boolean | undefined;
|
|
2658
|
+
}[];
|
|
2659
|
+
encoding: "form-data" | "urlencoded";
|
|
2660
|
+
} | undefined;
|
|
2661
|
+
raw?: {
|
|
2662
|
+
value: string;
|
|
2663
|
+
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
2664
|
+
mimeType?: string | undefined;
|
|
2665
|
+
} | undefined;
|
|
2666
|
+
};
|
|
2667
2667
|
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
2668
2668
|
serverVariables?: Record<string, string[]> | undefined;
|
|
2669
2669
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
@@ -4006,34 +4006,6 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4006
4006
|
uid: string & import("zod").BRAND<"example">;
|
|
4007
4007
|
name: string;
|
|
4008
4008
|
type: "requestExample";
|
|
4009
|
-
body: {
|
|
4010
|
-
activeBody: "binary" | "formData" | "raw";
|
|
4011
|
-
binary?: Blob | undefined;
|
|
4012
|
-
formData?: {
|
|
4013
|
-
value: {
|
|
4014
|
-
value: string;
|
|
4015
|
-
key: string;
|
|
4016
|
-
enabled: boolean;
|
|
4017
|
-
minimum?: number | undefined;
|
|
4018
|
-
type?: string | string[] | undefined;
|
|
4019
|
-
maximum?: number | undefined;
|
|
4020
|
-
description?: string | undefined;
|
|
4021
|
-
default?: any;
|
|
4022
|
-
required?: boolean | undefined;
|
|
4023
|
-
enum?: string[] | undefined;
|
|
4024
|
-
format?: string | undefined;
|
|
4025
|
-
examples?: any[] | undefined;
|
|
4026
|
-
file?: any;
|
|
4027
|
-
nullable?: boolean | undefined;
|
|
4028
|
-
}[];
|
|
4029
|
-
encoding: "form-data" | "urlencoded";
|
|
4030
|
-
} | undefined;
|
|
4031
|
-
raw?: {
|
|
4032
|
-
value: string;
|
|
4033
|
-
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
4034
|
-
mimeType?: string | undefined;
|
|
4035
|
-
} | undefined;
|
|
4036
|
-
};
|
|
4037
4009
|
parameters: {
|
|
4038
4010
|
path: {
|
|
4039
4011
|
value: string;
|
|
@@ -4100,6 +4072,34 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4100
4072
|
nullable?: boolean | undefined;
|
|
4101
4073
|
}[];
|
|
4102
4074
|
};
|
|
4075
|
+
body: {
|
|
4076
|
+
activeBody: "binary" | "formData" | "raw";
|
|
4077
|
+
binary?: Blob | undefined;
|
|
4078
|
+
formData?: {
|
|
4079
|
+
value: {
|
|
4080
|
+
value: string;
|
|
4081
|
+
key: string;
|
|
4082
|
+
enabled: boolean;
|
|
4083
|
+
minimum?: number | undefined;
|
|
4084
|
+
type?: string | string[] | undefined;
|
|
4085
|
+
maximum?: number | undefined;
|
|
4086
|
+
description?: string | undefined;
|
|
4087
|
+
default?: any;
|
|
4088
|
+
required?: boolean | undefined;
|
|
4089
|
+
enum?: string[] | undefined;
|
|
4090
|
+
format?: string | undefined;
|
|
4091
|
+
examples?: any[] | undefined;
|
|
4092
|
+
file?: any;
|
|
4093
|
+
nullable?: boolean | undefined;
|
|
4094
|
+
}[];
|
|
4095
|
+
encoding: "form-data" | "urlencoded";
|
|
4096
|
+
} | undefined;
|
|
4097
|
+
raw?: {
|
|
4098
|
+
value: string;
|
|
4099
|
+
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
4100
|
+
mimeType?: string | undefined;
|
|
4101
|
+
} | undefined;
|
|
4102
|
+
};
|
|
4103
4103
|
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
4104
4104
|
serverVariables?: Record<string, string[]> | undefined;
|
|
4105
4105
|
}>;
|
|
@@ -4111,7 +4111,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4111
4111
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
4112
4112
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
4113
4113
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
4114
|
-
method: "options" | "
|
|
4114
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
4115
4115
|
description?: string | undefined;
|
|
4116
4116
|
summary?: string | undefined;
|
|
4117
4117
|
externalDocs?: {
|
|
@@ -4124,6 +4124,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4124
4124
|
tags?: string[] | undefined;
|
|
4125
4125
|
deprecated?: boolean | undefined;
|
|
4126
4126
|
operationId?: string | undefined;
|
|
4127
|
+
requestBody?: any;
|
|
4127
4128
|
parameters?: {
|
|
4128
4129
|
name: string;
|
|
4129
4130
|
required: boolean;
|
|
@@ -4136,16 +4137,13 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4136
4137
|
summary?: string | undefined;
|
|
4137
4138
|
externalValue?: string | undefined;
|
|
4138
4139
|
}> | undefined;
|
|
4140
|
+
schema?: unknown;
|
|
4139
4141
|
content?: unknown;
|
|
4140
4142
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
4141
4143
|
explode?: boolean | undefined;
|
|
4142
|
-
schema?: unknown;
|
|
4143
4144
|
}[] | undefined;
|
|
4144
|
-
requestBody?: any;
|
|
4145
4145
|
responses?: Record<string, any> | undefined;
|
|
4146
4146
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
4147
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
4148
|
-
'x-post-response'?: string | undefined;
|
|
4149
4147
|
'x-codeSamples'?: {
|
|
4150
4148
|
source: string;
|
|
4151
4149
|
label?: string | undefined;
|
|
@@ -4161,6 +4159,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4161
4159
|
label?: string | undefined;
|
|
4162
4160
|
lang?: string | undefined;
|
|
4163
4161
|
}[] | undefined;
|
|
4162
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
4163
|
+
'x-post-response'?: string | undefined;
|
|
4164
4164
|
}>;
|
|
4165
4165
|
servers: Record<string, {
|
|
4166
4166
|
uid: string & import("zod").BRAND<"server">;
|
|
@@ -4275,7 +4275,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4275
4275
|
proxyUrl: string | undefined;
|
|
4276
4276
|
hideClientButton: boolean;
|
|
4277
4277
|
showSidebar: boolean;
|
|
4278
|
-
integration: "elysiajs" | "fastify" | "go" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "
|
|
4278
|
+
integration: "elysiajs" | "fastify" | "go" | "rust" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "svelte" | "vue" | null | undefined;
|
|
4279
4279
|
importSpecFile: (_spec: string | Record<string, any> | undefined, workspaceUid: string, options?: Pick<{
|
|
4280
4280
|
uid?: string | undefined;
|
|
4281
4281
|
type?: "collection" | undefined;
|
|
@@ -5100,7 +5100,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5100
5100
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
5101
5101
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
5102
5102
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
5103
|
-
method: "options" | "
|
|
5103
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
5104
5104
|
description?: string | undefined;
|
|
5105
5105
|
summary?: string | undefined;
|
|
5106
5106
|
externalDocs?: {
|
|
@@ -5113,6 +5113,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5113
5113
|
tags?: string[] | undefined;
|
|
5114
5114
|
deprecated?: boolean | undefined;
|
|
5115
5115
|
operationId?: string | undefined;
|
|
5116
|
+
requestBody?: any;
|
|
5116
5117
|
parameters?: {
|
|
5117
5118
|
name: string;
|
|
5118
5119
|
required: boolean;
|
|
@@ -5125,16 +5126,13 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5125
5126
|
summary?: string | undefined;
|
|
5126
5127
|
externalValue?: string | undefined;
|
|
5127
5128
|
}> | undefined;
|
|
5129
|
+
schema?: unknown;
|
|
5128
5130
|
content?: unknown;
|
|
5129
5131
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
5130
5132
|
explode?: boolean | undefined;
|
|
5131
|
-
schema?: unknown;
|
|
5132
5133
|
}[] | undefined;
|
|
5133
|
-
requestBody?: any;
|
|
5134
5134
|
responses?: Record<string, any> | undefined;
|
|
5135
5135
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
5136
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5137
|
-
'x-post-response'?: string | undefined;
|
|
5138
5136
|
'x-codeSamples'?: {
|
|
5139
5137
|
source: string;
|
|
5140
5138
|
label?: string | undefined;
|
|
@@ -5150,6 +5148,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5150
5148
|
label?: string | undefined;
|
|
5151
5149
|
lang?: string | undefined;
|
|
5152
5150
|
}[] | undefined;
|
|
5151
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5152
|
+
'x-post-response'?: string | undefined;
|
|
5153
5153
|
}) => void;
|
|
5154
5154
|
add: (payload: import("@scalar/oas-utils/entities/spec").RequestPayload, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void | {
|
|
5155
5155
|
uid: string & import("zod").BRAND<"operation">;
|
|
@@ -5159,7 +5159,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5159
5159
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
5160
5160
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
5161
5161
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
5162
|
-
method: "options" | "
|
|
5162
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
5163
5163
|
description?: string | undefined;
|
|
5164
5164
|
summary?: string | undefined;
|
|
5165
5165
|
externalDocs?: {
|
|
@@ -5172,6 +5172,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5172
5172
|
tags?: string[] | undefined;
|
|
5173
5173
|
deprecated?: boolean | undefined;
|
|
5174
5174
|
operationId?: string | undefined;
|
|
5175
|
+
requestBody?: any;
|
|
5175
5176
|
parameters?: {
|
|
5176
5177
|
name: string;
|
|
5177
5178
|
required: boolean;
|
|
@@ -5184,16 +5185,13 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5184
5185
|
summary?: string | undefined;
|
|
5185
5186
|
externalValue?: string | undefined;
|
|
5186
5187
|
}> | undefined;
|
|
5188
|
+
schema?: unknown;
|
|
5187
5189
|
content?: unknown;
|
|
5188
5190
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
5189
5191
|
explode?: boolean | undefined;
|
|
5190
|
-
schema?: unknown;
|
|
5191
5192
|
}[] | undefined;
|
|
5192
|
-
requestBody?: any;
|
|
5193
5193
|
responses?: Record<string, any> | undefined;
|
|
5194
5194
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
5195
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5196
|
-
'x-post-response'?: string | undefined;
|
|
5197
5195
|
'x-codeSamples'?: {
|
|
5198
5196
|
source: string;
|
|
5199
5197
|
label?: string | undefined;
|
|
@@ -5209,6 +5207,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5209
5207
|
label?: string | undefined;
|
|
5210
5208
|
lang?: string | undefined;
|
|
5211
5209
|
}[] | undefined;
|
|
5210
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5211
|
+
'x-post-response'?: string | undefined;
|
|
5212
5212
|
};
|
|
5213
5213
|
delete: (request: import("@scalar/oas-utils/entities/spec").Request, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void;
|
|
5214
5214
|
set: (item: {
|
|
@@ -5219,7 +5219,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5219
5219
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
5220
5220
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
5221
5221
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
5222
|
-
method: "options" | "
|
|
5222
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
5223
5223
|
description?: string | undefined;
|
|
5224
5224
|
summary?: string | undefined;
|
|
5225
5225
|
externalDocs?: {
|
|
@@ -5232,6 +5232,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5232
5232
|
tags?: string[] | undefined;
|
|
5233
5233
|
deprecated?: boolean | undefined;
|
|
5234
5234
|
operationId?: string | undefined;
|
|
5235
|
+
requestBody?: any;
|
|
5235
5236
|
parameters?: {
|
|
5236
5237
|
name: string;
|
|
5237
5238
|
required: boolean;
|
|
@@ -5244,16 +5245,13 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5244
5245
|
summary?: string | undefined;
|
|
5245
5246
|
externalValue?: string | undefined;
|
|
5246
5247
|
}> | undefined;
|
|
5248
|
+
schema?: unknown;
|
|
5247
5249
|
content?: unknown;
|
|
5248
5250
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
5249
5251
|
explode?: boolean | undefined;
|
|
5250
|
-
schema?: unknown;
|
|
5251
5252
|
}[] | undefined;
|
|
5252
|
-
requestBody?: any;
|
|
5253
5253
|
responses?: Record<string, any> | undefined;
|
|
5254
5254
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
5255
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5256
|
-
'x-post-response'?: string | undefined;
|
|
5257
5255
|
'x-codeSamples'?: {
|
|
5258
5256
|
source: string;
|
|
5259
5257
|
label?: string | undefined;
|
|
@@ -5269,6 +5267,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5269
5267
|
label?: string | undefined;
|
|
5270
5268
|
lang?: string | undefined;
|
|
5271
5269
|
}[] | undefined;
|
|
5270
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5271
|
+
'x-post-response'?: string | undefined;
|
|
5272
5272
|
}) => void;
|
|
5273
5273
|
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" ? {
|
|
5274
5274
|
uid: string & import("zod").BRAND<"operation">;
|
|
@@ -5278,7 +5278,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5278
5278
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
5279
5279
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
5280
5280
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
5281
|
-
method: "options" | "
|
|
5281
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
5282
5282
|
description?: string | undefined;
|
|
5283
5283
|
summary?: string | undefined;
|
|
5284
5284
|
externalDocs?: {
|
|
@@ -5291,6 +5291,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5291
5291
|
tags?: string[] | undefined;
|
|
5292
5292
|
deprecated?: boolean | undefined;
|
|
5293
5293
|
operationId?: string | undefined;
|
|
5294
|
+
requestBody?: any;
|
|
5294
5295
|
parameters?: {
|
|
5295
5296
|
name: string;
|
|
5296
5297
|
required: boolean;
|
|
@@ -5303,16 +5304,13 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5303
5304
|
summary?: string | undefined;
|
|
5304
5305
|
externalValue?: string | undefined;
|
|
5305
5306
|
}> | undefined;
|
|
5307
|
+
schema?: unknown;
|
|
5306
5308
|
content?: unknown;
|
|
5307
5309
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
5308
5310
|
explode?: boolean | undefined;
|
|
5309
|
-
schema?: unknown;
|
|
5310
5311
|
}[] | undefined;
|
|
5311
|
-
requestBody?: any;
|
|
5312
5312
|
responses?: Record<string, any> | undefined;
|
|
5313
5313
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
5314
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5315
|
-
'x-post-response'?: string | undefined;
|
|
5316
5314
|
'x-codeSamples'?: {
|
|
5317
5315
|
source: string;
|
|
5318
5316
|
label?: string | undefined;
|
|
@@ -5328,6 +5326,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5328
5326
|
label?: string | undefined;
|
|
5329
5327
|
lang?: string | undefined;
|
|
5330
5328
|
}[] | undefined;
|
|
5329
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5330
|
+
'x-post-response'?: string | undefined;
|
|
5331
5331
|
}[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<{
|
|
5332
5332
|
uid: string & import("zod").BRAND<"operation">;
|
|
5333
5333
|
path: string;
|
|
@@ -5336,7 +5336,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5336
5336
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
5337
5337
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
5338
5338
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
5339
|
-
method: "options" | "
|
|
5339
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
5340
5340
|
description?: string | undefined;
|
|
5341
5341
|
summary?: string | undefined;
|
|
5342
5342
|
externalDocs?: {
|
|
@@ -5349,6 +5349,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5349
5349
|
tags?: string[] | undefined;
|
|
5350
5350
|
deprecated?: boolean | undefined;
|
|
5351
5351
|
operationId?: string | undefined;
|
|
5352
|
+
requestBody?: any;
|
|
5352
5353
|
parameters?: {
|
|
5353
5354
|
name: string;
|
|
5354
5355
|
required: boolean;
|
|
@@ -5361,16 +5362,13 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5361
5362
|
summary?: string | undefined;
|
|
5362
5363
|
externalValue?: string | undefined;
|
|
5363
5364
|
}> | undefined;
|
|
5365
|
+
schema?: unknown;
|
|
5364
5366
|
content?: unknown;
|
|
5365
5367
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
5366
5368
|
explode?: boolean | undefined;
|
|
5367
|
-
schema?: unknown;
|
|
5368
5369
|
}[] | undefined;
|
|
5369
|
-
requestBody?: any;
|
|
5370
5370
|
responses?: Record<string, any> | undefined;
|
|
5371
5371
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
5372
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5373
|
-
'x-post-response'?: string | undefined;
|
|
5374
5372
|
'x-codeSamples'?: {
|
|
5375
5373
|
source: string;
|
|
5376
5374
|
label?: string | undefined;
|
|
@@ -5386,6 +5384,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5386
5384
|
label?: string | undefined;
|
|
5387
5385
|
lang?: string | undefined;
|
|
5388
5386
|
}[] | undefined;
|
|
5387
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5388
|
+
'x-post-response'?: string | undefined;
|
|
5389
5389
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
5390
5390
|
uid: string & import("zod").BRAND<"operation">;
|
|
5391
5391
|
path: string;
|
|
@@ -5394,7 +5394,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5394
5394
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
5395
5395
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
5396
5396
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
5397
|
-
method: "options" | "
|
|
5397
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
5398
5398
|
description?: string | undefined;
|
|
5399
5399
|
summary?: string | undefined;
|
|
5400
5400
|
externalDocs?: {
|
|
@@ -5407,6 +5407,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5407
5407
|
tags?: string[] | undefined;
|
|
5408
5408
|
deprecated?: boolean | undefined;
|
|
5409
5409
|
operationId?: string | undefined;
|
|
5410
|
+
requestBody?: any;
|
|
5410
5411
|
parameters?: {
|
|
5411
5412
|
name: string;
|
|
5412
5413
|
required: boolean;
|
|
@@ -5419,16 +5420,13 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5419
5420
|
summary?: string | undefined;
|
|
5420
5421
|
externalValue?: string | undefined;
|
|
5421
5422
|
}> | undefined;
|
|
5423
|
+
schema?: unknown;
|
|
5422
5424
|
content?: unknown;
|
|
5423
5425
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
5424
5426
|
explode?: boolean | undefined;
|
|
5425
|
-
schema?: unknown;
|
|
5426
5427
|
}[] | undefined;
|
|
5427
|
-
requestBody?: any;
|
|
5428
5428
|
responses?: Record<string, any> | undefined;
|
|
5429
5429
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
5430
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5431
|
-
'x-post-response'?: string | undefined;
|
|
5432
5430
|
'x-codeSamples'?: {
|
|
5433
5431
|
source: string;
|
|
5434
5432
|
label?: string | undefined;
|
|
@@ -5444,6 +5442,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5444
5442
|
label?: string | undefined;
|
|
5445
5443
|
lang?: string | undefined;
|
|
5446
5444
|
}[] | undefined;
|
|
5445
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5446
|
+
'x-post-response'?: string | undefined;
|
|
5447
5447
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
5448
5448
|
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" ? {
|
|
5449
5449
|
uid: string & import("zod").BRAND<"operation">;
|
|
@@ -5453,7 +5453,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5453
5453
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
5454
5454
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
5455
5455
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
5456
|
-
method: "options" | "
|
|
5456
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
5457
5457
|
description?: string | undefined;
|
|
5458
5458
|
summary?: string | undefined;
|
|
5459
5459
|
externalDocs?: {
|
|
@@ -5466,6 +5466,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5466
5466
|
tags?: string[] | undefined;
|
|
5467
5467
|
deprecated?: boolean | undefined;
|
|
5468
5468
|
operationId?: string | undefined;
|
|
5469
|
+
requestBody?: any;
|
|
5469
5470
|
parameters?: {
|
|
5470
5471
|
name: string;
|
|
5471
5472
|
required: boolean;
|
|
@@ -5478,16 +5479,13 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5478
5479
|
summary?: string | undefined;
|
|
5479
5480
|
externalValue?: string | undefined;
|
|
5480
5481
|
}> | undefined;
|
|
5482
|
+
schema?: unknown;
|
|
5481
5483
|
content?: unknown;
|
|
5482
5484
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
5483
5485
|
explode?: boolean | undefined;
|
|
5484
|
-
schema?: unknown;
|
|
5485
5486
|
}[] | undefined;
|
|
5486
|
-
requestBody?: any;
|
|
5487
5487
|
responses?: Record<string, any> | undefined;
|
|
5488
5488
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
5489
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5490
|
-
'x-post-response'?: string | undefined;
|
|
5491
5489
|
'x-codeSamples'?: {
|
|
5492
5490
|
source: string;
|
|
5493
5491
|
label?: string | undefined;
|
|
@@ -5503,6 +5501,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5503
5501
|
label?: string | undefined;
|
|
5504
5502
|
lang?: string | undefined;
|
|
5505
5503
|
}[] | undefined;
|
|
5504
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5505
|
+
'x-post-response'?: string | undefined;
|
|
5506
5506
|
}[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<{
|
|
5507
5507
|
uid: string & import("zod").BRAND<"operation">;
|
|
5508
5508
|
path: string;
|
|
@@ -5511,7 +5511,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5511
5511
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
5512
5512
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
5513
5513
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
5514
|
-
method: "options" | "
|
|
5514
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
5515
5515
|
description?: string | undefined;
|
|
5516
5516
|
summary?: string | undefined;
|
|
5517
5517
|
externalDocs?: {
|
|
@@ -5524,6 +5524,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5524
5524
|
tags?: string[] | undefined;
|
|
5525
5525
|
deprecated?: boolean | undefined;
|
|
5526
5526
|
operationId?: string | undefined;
|
|
5527
|
+
requestBody?: any;
|
|
5527
5528
|
parameters?: {
|
|
5528
5529
|
name: string;
|
|
5529
5530
|
required: boolean;
|
|
@@ -5536,16 +5537,13 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5536
5537
|
summary?: string | undefined;
|
|
5537
5538
|
externalValue?: string | undefined;
|
|
5538
5539
|
}> | undefined;
|
|
5540
|
+
schema?: unknown;
|
|
5539
5541
|
content?: unknown;
|
|
5540
5542
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
5541
5543
|
explode?: boolean | undefined;
|
|
5542
|
-
schema?: unknown;
|
|
5543
5544
|
}[] | undefined;
|
|
5544
|
-
requestBody?: any;
|
|
5545
5545
|
responses?: Record<string, any> | undefined;
|
|
5546
5546
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
5547
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5548
|
-
'x-post-response'?: string | undefined;
|
|
5549
5547
|
'x-codeSamples'?: {
|
|
5550
5548
|
source: string;
|
|
5551
5549
|
label?: string | undefined;
|
|
@@ -5561,6 +5559,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5561
5559
|
label?: string | undefined;
|
|
5562
5560
|
lang?: string | undefined;
|
|
5563
5561
|
}[] | undefined;
|
|
5562
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5563
|
+
'x-post-response'?: string | undefined;
|
|
5564
5564
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
5565
5565
|
uid: string & import("zod").BRAND<"operation">;
|
|
5566
5566
|
path: string;
|
|
@@ -5569,7 +5569,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5569
5569
|
selectedServerUid: (string & import("zod").BRAND<"server">) | null;
|
|
5570
5570
|
servers: (string & import("zod").BRAND<"server">)[];
|
|
5571
5571
|
examples: (string & import("zod").BRAND<"example">)[];
|
|
5572
|
-
method: "options" | "
|
|
5572
|
+
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
5573
5573
|
description?: string | undefined;
|
|
5574
5574
|
summary?: string | undefined;
|
|
5575
5575
|
externalDocs?: {
|
|
@@ -5582,6 +5582,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5582
5582
|
tags?: string[] | undefined;
|
|
5583
5583
|
deprecated?: boolean | undefined;
|
|
5584
5584
|
operationId?: string | undefined;
|
|
5585
|
+
requestBody?: any;
|
|
5585
5586
|
parameters?: {
|
|
5586
5587
|
name: string;
|
|
5587
5588
|
required: boolean;
|
|
@@ -5594,16 +5595,13 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5594
5595
|
summary?: string | undefined;
|
|
5595
5596
|
externalValue?: string | undefined;
|
|
5596
5597
|
}> | undefined;
|
|
5598
|
+
schema?: unknown;
|
|
5597
5599
|
content?: unknown;
|
|
5598
5600
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
5599
5601
|
explode?: boolean | undefined;
|
|
5600
|
-
schema?: unknown;
|
|
5601
5602
|
}[] | undefined;
|
|
5602
|
-
requestBody?: any;
|
|
5603
5603
|
responses?: Record<string, any> | undefined;
|
|
5604
5604
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
5605
|
-
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5606
|
-
'x-post-response'?: string | undefined;
|
|
5607
5605
|
'x-codeSamples'?: {
|
|
5608
5606
|
source: string;
|
|
5609
5607
|
label?: string | undefined;
|
|
@@ -5619,6 +5617,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5619
5617
|
label?: string | undefined;
|
|
5620
5618
|
lang?: string | undefined;
|
|
5621
5619
|
}[] | undefined;
|
|
5620
|
+
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5621
|
+
'x-post-response'?: string | undefined;
|
|
5622
5622
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
5623
5623
|
undo: (uid: string & import("zod").BRAND<"operation">) => void;
|
|
5624
5624
|
redo: (uid: string & import("zod").BRAND<"operation">) => void;
|
|
@@ -5630,34 +5630,6 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5630
5630
|
uid: string & import("zod").BRAND<"example">;
|
|
5631
5631
|
name: string;
|
|
5632
5632
|
type: "requestExample";
|
|
5633
|
-
body: {
|
|
5634
|
-
activeBody: "binary" | "formData" | "raw";
|
|
5635
|
-
binary?: Blob | undefined;
|
|
5636
|
-
formData?: {
|
|
5637
|
-
value: {
|
|
5638
|
-
value: string;
|
|
5639
|
-
key: string;
|
|
5640
|
-
enabled: boolean;
|
|
5641
|
-
minimum?: number | undefined;
|
|
5642
|
-
type?: string | string[] | undefined;
|
|
5643
|
-
maximum?: number | undefined;
|
|
5644
|
-
description?: string | undefined;
|
|
5645
|
-
default?: any;
|
|
5646
|
-
required?: boolean | undefined;
|
|
5647
|
-
enum?: string[] | undefined;
|
|
5648
|
-
format?: string | undefined;
|
|
5649
|
-
examples?: any[] | undefined;
|
|
5650
|
-
file?: any;
|
|
5651
|
-
nullable?: boolean | undefined;
|
|
5652
|
-
}[];
|
|
5653
|
-
encoding: "form-data" | "urlencoded";
|
|
5654
|
-
} | undefined;
|
|
5655
|
-
raw?: {
|
|
5656
|
-
value: string;
|
|
5657
|
-
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
5658
|
-
mimeType?: string | undefined;
|
|
5659
|
-
} | undefined;
|
|
5660
|
-
};
|
|
5661
5633
|
parameters: {
|
|
5662
5634
|
path: {
|
|
5663
5635
|
value: string;
|
|
@@ -5724,13 +5696,6 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5724
5696
|
nullable?: boolean | undefined;
|
|
5725
5697
|
}[];
|
|
5726
5698
|
};
|
|
5727
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
5728
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5729
|
-
}) => void;
|
|
5730
|
-
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
5731
|
-
uid: string & import("zod").BRAND<"example">;
|
|
5732
|
-
name: string;
|
|
5733
|
-
type: "requestExample";
|
|
5734
5699
|
body: {
|
|
5735
5700
|
activeBody: "binary" | "formData" | "raw";
|
|
5736
5701
|
binary?: Blob | undefined;
|
|
@@ -5759,6 +5724,13 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5759
5724
|
mimeType?: string | undefined;
|
|
5760
5725
|
} | undefined;
|
|
5761
5726
|
};
|
|
5727
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
5728
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5729
|
+
}) => void;
|
|
5730
|
+
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
5731
|
+
uid: string & import("zod").BRAND<"example">;
|
|
5732
|
+
name: string;
|
|
5733
|
+
type: "requestExample";
|
|
5762
5734
|
parameters: {
|
|
5763
5735
|
path: {
|
|
5764
5736
|
value: string;
|
|
@@ -5825,14 +5797,6 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5825
5797
|
nullable?: boolean | undefined;
|
|
5826
5798
|
}[];
|
|
5827
5799
|
};
|
|
5828
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
5829
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5830
|
-
};
|
|
5831
|
-
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
5832
|
-
set: (item: {
|
|
5833
|
-
uid: string & import("zod").BRAND<"example">;
|
|
5834
|
-
name: string;
|
|
5835
|
-
type: "requestExample";
|
|
5836
5800
|
body: {
|
|
5837
5801
|
activeBody: "binary" | "formData" | "raw";
|
|
5838
5802
|
binary?: Blob | undefined;
|
|
@@ -5861,6 +5825,14 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5861
5825
|
mimeType?: string | undefined;
|
|
5862
5826
|
} | undefined;
|
|
5863
5827
|
};
|
|
5828
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
5829
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5830
|
+
};
|
|
5831
|
+
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
5832
|
+
set: (item: {
|
|
5833
|
+
uid: string & import("zod").BRAND<"example">;
|
|
5834
|
+
name: string;
|
|
5835
|
+
type: "requestExample";
|
|
5864
5836
|
parameters: {
|
|
5865
5837
|
path: {
|
|
5866
5838
|
value: string;
|
|
@@ -5927,13 +5899,6 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5927
5899
|
nullable?: boolean | undefined;
|
|
5928
5900
|
}[];
|
|
5929
5901
|
};
|
|
5930
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
5931
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5932
|
-
}) => void;
|
|
5933
|
-
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" ? {
|
|
5934
|
-
uid: string & import("zod").BRAND<"example">;
|
|
5935
|
-
name: string;
|
|
5936
|
-
type: "requestExample";
|
|
5937
5902
|
body: {
|
|
5938
5903
|
activeBody: "binary" | "formData" | "raw";
|
|
5939
5904
|
binary?: Blob | undefined;
|
|
@@ -5962,6 +5927,13 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5962
5927
|
mimeType?: string | undefined;
|
|
5963
5928
|
} | undefined;
|
|
5964
5929
|
};
|
|
5930
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
5931
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5932
|
+
}) => void;
|
|
5933
|
+
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" ? {
|
|
5934
|
+
uid: string & import("zod").BRAND<"example">;
|
|
5935
|
+
name: string;
|
|
5936
|
+
type: "requestExample";
|
|
5965
5937
|
parameters: {
|
|
5966
5938
|
path: {
|
|
5967
5939
|
value: string;
|
|
@@ -6028,12 +6000,6 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6028
6000
|
nullable?: boolean | undefined;
|
|
6029
6001
|
}[];
|
|
6030
6002
|
};
|
|
6031
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
6032
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
6033
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
6034
|
-
uid: string & import("zod").BRAND<"example">;
|
|
6035
|
-
name: string;
|
|
6036
|
-
type: "requestExample";
|
|
6037
6003
|
body: {
|
|
6038
6004
|
activeBody: "binary" | "formData" | "raw";
|
|
6039
6005
|
binary?: Blob | undefined;
|
|
@@ -6062,6 +6028,12 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6062
6028
|
mimeType?: string | undefined;
|
|
6063
6029
|
} | undefined;
|
|
6064
6030
|
};
|
|
6031
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
6032
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
6033
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
6034
|
+
uid: string & import("zod").BRAND<"example">;
|
|
6035
|
+
name: string;
|
|
6036
|
+
type: "requestExample";
|
|
6065
6037
|
parameters: {
|
|
6066
6038
|
path: {
|
|
6067
6039
|
value: string;
|
|
@@ -6128,12 +6100,6 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6128
6100
|
nullable?: boolean | undefined;
|
|
6129
6101
|
}[];
|
|
6130
6102
|
};
|
|
6131
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
6132
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
6133
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6134
|
-
uid: string & import("zod").BRAND<"example">;
|
|
6135
|
-
name: string;
|
|
6136
|
-
type: "requestExample";
|
|
6137
6103
|
body: {
|
|
6138
6104
|
activeBody: "binary" | "formData" | "raw";
|
|
6139
6105
|
binary?: Blob | undefined;
|
|
@@ -6162,6 +6128,12 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6162
6128
|
mimeType?: string | undefined;
|
|
6163
6129
|
} | undefined;
|
|
6164
6130
|
};
|
|
6131
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
6132
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
6133
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6134
|
+
uid: string & import("zod").BRAND<"example">;
|
|
6135
|
+
name: string;
|
|
6136
|
+
type: "requestExample";
|
|
6165
6137
|
parameters: {
|
|
6166
6138
|
path: {
|
|
6167
6139
|
value: string;
|
|
@@ -6228,13 +6200,6 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6228
6200
|
nullable?: boolean | undefined;
|
|
6229
6201
|
}[];
|
|
6230
6202
|
};
|
|
6231
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
6232
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
6233
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
6234
|
-
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" ? {
|
|
6235
|
-
uid: string & import("zod").BRAND<"example">;
|
|
6236
|
-
name: string;
|
|
6237
|
-
type: "requestExample";
|
|
6238
6203
|
body: {
|
|
6239
6204
|
activeBody: "binary" | "formData" | "raw";
|
|
6240
6205
|
binary?: Blob | undefined;
|
|
@@ -6263,6 +6228,13 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6263
6228
|
mimeType?: string | undefined;
|
|
6264
6229
|
} | undefined;
|
|
6265
6230
|
};
|
|
6231
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
6232
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
6233
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
6234
|
+
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" ? {
|
|
6235
|
+
uid: string & import("zod").BRAND<"example">;
|
|
6236
|
+
name: string;
|
|
6237
|
+
type: "requestExample";
|
|
6266
6238
|
parameters: {
|
|
6267
6239
|
path: {
|
|
6268
6240
|
value: string;
|
|
@@ -6329,12 +6301,6 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6329
6301
|
nullable?: boolean | undefined;
|
|
6330
6302
|
}[];
|
|
6331
6303
|
};
|
|
6332
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
6333
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
6334
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
6335
|
-
uid: string & import("zod").BRAND<"example">;
|
|
6336
|
-
name: string;
|
|
6337
|
-
type: "requestExample";
|
|
6338
6304
|
body: {
|
|
6339
6305
|
activeBody: "binary" | "formData" | "raw";
|
|
6340
6306
|
binary?: Blob | undefined;
|
|
@@ -6363,6 +6329,12 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6363
6329
|
mimeType?: string | undefined;
|
|
6364
6330
|
} | undefined;
|
|
6365
6331
|
};
|
|
6332
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
6333
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
6334
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
6335
|
+
uid: string & import("zod").BRAND<"example">;
|
|
6336
|
+
name: string;
|
|
6337
|
+
type: "requestExample";
|
|
6366
6338
|
parameters: {
|
|
6367
6339
|
path: {
|
|
6368
6340
|
value: string;
|
|
@@ -6429,12 +6401,6 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6429
6401
|
nullable?: boolean | undefined;
|
|
6430
6402
|
}[];
|
|
6431
6403
|
};
|
|
6432
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
6433
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
6434
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6435
|
-
uid: string & import("zod").BRAND<"example">;
|
|
6436
|
-
name: string;
|
|
6437
|
-
type: "requestExample";
|
|
6438
6404
|
body: {
|
|
6439
6405
|
activeBody: "binary" | "formData" | "raw";
|
|
6440
6406
|
binary?: Blob | undefined;
|
|
@@ -6463,6 +6429,12 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6463
6429
|
mimeType?: string | undefined;
|
|
6464
6430
|
} | undefined;
|
|
6465
6431
|
};
|
|
6432
|
+
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
6433
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
6434
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6435
|
+
uid: string & import("zod").BRAND<"example">;
|
|
6436
|
+
name: string;
|
|
6437
|
+
type: "requestExample";
|
|
6466
6438
|
parameters: {
|
|
6467
6439
|
path: {
|
|
6468
6440
|
value: string;
|
|
@@ -6529,6 +6501,34 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6529
6501
|
nullable?: boolean | undefined;
|
|
6530
6502
|
}[];
|
|
6531
6503
|
};
|
|
6504
|
+
body: {
|
|
6505
|
+
activeBody: "binary" | "formData" | "raw";
|
|
6506
|
+
binary?: Blob | undefined;
|
|
6507
|
+
formData?: {
|
|
6508
|
+
value: {
|
|
6509
|
+
value: string;
|
|
6510
|
+
key: string;
|
|
6511
|
+
enabled: boolean;
|
|
6512
|
+
minimum?: number | undefined;
|
|
6513
|
+
type?: string | string[] | undefined;
|
|
6514
|
+
maximum?: number | undefined;
|
|
6515
|
+
description?: string | undefined;
|
|
6516
|
+
default?: any;
|
|
6517
|
+
required?: boolean | undefined;
|
|
6518
|
+
enum?: string[] | undefined;
|
|
6519
|
+
format?: string | undefined;
|
|
6520
|
+
examples?: any[] | undefined;
|
|
6521
|
+
file?: any;
|
|
6522
|
+
nullable?: boolean | undefined;
|
|
6523
|
+
}[];
|
|
6524
|
+
encoding: "form-data" | "urlencoded";
|
|
6525
|
+
} | undefined;
|
|
6526
|
+
raw?: {
|
|
6527
|
+
value: string;
|
|
6528
|
+
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
6529
|
+
mimeType?: string | undefined;
|
|
6530
|
+
} | undefined;
|
|
6531
|
+
};
|
|
6532
6532
|
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
6533
6533
|
serverVariables?: Record<string, string[]> | undefined;
|
|
6534
6534
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|