@scalar/api-reference 1.25.103 → 1.25.104
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 +33 -0
- package/dist/blocks/constants.d.ts +9 -0
- package/dist/blocks/constants.d.ts.map +1 -0
- package/dist/blocks/constants.js +8 -0
- package/dist/blocks/helpers/getPointer.d.ts +22 -0
- package/dist/blocks/helpers/getPointer.d.ts.map +1 -0
- package/dist/blocks/helpers/getPointer.js +12 -0
- package/dist/blocks/hooks/useBlockProps.d.ts +32 -0
- package/dist/blocks/hooks/useBlockProps.d.ts.map +1 -0
- package/dist/blocks/hooks/useBlockProps.js +28 -0
- package/dist/browser/standalone.js +12830 -12727
- package/dist/browser/webpack-stats.json +1 -1
- package/dist/components/ApiReference.vue.js +31 -31
- package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
- package/dist/components/ApiReferenceLayout.vue.js +2 -2
- package/dist/components/ApiReferenceLayout.vue2.js +2 -1
- package/dist/components/Content/Introduction/Introduction.vue.d.ts.map +1 -1
- package/dist/components/Content/Introduction/Introduction.vue.js +1 -1
- package/dist/components/Content/Introduction/Introduction.vue2.js +84 -70
- package/dist/components/Content/Schema/SchemaProperty.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/SchemaProperty.vue.js +1 -1
- package/dist/components/Content/Schema/SchemaProperty.vue2.js +94 -89
- package/dist/components/Content/Schema/SchemaPropertyHeading.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/SchemaPropertyHeading.vue.js +3 -3
- package/dist/components/Content/Schema/SchemaPropertyHeading.vue2.js +91 -77
- package/dist/components/Content/Schema/helpers/optimizeValueForDisplay.d.ts +9 -0
- package/dist/components/Content/Schema/helpers/optimizeValueForDisplay.d.ts.map +1 -0
- package/dist/components/Content/Schema/helpers/optimizeValueForDisplay.js +20 -0
- package/dist/components/HttpMethod/HttpMethod.vue.d.ts +2 -1
- package/dist/components/HttpMethod/HttpMethod.vue.d.ts.map +1 -1
- package/dist/components/Layouts/ClassicLayout.vue.d.ts.map +1 -1
- package/dist/components/Layouts/ClassicLayout.vue.js +30 -27
- package/dist/components/Layouts/ModernLayout.vue.d.ts.map +1 -1
- package/dist/components/Layouts/ModernLayout.vue.js +2 -2
- package/dist/components/Layouts/ModernLayout.vue2.js +55 -50
- package/dist/features/ApiClientModal/useApiClient.d.ts +336 -254
- package/dist/features/ApiClientModal/useApiClient.d.ts.map +1 -1
- package/dist/features/DownloadLink/DownloadLink.vue.d.ts.map +1 -1
- package/dist/features/DownloadLink/DownloadLink.vue.js +2 -2
- package/dist/features/DownloadLink/DownloadLink.vue2.js +10 -3
- package/dist/features/Operation/Operation.vue.d.ts.map +1 -1
- package/dist/features/Operation/Operation.vue.js +37 -26
- package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts +3 -0
- package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts.map +1 -1
- package/dist/features/Operation/layouts/ClassicLayout.vue.js +1 -1
- package/dist/features/Operation/layouts/ClassicLayout.vue2.js +108 -101
- package/dist/features/Operation/layouts/ModernLayout.vue.d.ts +3 -0
- package/dist/features/Operation/layouts/ModernLayout.vue.d.ts.map +1 -1
- package/dist/features/Operation/layouts/ModernLayout.vue.js +2 -2
- package/dist/features/Operation/layouts/ModernLayout.vue2.js +54 -50
- package/dist/helpers/get-request.d.ts +2 -0
- package/dist/helpers/get-request.d.ts.map +1 -1
- package/dist/helpers/parse.d.ts.map +1 -1
- package/dist/helpers/parse.js +88 -68
- package/dist/index.d.ts +0 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +79 -83
- package/dist/style.css +1 -1
- package/package.json +12 -13
- package/dist/components/DarkModeToggle/DarkModeIconToggle.vue.d.ts +0 -10
- package/dist/components/DarkModeToggle/DarkModeIconToggle.vue.d.ts.map +0 -1
- package/dist/components/DarkModeToggle/DarkModeIconToggle.vue.js +0 -7
- package/dist/components/DarkModeToggle/DarkModeIconToggle.vue2.js +0 -30
- package/dist/components/DarkModeToggle/DarkModeToggle.vue.d.ts +0 -11
- package/dist/components/DarkModeToggle/DarkModeToggle.vue.d.ts.map +0 -1
- package/dist/components/DarkModeToggle/DarkModeToggle.vue.js +0 -7
- package/dist/components/DarkModeToggle/DarkModeToggle.vue2.js +0 -31
- package/dist/components/DarkModeToggle/index.d.ts +0 -3
- package/dist/components/DarkModeToggle/index.d.ts.map +0 -1
- package/dist/embeds/ExampleRequest/ExampleRequest.vue.d.ts +0 -10
- package/dist/embeds/ExampleRequest/ExampleRequest.vue.d.ts.map +0 -1
- package/dist/embeds/ExampleRequest/index.d.ts +0 -2
- package/dist/embeds/ExampleRequest/index.d.ts.map +0 -1
- package/dist/embeds/ExampleResponses/ExampleResponses.vue.d.ts +0 -7
- package/dist/embeds/ExampleResponses/ExampleResponses.vue.d.ts.map +0 -1
- package/dist/embeds/ExampleResponses/index.d.ts +0 -2
- package/dist/embeds/ExampleResponses/index.d.ts.map +0 -1
- package/dist/embeds/OpenApiDocument/OpenApiDocument.vue.d.ts +0 -782
- package/dist/embeds/OpenApiDocument/OpenApiDocument.vue.d.ts.map +0 -1
- package/dist/embeds/OpenApiDocument/index.d.ts +0 -3
- package/dist/embeds/OpenApiDocument/index.d.ts.map +0 -1
- package/dist/embeds/OpenApiDocument/types.d.ts +0 -3
- package/dist/embeds/OpenApiDocument/types.d.ts.map +0 -1
- package/dist/embeds/index.d.ts +0 -4
- package/dist/embeds/index.d.ts.map +0 -1
|
@@ -45,6 +45,8 @@ declare const client: import("vue").Ref<{
|
|
|
45
45
|
"x-scalar-children"?: {
|
|
46
46
|
tagName: string;
|
|
47
47
|
}[] | undefined;
|
|
48
|
+
"x-internal"?: boolean | undefined;
|
|
49
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
48
50
|
}>;
|
|
49
51
|
securitySchemes: Record<string, {
|
|
50
52
|
type: "apiKey";
|
|
@@ -138,6 +140,8 @@ declare const client: import("vue").Ref<{
|
|
|
138
140
|
url: string;
|
|
139
141
|
description?: string | undefined;
|
|
140
142
|
} | undefined;
|
|
143
|
+
"x-internal"?: boolean | undefined;
|
|
144
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
141
145
|
security?: Record<string, string[]>[] | undefined;
|
|
142
146
|
tags?: string[] | undefined;
|
|
143
147
|
deprecated?: boolean | undefined;
|
|
@@ -264,33 +268,6 @@ declare const client: import("vue").Ref<{
|
|
|
264
268
|
type: "requestExample";
|
|
265
269
|
uid: string;
|
|
266
270
|
name: string;
|
|
267
|
-
body: {
|
|
268
|
-
activeBody: "formData" | "binary" | "raw";
|
|
269
|
-
formData?: {
|
|
270
|
-
value: {
|
|
271
|
-
value: string;
|
|
272
|
-
key: string;
|
|
273
|
-
enabled: boolean;
|
|
274
|
-
minimum?: number | undefined;
|
|
275
|
-
type?: string | undefined;
|
|
276
|
-
maximum?: number | undefined;
|
|
277
|
-
default?: any;
|
|
278
|
-
required?: boolean | undefined;
|
|
279
|
-
description?: string | undefined;
|
|
280
|
-
enum?: string[] | undefined;
|
|
281
|
-
format?: string | undefined;
|
|
282
|
-
file?: any;
|
|
283
|
-
nullable?: boolean | undefined;
|
|
284
|
-
}[];
|
|
285
|
-
encoding: "form-data" | "urlencoded";
|
|
286
|
-
} | undefined;
|
|
287
|
-
binary?: Blob | undefined;
|
|
288
|
-
raw?: {
|
|
289
|
-
value: string;
|
|
290
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
291
|
-
} | undefined;
|
|
292
|
-
};
|
|
293
|
-
requestUid: string;
|
|
294
271
|
parameters: {
|
|
295
272
|
path: {
|
|
296
273
|
value: string;
|
|
@@ -353,9 +330,37 @@ declare const client: import("vue").Ref<{
|
|
|
353
330
|
nullable?: boolean | undefined;
|
|
354
331
|
}[];
|
|
355
332
|
};
|
|
333
|
+
body: {
|
|
334
|
+
activeBody: "binary" | "formData" | "raw";
|
|
335
|
+
binary?: Blob | undefined;
|
|
336
|
+
formData?: {
|
|
337
|
+
value: {
|
|
338
|
+
value: string;
|
|
339
|
+
key: string;
|
|
340
|
+
enabled: boolean;
|
|
341
|
+
minimum?: number | undefined;
|
|
342
|
+
type?: string | undefined;
|
|
343
|
+
maximum?: number | undefined;
|
|
344
|
+
default?: any;
|
|
345
|
+
required?: boolean | undefined;
|
|
346
|
+
description?: string | undefined;
|
|
347
|
+
enum?: string[] | undefined;
|
|
348
|
+
format?: string | undefined;
|
|
349
|
+
file?: any;
|
|
350
|
+
nullable?: boolean | undefined;
|
|
351
|
+
}[];
|
|
352
|
+
encoding: "form-data" | "urlencoded";
|
|
353
|
+
} | undefined;
|
|
354
|
+
raw?: {
|
|
355
|
+
value: string;
|
|
356
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
357
|
+
} | undefined;
|
|
358
|
+
};
|
|
359
|
+
requestUid: string;
|
|
356
360
|
serverVariables?: Record<string, string[]> | undefined;
|
|
357
361
|
}>;
|
|
358
362
|
setSidebarWidth: (width: string) => void;
|
|
363
|
+
integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
|
|
359
364
|
importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
|
|
360
365
|
type?: "collection" | undefined;
|
|
361
366
|
uid?: string | undefined;
|
|
@@ -912,7 +917,7 @@ declare const client: import("vue").Ref<{
|
|
|
912
917
|
documentUrl?: string | undefined;
|
|
913
918
|
integration?: string | null | undefined;
|
|
914
919
|
}) => void;
|
|
915
|
-
edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
920
|
+
edit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? {
|
|
916
921
|
type: "collection";
|
|
917
922
|
uid: string;
|
|
918
923
|
children: string[];
|
|
@@ -966,7 +971,7 @@ declare const client: import("vue").Ref<{
|
|
|
966
971
|
}> | undefined;
|
|
967
972
|
documentUrl?: string | undefined;
|
|
968
973
|
integration?: string | null | undefined;
|
|
969
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
974
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
970
975
|
type: "collection";
|
|
971
976
|
uid: string;
|
|
972
977
|
children: string[];
|
|
@@ -1075,7 +1080,7 @@ declare const client: import("vue").Ref<{
|
|
|
1075
1080
|
documentUrl?: string | undefined;
|
|
1076
1081
|
integration?: string | null | undefined;
|
|
1077
1082
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1078
|
-
untrackedEdit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
1083
|
+
untrackedEdit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? {
|
|
1079
1084
|
type: "collection";
|
|
1080
1085
|
uid: string;
|
|
1081
1086
|
children: string[];
|
|
@@ -1129,7 +1134,7 @@ declare const client: import("vue").Ref<{
|
|
|
1129
1134
|
}> | undefined;
|
|
1130
1135
|
documentUrl?: string | undefined;
|
|
1131
1136
|
integration?: string | null | undefined;
|
|
1132
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
1137
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1133
1138
|
type: "collection";
|
|
1134
1139
|
uid: string;
|
|
1135
1140
|
children: string[];
|
|
@@ -1316,6 +1321,8 @@ declare const client: import("vue").Ref<{
|
|
|
1316
1321
|
url: string;
|
|
1317
1322
|
description?: string | undefined;
|
|
1318
1323
|
} | undefined;
|
|
1324
|
+
"x-internal"?: boolean | undefined;
|
|
1325
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1319
1326
|
security?: Record<string, string[]>[] | undefined;
|
|
1320
1327
|
tags?: string[] | undefined;
|
|
1321
1328
|
deprecated?: boolean | undefined;
|
|
@@ -1353,6 +1360,8 @@ declare const client: import("vue").Ref<{
|
|
|
1353
1360
|
url: string;
|
|
1354
1361
|
description?: string | undefined;
|
|
1355
1362
|
} | undefined;
|
|
1363
|
+
"x-internal"?: boolean | undefined;
|
|
1364
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1356
1365
|
security?: Record<string, string[]>[] | undefined;
|
|
1357
1366
|
tags?: string[] | undefined;
|
|
1358
1367
|
deprecated?: boolean | undefined;
|
|
@@ -1391,6 +1400,8 @@ declare const client: import("vue").Ref<{
|
|
|
1391
1400
|
url: string;
|
|
1392
1401
|
description?: string | undefined;
|
|
1393
1402
|
} | undefined;
|
|
1403
|
+
"x-internal"?: boolean | undefined;
|
|
1404
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1394
1405
|
security?: Record<string, string[]>[] | undefined;
|
|
1395
1406
|
tags?: string[] | undefined;
|
|
1396
1407
|
deprecated?: boolean | undefined;
|
|
@@ -1413,7 +1424,7 @@ declare const client: import("vue").Ref<{
|
|
|
1413
1424
|
requestBody?: any;
|
|
1414
1425
|
responses?: Record<string, any> | undefined;
|
|
1415
1426
|
}) => void;
|
|
1416
|
-
edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
1427
|
+
edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | "method" | "path" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? {
|
|
1417
1428
|
path: string;
|
|
1418
1429
|
type: "request";
|
|
1419
1430
|
uid: string;
|
|
@@ -1428,6 +1439,8 @@ declare const client: import("vue").Ref<{
|
|
|
1428
1439
|
url: string;
|
|
1429
1440
|
description?: string | undefined;
|
|
1430
1441
|
} | undefined;
|
|
1442
|
+
"x-internal"?: boolean | undefined;
|
|
1443
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1431
1444
|
security?: Record<string, string[]>[] | undefined;
|
|
1432
1445
|
tags?: string[] | undefined;
|
|
1433
1446
|
deprecated?: boolean | undefined;
|
|
@@ -1449,7 +1462,7 @@ declare const client: import("vue").Ref<{
|
|
|
1449
1462
|
}[] | undefined;
|
|
1450
1463
|
requestBody?: any;
|
|
1451
1464
|
responses?: Record<string, any> | undefined;
|
|
1452
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "
|
|
1465
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1453
1466
|
path: string;
|
|
1454
1467
|
type: "request";
|
|
1455
1468
|
uid: string;
|
|
@@ -1464,6 +1477,8 @@ declare const client: import("vue").Ref<{
|
|
|
1464
1477
|
url: string;
|
|
1465
1478
|
description?: string | undefined;
|
|
1466
1479
|
} | undefined;
|
|
1480
|
+
"x-internal"?: boolean | undefined;
|
|
1481
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1467
1482
|
security?: Record<string, string[]>[] | undefined;
|
|
1468
1483
|
tags?: string[] | undefined;
|
|
1469
1484
|
deprecated?: boolean | undefined;
|
|
@@ -1500,6 +1515,8 @@ declare const client: import("vue").Ref<{
|
|
|
1500
1515
|
url: string;
|
|
1501
1516
|
description?: string | undefined;
|
|
1502
1517
|
} | undefined;
|
|
1518
|
+
"x-internal"?: boolean | undefined;
|
|
1519
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1503
1520
|
security?: Record<string, string[]>[] | undefined;
|
|
1504
1521
|
tags?: string[] | undefined;
|
|
1505
1522
|
deprecated?: boolean | undefined;
|
|
@@ -1522,7 +1539,7 @@ declare const client: import("vue").Ref<{
|
|
|
1522
1539
|
requestBody?: any;
|
|
1523
1540
|
responses?: Record<string, any> | undefined;
|
|
1524
1541
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1525
|
-
untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
1542
|
+
untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | "method" | "path" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? {
|
|
1526
1543
|
path: string;
|
|
1527
1544
|
type: "request";
|
|
1528
1545
|
uid: string;
|
|
@@ -1537,6 +1554,8 @@ declare const client: import("vue").Ref<{
|
|
|
1537
1554
|
url: string;
|
|
1538
1555
|
description?: string | undefined;
|
|
1539
1556
|
} | undefined;
|
|
1557
|
+
"x-internal"?: boolean | undefined;
|
|
1558
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1540
1559
|
security?: Record<string, string[]>[] | undefined;
|
|
1541
1560
|
tags?: string[] | undefined;
|
|
1542
1561
|
deprecated?: boolean | undefined;
|
|
@@ -1558,7 +1577,7 @@ declare const client: import("vue").Ref<{
|
|
|
1558
1577
|
}[] | undefined;
|
|
1559
1578
|
requestBody?: any;
|
|
1560
1579
|
responses?: Record<string, any> | undefined;
|
|
1561
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "
|
|
1580
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1562
1581
|
path: string;
|
|
1563
1582
|
type: "request";
|
|
1564
1583
|
uid: string;
|
|
@@ -1573,6 +1592,8 @@ declare const client: import("vue").Ref<{
|
|
|
1573
1592
|
url: string;
|
|
1574
1593
|
description?: string | undefined;
|
|
1575
1594
|
} | undefined;
|
|
1595
|
+
"x-internal"?: boolean | undefined;
|
|
1596
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1576
1597
|
security?: Record<string, string[]>[] | undefined;
|
|
1577
1598
|
tags?: string[] | undefined;
|
|
1578
1599
|
deprecated?: boolean | undefined;
|
|
@@ -1609,6 +1630,8 @@ declare const client: import("vue").Ref<{
|
|
|
1609
1630
|
url: string;
|
|
1610
1631
|
description?: string | undefined;
|
|
1611
1632
|
} | undefined;
|
|
1633
|
+
"x-internal"?: boolean | undefined;
|
|
1634
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1612
1635
|
security?: Record<string, string[]>[] | undefined;
|
|
1613
1636
|
tags?: string[] | undefined;
|
|
1614
1637
|
deprecated?: boolean | undefined;
|
|
@@ -1641,33 +1664,6 @@ declare const client: import("vue").Ref<{
|
|
|
1641
1664
|
type: "requestExample";
|
|
1642
1665
|
uid: string;
|
|
1643
1666
|
name: string;
|
|
1644
|
-
body: {
|
|
1645
|
-
activeBody: "formData" | "binary" | "raw";
|
|
1646
|
-
formData?: {
|
|
1647
|
-
value: {
|
|
1648
|
-
value: string;
|
|
1649
|
-
key: string;
|
|
1650
|
-
enabled: boolean;
|
|
1651
|
-
minimum?: number | undefined;
|
|
1652
|
-
type?: string | undefined;
|
|
1653
|
-
maximum?: number | undefined;
|
|
1654
|
-
default?: any;
|
|
1655
|
-
required?: boolean | undefined;
|
|
1656
|
-
description?: string | undefined;
|
|
1657
|
-
enum?: string[] | undefined;
|
|
1658
|
-
format?: string | undefined;
|
|
1659
|
-
file?: any;
|
|
1660
|
-
nullable?: boolean | undefined;
|
|
1661
|
-
}[];
|
|
1662
|
-
encoding: "form-data" | "urlencoded";
|
|
1663
|
-
} | undefined;
|
|
1664
|
-
binary?: Blob | undefined;
|
|
1665
|
-
raw?: {
|
|
1666
|
-
value: string;
|
|
1667
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1668
|
-
} | undefined;
|
|
1669
|
-
};
|
|
1670
|
-
requestUid: string;
|
|
1671
1667
|
parameters: {
|
|
1672
1668
|
path: {
|
|
1673
1669
|
value: string;
|
|
@@ -1730,14 +1726,9 @@ declare const client: import("vue").Ref<{
|
|
|
1730
1726
|
nullable?: boolean | undefined;
|
|
1731
1727
|
}[];
|
|
1732
1728
|
};
|
|
1733
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1734
|
-
}) => void;
|
|
1735
|
-
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
1736
|
-
type: "requestExample";
|
|
1737
|
-
uid: string;
|
|
1738
|
-
name: string;
|
|
1739
1729
|
body: {
|
|
1740
|
-
activeBody: "
|
|
1730
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1731
|
+
binary?: Blob | undefined;
|
|
1741
1732
|
formData?: {
|
|
1742
1733
|
value: {
|
|
1743
1734
|
value: string;
|
|
@@ -1756,13 +1747,18 @@ declare const client: import("vue").Ref<{
|
|
|
1756
1747
|
}[];
|
|
1757
1748
|
encoding: "form-data" | "urlencoded";
|
|
1758
1749
|
} | undefined;
|
|
1759
|
-
binary?: Blob | undefined;
|
|
1760
1750
|
raw?: {
|
|
1761
1751
|
value: string;
|
|
1762
1752
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1763
1753
|
} | undefined;
|
|
1764
1754
|
};
|
|
1765
1755
|
requestUid: string;
|
|
1756
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1757
|
+
}) => void;
|
|
1758
|
+
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
1759
|
+
type: "requestExample";
|
|
1760
|
+
uid: string;
|
|
1761
|
+
name: string;
|
|
1766
1762
|
parameters: {
|
|
1767
1763
|
path: {
|
|
1768
1764
|
value: string;
|
|
@@ -1825,15 +1821,9 @@ declare const client: import("vue").Ref<{
|
|
|
1825
1821
|
nullable?: boolean | undefined;
|
|
1826
1822
|
}[];
|
|
1827
1823
|
};
|
|
1828
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1829
|
-
};
|
|
1830
|
-
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
1831
|
-
set: (item: {
|
|
1832
|
-
type: "requestExample";
|
|
1833
|
-
uid: string;
|
|
1834
|
-
name: string;
|
|
1835
1824
|
body: {
|
|
1836
|
-
activeBody: "
|
|
1825
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1826
|
+
binary?: Blob | undefined;
|
|
1837
1827
|
formData?: {
|
|
1838
1828
|
value: {
|
|
1839
1829
|
value: string;
|
|
@@ -1852,13 +1842,19 @@ declare const client: import("vue").Ref<{
|
|
|
1852
1842
|
}[];
|
|
1853
1843
|
encoding: "form-data" | "urlencoded";
|
|
1854
1844
|
} | undefined;
|
|
1855
|
-
binary?: Blob | undefined;
|
|
1856
1845
|
raw?: {
|
|
1857
1846
|
value: string;
|
|
1858
1847
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1859
1848
|
} | undefined;
|
|
1860
1849
|
};
|
|
1861
1850
|
requestUid: string;
|
|
1851
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1852
|
+
};
|
|
1853
|
+
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
1854
|
+
set: (item: {
|
|
1855
|
+
type: "requestExample";
|
|
1856
|
+
uid: string;
|
|
1857
|
+
name: string;
|
|
1862
1858
|
parameters: {
|
|
1863
1859
|
path: {
|
|
1864
1860
|
value: string;
|
|
@@ -1921,14 +1917,9 @@ declare const client: import("vue").Ref<{
|
|
|
1921
1917
|
nullable?: boolean | undefined;
|
|
1922
1918
|
}[];
|
|
1923
1919
|
};
|
|
1924
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1925
|
-
}) => void;
|
|
1926
|
-
edit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
|
|
1927
|
-
type: "requestExample";
|
|
1928
|
-
uid: string;
|
|
1929
|
-
name: string;
|
|
1930
1920
|
body: {
|
|
1931
|
-
activeBody: "
|
|
1921
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1922
|
+
binary?: Blob | undefined;
|
|
1932
1923
|
formData?: {
|
|
1933
1924
|
value: {
|
|
1934
1925
|
value: string;
|
|
@@ -1947,13 +1938,18 @@ declare const client: import("vue").Ref<{
|
|
|
1947
1938
|
}[];
|
|
1948
1939
|
encoding: "form-data" | "urlencoded";
|
|
1949
1940
|
} | undefined;
|
|
1950
|
-
binary?: Blob | undefined;
|
|
1951
1941
|
raw?: {
|
|
1952
1942
|
value: string;
|
|
1953
1943
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1954
1944
|
} | undefined;
|
|
1955
1945
|
};
|
|
1956
1946
|
requestUid: string;
|
|
1947
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1948
|
+
}) => void;
|
|
1949
|
+
edit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
|
|
1950
|
+
type: "requestExample";
|
|
1951
|
+
uid: string;
|
|
1952
|
+
name: string;
|
|
1957
1953
|
parameters: {
|
|
1958
1954
|
path: {
|
|
1959
1955
|
value: string;
|
|
@@ -2016,13 +2012,9 @@ declare const client: import("vue").Ref<{
|
|
|
2016
2012
|
nullable?: boolean | undefined;
|
|
2017
2013
|
}[];
|
|
2018
2014
|
};
|
|
2019
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2020
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2021
|
-
type: "requestExample";
|
|
2022
|
-
uid: string;
|
|
2023
|
-
name: string;
|
|
2024
2015
|
body: {
|
|
2025
|
-
activeBody: "
|
|
2016
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2017
|
+
binary?: Blob | undefined;
|
|
2026
2018
|
formData?: {
|
|
2027
2019
|
value: {
|
|
2028
2020
|
value: string;
|
|
@@ -2041,13 +2033,17 @@ declare const client: import("vue").Ref<{
|
|
|
2041
2033
|
}[];
|
|
2042
2034
|
encoding: "form-data" | "urlencoded";
|
|
2043
2035
|
} | undefined;
|
|
2044
|
-
binary?: Blob | undefined;
|
|
2045
2036
|
raw?: {
|
|
2046
2037
|
value: string;
|
|
2047
2038
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2048
2039
|
} | undefined;
|
|
2049
2040
|
};
|
|
2050
2041
|
requestUid: string;
|
|
2042
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2043
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2044
|
+
type: "requestExample";
|
|
2045
|
+
uid: string;
|
|
2046
|
+
name: string;
|
|
2051
2047
|
parameters: {
|
|
2052
2048
|
path: {
|
|
2053
2049
|
value: string;
|
|
@@ -2110,13 +2106,9 @@ declare const client: import("vue").Ref<{
|
|
|
2110
2106
|
nullable?: boolean | undefined;
|
|
2111
2107
|
}[];
|
|
2112
2108
|
};
|
|
2113
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2114
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2115
|
-
type: "requestExample";
|
|
2116
|
-
uid: string;
|
|
2117
|
-
name: string;
|
|
2118
2109
|
body: {
|
|
2119
|
-
activeBody: "
|
|
2110
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2111
|
+
binary?: Blob | undefined;
|
|
2120
2112
|
formData?: {
|
|
2121
2113
|
value: {
|
|
2122
2114
|
value: string;
|
|
@@ -2135,13 +2127,17 @@ declare const client: import("vue").Ref<{
|
|
|
2135
2127
|
}[];
|
|
2136
2128
|
encoding: "form-data" | "urlencoded";
|
|
2137
2129
|
} | undefined;
|
|
2138
|
-
binary?: Blob | undefined;
|
|
2139
2130
|
raw?: {
|
|
2140
2131
|
value: string;
|
|
2141
2132
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2142
2133
|
} | undefined;
|
|
2143
2134
|
};
|
|
2144
2135
|
requestUid: string;
|
|
2136
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2137
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2138
|
+
type: "requestExample";
|
|
2139
|
+
uid: string;
|
|
2140
|
+
name: string;
|
|
2145
2141
|
parameters: {
|
|
2146
2142
|
path: {
|
|
2147
2143
|
value: string;
|
|
@@ -2204,14 +2200,9 @@ declare const client: import("vue").Ref<{
|
|
|
2204
2200
|
nullable?: boolean | undefined;
|
|
2205
2201
|
}[];
|
|
2206
2202
|
};
|
|
2207
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2208
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2209
|
-
untrackedEdit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
|
|
2210
|
-
type: "requestExample";
|
|
2211
|
-
uid: string;
|
|
2212
|
-
name: string;
|
|
2213
2203
|
body: {
|
|
2214
|
-
activeBody: "
|
|
2204
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2205
|
+
binary?: Blob | undefined;
|
|
2215
2206
|
formData?: {
|
|
2216
2207
|
value: {
|
|
2217
2208
|
value: string;
|
|
@@ -2230,13 +2221,18 @@ declare const client: import("vue").Ref<{
|
|
|
2230
2221
|
}[];
|
|
2231
2222
|
encoding: "form-data" | "urlencoded";
|
|
2232
2223
|
} | undefined;
|
|
2233
|
-
binary?: Blob | undefined;
|
|
2234
2224
|
raw?: {
|
|
2235
2225
|
value: string;
|
|
2236
2226
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2237
2227
|
} | undefined;
|
|
2238
2228
|
};
|
|
2239
2229
|
requestUid: string;
|
|
2230
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2231
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2232
|
+
untrackedEdit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
|
|
2233
|
+
type: "requestExample";
|
|
2234
|
+
uid: string;
|
|
2235
|
+
name: string;
|
|
2240
2236
|
parameters: {
|
|
2241
2237
|
path: {
|
|
2242
2238
|
value: string;
|
|
@@ -2299,13 +2295,9 @@ declare const client: import("vue").Ref<{
|
|
|
2299
2295
|
nullable?: boolean | undefined;
|
|
2300
2296
|
}[];
|
|
2301
2297
|
};
|
|
2302
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2303
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2304
|
-
type: "requestExample";
|
|
2305
|
-
uid: string;
|
|
2306
|
-
name: string;
|
|
2307
2298
|
body: {
|
|
2308
|
-
activeBody: "
|
|
2299
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2300
|
+
binary?: Blob | undefined;
|
|
2309
2301
|
formData?: {
|
|
2310
2302
|
value: {
|
|
2311
2303
|
value: string;
|
|
@@ -2324,13 +2316,17 @@ declare const client: import("vue").Ref<{
|
|
|
2324
2316
|
}[];
|
|
2325
2317
|
encoding: "form-data" | "urlencoded";
|
|
2326
2318
|
} | undefined;
|
|
2327
|
-
binary?: Blob | undefined;
|
|
2328
2319
|
raw?: {
|
|
2329
2320
|
value: string;
|
|
2330
2321
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2331
2322
|
} | undefined;
|
|
2332
2323
|
};
|
|
2333
2324
|
requestUid: string;
|
|
2325
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2326
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2327
|
+
type: "requestExample";
|
|
2328
|
+
uid: string;
|
|
2329
|
+
name: string;
|
|
2334
2330
|
parameters: {
|
|
2335
2331
|
path: {
|
|
2336
2332
|
value: string;
|
|
@@ -2393,13 +2389,9 @@ declare const client: import("vue").Ref<{
|
|
|
2393
2389
|
nullable?: boolean | undefined;
|
|
2394
2390
|
}[];
|
|
2395
2391
|
};
|
|
2396
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2397
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2398
|
-
type: "requestExample";
|
|
2399
|
-
uid: string;
|
|
2400
|
-
name: string;
|
|
2401
2392
|
body: {
|
|
2402
|
-
activeBody: "
|
|
2393
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2394
|
+
binary?: Blob | undefined;
|
|
2403
2395
|
formData?: {
|
|
2404
2396
|
value: {
|
|
2405
2397
|
value: string;
|
|
@@ -2418,13 +2410,17 @@ declare const client: import("vue").Ref<{
|
|
|
2418
2410
|
}[];
|
|
2419
2411
|
encoding: "form-data" | "urlencoded";
|
|
2420
2412
|
} | undefined;
|
|
2421
|
-
binary?: Blob | undefined;
|
|
2422
2413
|
raw?: {
|
|
2423
2414
|
value: string;
|
|
2424
2415
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2425
2416
|
} | undefined;
|
|
2426
2417
|
};
|
|
2427
2418
|
requestUid: string;
|
|
2419
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2420
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2421
|
+
type: "requestExample";
|
|
2422
|
+
uid: string;
|
|
2423
|
+
name: string;
|
|
2428
2424
|
parameters: {
|
|
2429
2425
|
path: {
|
|
2430
2426
|
value: string;
|
|
@@ -2487,6 +2483,33 @@ declare const client: import("vue").Ref<{
|
|
|
2487
2483
|
nullable?: boolean | undefined;
|
|
2488
2484
|
}[];
|
|
2489
2485
|
};
|
|
2486
|
+
body: {
|
|
2487
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2488
|
+
binary?: Blob | undefined;
|
|
2489
|
+
formData?: {
|
|
2490
|
+
value: {
|
|
2491
|
+
value: string;
|
|
2492
|
+
key: string;
|
|
2493
|
+
enabled: boolean;
|
|
2494
|
+
minimum?: number | undefined;
|
|
2495
|
+
type?: string | undefined;
|
|
2496
|
+
maximum?: number | undefined;
|
|
2497
|
+
default?: any;
|
|
2498
|
+
required?: boolean | undefined;
|
|
2499
|
+
description?: string | undefined;
|
|
2500
|
+
enum?: string[] | undefined;
|
|
2501
|
+
format?: string | undefined;
|
|
2502
|
+
file?: any;
|
|
2503
|
+
nullable?: boolean | undefined;
|
|
2504
|
+
}[];
|
|
2505
|
+
encoding: "form-data" | "urlencoded";
|
|
2506
|
+
} | undefined;
|
|
2507
|
+
raw?: {
|
|
2508
|
+
value: string;
|
|
2509
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2510
|
+
} | undefined;
|
|
2511
|
+
};
|
|
2512
|
+
requestUid: string;
|
|
2490
2513
|
serverVariables?: Record<string, string[]> | undefined;
|
|
2491
2514
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2492
2515
|
undo: (uid: string) => void;
|
|
@@ -3276,6 +3299,8 @@ declare const client: import("vue").Ref<{
|
|
|
3276
3299
|
"x-scalar-children"?: {
|
|
3277
3300
|
tagName: string;
|
|
3278
3301
|
}[] | undefined;
|
|
3302
|
+
"x-internal"?: boolean | undefined;
|
|
3303
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3279
3304
|
}) => void;
|
|
3280
3305
|
add: (payload: import("@scalar/oas-utils/entities/spec").TagPayload, collectionUid: string) => void | {
|
|
3281
3306
|
type: "tag";
|
|
@@ -3290,6 +3315,8 @@ declare const client: import("vue").Ref<{
|
|
|
3290
3315
|
"x-scalar-children"?: {
|
|
3291
3316
|
tagName: string;
|
|
3292
3317
|
}[] | undefined;
|
|
3318
|
+
"x-internal"?: boolean | undefined;
|
|
3319
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3293
3320
|
};
|
|
3294
3321
|
delete: (tag: import("@scalar/oas-utils/entities/spec").Tag, collectionUid: string) => void;
|
|
3295
3322
|
set: (item: {
|
|
@@ -3305,8 +3332,10 @@ declare const client: import("vue").Ref<{
|
|
|
3305
3332
|
"x-scalar-children"?: {
|
|
3306
3333
|
tagName: string;
|
|
3307
3334
|
}[] | undefined;
|
|
3335
|
+
"x-internal"?: boolean | undefined;
|
|
3336
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3308
3337
|
}) => void;
|
|
3309
|
-
edit: <P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
|
|
3338
|
+
edit: <P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
|
|
3310
3339
|
type: "tag";
|
|
3311
3340
|
uid: string;
|
|
3312
3341
|
name: string;
|
|
@@ -3319,7 +3348,9 @@ declare const client: import("vue").Ref<{
|
|
|
3319
3348
|
"x-scalar-children"?: {
|
|
3320
3349
|
tagName: string;
|
|
3321
3350
|
}[] | undefined;
|
|
3322
|
-
|
|
3351
|
+
"x-internal"?: boolean | undefined;
|
|
3352
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3353
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
3323
3354
|
type: "tag";
|
|
3324
3355
|
uid: string;
|
|
3325
3356
|
name: string;
|
|
@@ -3332,6 +3363,8 @@ declare const client: import("vue").Ref<{
|
|
|
3332
3363
|
"x-scalar-children"?: {
|
|
3333
3364
|
tagName: string;
|
|
3334
3365
|
}[] | undefined;
|
|
3366
|
+
"x-internal"?: boolean | undefined;
|
|
3367
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3335
3368
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
3336
3369
|
type: "tag";
|
|
3337
3370
|
uid: string;
|
|
@@ -3345,8 +3378,10 @@ declare const client: import("vue").Ref<{
|
|
|
3345
3378
|
"x-scalar-children"?: {
|
|
3346
3379
|
tagName: string;
|
|
3347
3380
|
}[] | undefined;
|
|
3381
|
+
"x-internal"?: boolean | undefined;
|
|
3382
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3348
3383
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3349
|
-
untrackedEdit: <P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
|
|
3384
|
+
untrackedEdit: <P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
|
|
3350
3385
|
type: "tag";
|
|
3351
3386
|
uid: string;
|
|
3352
3387
|
name: string;
|
|
@@ -3359,7 +3394,9 @@ declare const client: import("vue").Ref<{
|
|
|
3359
3394
|
"x-scalar-children"?: {
|
|
3360
3395
|
tagName: string;
|
|
3361
3396
|
}[] | undefined;
|
|
3362
|
-
|
|
3397
|
+
"x-internal"?: boolean | undefined;
|
|
3398
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3399
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
3363
3400
|
type: "tag";
|
|
3364
3401
|
uid: string;
|
|
3365
3402
|
name: string;
|
|
@@ -3372,6 +3409,8 @@ declare const client: import("vue").Ref<{
|
|
|
3372
3409
|
"x-scalar-children"?: {
|
|
3373
3410
|
tagName: string;
|
|
3374
3411
|
}[] | undefined;
|
|
3412
|
+
"x-internal"?: boolean | undefined;
|
|
3413
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3375
3414
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
3376
3415
|
type: "tag";
|
|
3377
3416
|
uid: string;
|
|
@@ -3385,6 +3424,8 @@ declare const client: import("vue").Ref<{
|
|
|
3385
3424
|
"x-scalar-children"?: {
|
|
3386
3425
|
tagName: string;
|
|
3387
3426
|
}[] | undefined;
|
|
3427
|
+
"x-internal"?: boolean | undefined;
|
|
3428
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3388
3429
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3389
3430
|
undo: (uid: string) => void;
|
|
3390
3431
|
redo: (uid: string) => void;
|
|
@@ -3601,6 +3642,8 @@ declare const client: import("vue").Ref<{
|
|
|
3601
3642
|
"x-scalar-children"?: {
|
|
3602
3643
|
tagName: string;
|
|
3603
3644
|
}[] | undefined;
|
|
3645
|
+
"x-internal"?: boolean | undefined;
|
|
3646
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3604
3647
|
}>;
|
|
3605
3648
|
securitySchemes: Record<string, {
|
|
3606
3649
|
type: "apiKey";
|
|
@@ -3694,6 +3737,8 @@ declare const client: import("vue").Ref<{
|
|
|
3694
3737
|
url: string;
|
|
3695
3738
|
description?: string | undefined;
|
|
3696
3739
|
} | undefined;
|
|
3740
|
+
"x-internal"?: boolean | undefined;
|
|
3741
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3697
3742
|
security?: Record<string, string[]>[] | undefined;
|
|
3698
3743
|
tags?: string[] | undefined;
|
|
3699
3744
|
deprecated?: boolean | undefined;
|
|
@@ -3820,33 +3865,6 @@ declare const client: import("vue").Ref<{
|
|
|
3820
3865
|
type: "requestExample";
|
|
3821
3866
|
uid: string;
|
|
3822
3867
|
name: string;
|
|
3823
|
-
body: {
|
|
3824
|
-
activeBody: "formData" | "binary" | "raw";
|
|
3825
|
-
formData?: {
|
|
3826
|
-
value: {
|
|
3827
|
-
value: string;
|
|
3828
|
-
key: string;
|
|
3829
|
-
enabled: boolean;
|
|
3830
|
-
minimum?: number | undefined;
|
|
3831
|
-
type?: string | undefined;
|
|
3832
|
-
maximum?: number | undefined;
|
|
3833
|
-
default?: any;
|
|
3834
|
-
required?: boolean | undefined;
|
|
3835
|
-
description?: string | undefined;
|
|
3836
|
-
enum?: string[] | undefined;
|
|
3837
|
-
format?: string | undefined;
|
|
3838
|
-
file?: any;
|
|
3839
|
-
nullable?: boolean | undefined;
|
|
3840
|
-
}[];
|
|
3841
|
-
encoding: "form-data" | "urlencoded";
|
|
3842
|
-
} | undefined;
|
|
3843
|
-
binary?: Blob | undefined;
|
|
3844
|
-
raw?: {
|
|
3845
|
-
value: string;
|
|
3846
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
3847
|
-
} | undefined;
|
|
3848
|
-
};
|
|
3849
|
-
requestUid: string;
|
|
3850
3868
|
parameters: {
|
|
3851
3869
|
path: {
|
|
3852
3870
|
value: string;
|
|
@@ -3909,9 +3927,37 @@ declare const client: import("vue").Ref<{
|
|
|
3909
3927
|
nullable?: boolean | undefined;
|
|
3910
3928
|
}[];
|
|
3911
3929
|
};
|
|
3930
|
+
body: {
|
|
3931
|
+
activeBody: "binary" | "formData" | "raw";
|
|
3932
|
+
binary?: Blob | undefined;
|
|
3933
|
+
formData?: {
|
|
3934
|
+
value: {
|
|
3935
|
+
value: string;
|
|
3936
|
+
key: string;
|
|
3937
|
+
enabled: boolean;
|
|
3938
|
+
minimum?: number | undefined;
|
|
3939
|
+
type?: string | undefined;
|
|
3940
|
+
maximum?: number | undefined;
|
|
3941
|
+
default?: any;
|
|
3942
|
+
required?: boolean | undefined;
|
|
3943
|
+
description?: string | undefined;
|
|
3944
|
+
enum?: string[] | undefined;
|
|
3945
|
+
format?: string | undefined;
|
|
3946
|
+
file?: any;
|
|
3947
|
+
nullable?: boolean | undefined;
|
|
3948
|
+
}[];
|
|
3949
|
+
encoding: "form-data" | "urlencoded";
|
|
3950
|
+
} | undefined;
|
|
3951
|
+
raw?: {
|
|
3952
|
+
value: string;
|
|
3953
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
3954
|
+
} | undefined;
|
|
3955
|
+
};
|
|
3956
|
+
requestUid: string;
|
|
3912
3957
|
serverVariables?: Record<string, string[]> | undefined;
|
|
3913
3958
|
}>;
|
|
3914
3959
|
setSidebarWidth: (width: string) => void;
|
|
3960
|
+
integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
|
|
3915
3961
|
importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
|
|
3916
3962
|
type?: "collection" | undefined;
|
|
3917
3963
|
uid?: string | undefined;
|
|
@@ -4468,7 +4514,7 @@ declare const client: import("vue").Ref<{
|
|
|
4468
4514
|
documentUrl?: string | undefined;
|
|
4469
4515
|
integration?: string | null | undefined;
|
|
4470
4516
|
}) => void;
|
|
4471
|
-
edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
4517
|
+
edit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? {
|
|
4472
4518
|
type: "collection";
|
|
4473
4519
|
uid: string;
|
|
4474
4520
|
children: string[];
|
|
@@ -4522,7 +4568,7 @@ declare const client: import("vue").Ref<{
|
|
|
4522
4568
|
}> | undefined;
|
|
4523
4569
|
documentUrl?: string | undefined;
|
|
4524
4570
|
integration?: string | null | undefined;
|
|
4525
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
4571
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
4526
4572
|
type: "collection";
|
|
4527
4573
|
uid: string;
|
|
4528
4574
|
children: string[];
|
|
@@ -4631,7 +4677,7 @@ declare const client: import("vue").Ref<{
|
|
|
4631
4677
|
documentUrl?: string | undefined;
|
|
4632
4678
|
integration?: string | null | undefined;
|
|
4633
4679
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
4634
|
-
untrackedEdit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
4680
|
+
untrackedEdit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? {
|
|
4635
4681
|
type: "collection";
|
|
4636
4682
|
uid: string;
|
|
4637
4683
|
children: string[];
|
|
@@ -4685,7 +4731,7 @@ declare const client: import("vue").Ref<{
|
|
|
4685
4731
|
}> | undefined;
|
|
4686
4732
|
documentUrl?: string | undefined;
|
|
4687
4733
|
integration?: string | null | undefined;
|
|
4688
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
4734
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
4689
4735
|
type: "collection";
|
|
4690
4736
|
uid: string;
|
|
4691
4737
|
children: string[];
|
|
@@ -4872,6 +4918,8 @@ declare const client: import("vue").Ref<{
|
|
|
4872
4918
|
url: string;
|
|
4873
4919
|
description?: string | undefined;
|
|
4874
4920
|
} | undefined;
|
|
4921
|
+
"x-internal"?: boolean | undefined;
|
|
4922
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
4875
4923
|
security?: Record<string, string[]>[] | undefined;
|
|
4876
4924
|
tags?: string[] | undefined;
|
|
4877
4925
|
deprecated?: boolean | undefined;
|
|
@@ -4909,6 +4957,8 @@ declare const client: import("vue").Ref<{
|
|
|
4909
4957
|
url: string;
|
|
4910
4958
|
description?: string | undefined;
|
|
4911
4959
|
} | undefined;
|
|
4960
|
+
"x-internal"?: boolean | undefined;
|
|
4961
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
4912
4962
|
security?: Record<string, string[]>[] | undefined;
|
|
4913
4963
|
tags?: string[] | undefined;
|
|
4914
4964
|
deprecated?: boolean | undefined;
|
|
@@ -4947,6 +4997,8 @@ declare const client: import("vue").Ref<{
|
|
|
4947
4997
|
url: string;
|
|
4948
4998
|
description?: string | undefined;
|
|
4949
4999
|
} | undefined;
|
|
5000
|
+
"x-internal"?: boolean | undefined;
|
|
5001
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
4950
5002
|
security?: Record<string, string[]>[] | undefined;
|
|
4951
5003
|
tags?: string[] | undefined;
|
|
4952
5004
|
deprecated?: boolean | undefined;
|
|
@@ -4969,7 +5021,7 @@ declare const client: import("vue").Ref<{
|
|
|
4969
5021
|
requestBody?: any;
|
|
4970
5022
|
responses?: Record<string, any> | undefined;
|
|
4971
5023
|
}) => void;
|
|
4972
|
-
edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
5024
|
+
edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | "method" | "path" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? {
|
|
4973
5025
|
path: string;
|
|
4974
5026
|
type: "request";
|
|
4975
5027
|
uid: string;
|
|
@@ -4984,6 +5036,8 @@ declare const client: import("vue").Ref<{
|
|
|
4984
5036
|
url: string;
|
|
4985
5037
|
description?: string | undefined;
|
|
4986
5038
|
} | undefined;
|
|
5039
|
+
"x-internal"?: boolean | undefined;
|
|
5040
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
4987
5041
|
security?: Record<string, string[]>[] | undefined;
|
|
4988
5042
|
tags?: string[] | undefined;
|
|
4989
5043
|
deprecated?: boolean | undefined;
|
|
@@ -5005,7 +5059,7 @@ declare const client: import("vue").Ref<{
|
|
|
5005
5059
|
}[] | undefined;
|
|
5006
5060
|
requestBody?: any;
|
|
5007
5061
|
responses?: Record<string, any> | undefined;
|
|
5008
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "
|
|
5062
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
5009
5063
|
path: string;
|
|
5010
5064
|
type: "request";
|
|
5011
5065
|
uid: string;
|
|
@@ -5020,6 +5074,8 @@ declare const client: import("vue").Ref<{
|
|
|
5020
5074
|
url: string;
|
|
5021
5075
|
description?: string | undefined;
|
|
5022
5076
|
} | undefined;
|
|
5077
|
+
"x-internal"?: boolean | undefined;
|
|
5078
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
5023
5079
|
security?: Record<string, string[]>[] | undefined;
|
|
5024
5080
|
tags?: string[] | undefined;
|
|
5025
5081
|
deprecated?: boolean | undefined;
|
|
@@ -5056,6 +5112,8 @@ declare const client: import("vue").Ref<{
|
|
|
5056
5112
|
url: string;
|
|
5057
5113
|
description?: string | undefined;
|
|
5058
5114
|
} | undefined;
|
|
5115
|
+
"x-internal"?: boolean | undefined;
|
|
5116
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
5059
5117
|
security?: Record<string, string[]>[] | undefined;
|
|
5060
5118
|
tags?: string[] | undefined;
|
|
5061
5119
|
deprecated?: boolean | undefined;
|
|
@@ -5078,7 +5136,7 @@ declare const client: import("vue").Ref<{
|
|
|
5078
5136
|
requestBody?: any;
|
|
5079
5137
|
responses?: Record<string, any> | undefined;
|
|
5080
5138
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
5081
|
-
untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
5139
|
+
untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | "method" | "path" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? {
|
|
5082
5140
|
path: string;
|
|
5083
5141
|
type: "request";
|
|
5084
5142
|
uid: string;
|
|
@@ -5093,6 +5151,8 @@ declare const client: import("vue").Ref<{
|
|
|
5093
5151
|
url: string;
|
|
5094
5152
|
description?: string | undefined;
|
|
5095
5153
|
} | undefined;
|
|
5154
|
+
"x-internal"?: boolean | undefined;
|
|
5155
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
5096
5156
|
security?: Record<string, string[]>[] | undefined;
|
|
5097
5157
|
tags?: string[] | undefined;
|
|
5098
5158
|
deprecated?: boolean | undefined;
|
|
@@ -5114,7 +5174,7 @@ declare const client: import("vue").Ref<{
|
|
|
5114
5174
|
}[] | undefined;
|
|
5115
5175
|
requestBody?: any;
|
|
5116
5176
|
responses?: Record<string, any> | undefined;
|
|
5117
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "
|
|
5177
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
5118
5178
|
path: string;
|
|
5119
5179
|
type: "request";
|
|
5120
5180
|
uid: string;
|
|
@@ -5129,6 +5189,8 @@ declare const client: import("vue").Ref<{
|
|
|
5129
5189
|
url: string;
|
|
5130
5190
|
description?: string | undefined;
|
|
5131
5191
|
} | undefined;
|
|
5192
|
+
"x-internal"?: boolean | undefined;
|
|
5193
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
5132
5194
|
security?: Record<string, string[]>[] | undefined;
|
|
5133
5195
|
tags?: string[] | undefined;
|
|
5134
5196
|
deprecated?: boolean | undefined;
|
|
@@ -5165,6 +5227,8 @@ declare const client: import("vue").Ref<{
|
|
|
5165
5227
|
url: string;
|
|
5166
5228
|
description?: string | undefined;
|
|
5167
5229
|
} | undefined;
|
|
5230
|
+
"x-internal"?: boolean | undefined;
|
|
5231
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
5168
5232
|
security?: Record<string, string[]>[] | undefined;
|
|
5169
5233
|
tags?: string[] | undefined;
|
|
5170
5234
|
deprecated?: boolean | undefined;
|
|
@@ -5197,33 +5261,6 @@ declare const client: import("vue").Ref<{
|
|
|
5197
5261
|
type: "requestExample";
|
|
5198
5262
|
uid: string;
|
|
5199
5263
|
name: string;
|
|
5200
|
-
body: {
|
|
5201
|
-
activeBody: "formData" | "binary" | "raw";
|
|
5202
|
-
formData?: {
|
|
5203
|
-
value: {
|
|
5204
|
-
value: string;
|
|
5205
|
-
key: string;
|
|
5206
|
-
enabled: boolean;
|
|
5207
|
-
minimum?: number | undefined;
|
|
5208
|
-
type?: string | undefined;
|
|
5209
|
-
maximum?: number | undefined;
|
|
5210
|
-
default?: any;
|
|
5211
|
-
required?: boolean | undefined;
|
|
5212
|
-
description?: string | undefined;
|
|
5213
|
-
enum?: string[] | undefined;
|
|
5214
|
-
format?: string | undefined;
|
|
5215
|
-
file?: any;
|
|
5216
|
-
nullable?: boolean | undefined;
|
|
5217
|
-
}[];
|
|
5218
|
-
encoding: "form-data" | "urlencoded";
|
|
5219
|
-
} | undefined;
|
|
5220
|
-
binary?: Blob | undefined;
|
|
5221
|
-
raw?: {
|
|
5222
|
-
value: string;
|
|
5223
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5224
|
-
} | undefined;
|
|
5225
|
-
};
|
|
5226
|
-
requestUid: string;
|
|
5227
5264
|
parameters: {
|
|
5228
5265
|
path: {
|
|
5229
5266
|
value: string;
|
|
@@ -5286,14 +5323,9 @@ declare const client: import("vue").Ref<{
|
|
|
5286
5323
|
nullable?: boolean | undefined;
|
|
5287
5324
|
}[];
|
|
5288
5325
|
};
|
|
5289
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5290
|
-
}) => void;
|
|
5291
|
-
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
5292
|
-
type: "requestExample";
|
|
5293
|
-
uid: string;
|
|
5294
|
-
name: string;
|
|
5295
5326
|
body: {
|
|
5296
|
-
activeBody: "
|
|
5327
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5328
|
+
binary?: Blob | undefined;
|
|
5297
5329
|
formData?: {
|
|
5298
5330
|
value: {
|
|
5299
5331
|
value: string;
|
|
@@ -5312,13 +5344,18 @@ declare const client: import("vue").Ref<{
|
|
|
5312
5344
|
}[];
|
|
5313
5345
|
encoding: "form-data" | "urlencoded";
|
|
5314
5346
|
} | undefined;
|
|
5315
|
-
binary?: Blob | undefined;
|
|
5316
5347
|
raw?: {
|
|
5317
5348
|
value: string;
|
|
5318
5349
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5319
5350
|
} | undefined;
|
|
5320
5351
|
};
|
|
5321
5352
|
requestUid: string;
|
|
5353
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5354
|
+
}) => void;
|
|
5355
|
+
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
5356
|
+
type: "requestExample";
|
|
5357
|
+
uid: string;
|
|
5358
|
+
name: string;
|
|
5322
5359
|
parameters: {
|
|
5323
5360
|
path: {
|
|
5324
5361
|
value: string;
|
|
@@ -5381,15 +5418,9 @@ declare const client: import("vue").Ref<{
|
|
|
5381
5418
|
nullable?: boolean | undefined;
|
|
5382
5419
|
}[];
|
|
5383
5420
|
};
|
|
5384
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5385
|
-
};
|
|
5386
|
-
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
5387
|
-
set: (item: {
|
|
5388
|
-
type: "requestExample";
|
|
5389
|
-
uid: string;
|
|
5390
|
-
name: string;
|
|
5391
5421
|
body: {
|
|
5392
|
-
activeBody: "
|
|
5422
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5423
|
+
binary?: Blob | undefined;
|
|
5393
5424
|
formData?: {
|
|
5394
5425
|
value: {
|
|
5395
5426
|
value: string;
|
|
@@ -5408,13 +5439,19 @@ declare const client: import("vue").Ref<{
|
|
|
5408
5439
|
}[];
|
|
5409
5440
|
encoding: "form-data" | "urlencoded";
|
|
5410
5441
|
} | undefined;
|
|
5411
|
-
binary?: Blob | undefined;
|
|
5412
5442
|
raw?: {
|
|
5413
5443
|
value: string;
|
|
5414
5444
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5415
5445
|
} | undefined;
|
|
5416
5446
|
};
|
|
5417
5447
|
requestUid: string;
|
|
5448
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5449
|
+
};
|
|
5450
|
+
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
5451
|
+
set: (item: {
|
|
5452
|
+
type: "requestExample";
|
|
5453
|
+
uid: string;
|
|
5454
|
+
name: string;
|
|
5418
5455
|
parameters: {
|
|
5419
5456
|
path: {
|
|
5420
5457
|
value: string;
|
|
@@ -5477,14 +5514,9 @@ declare const client: import("vue").Ref<{
|
|
|
5477
5514
|
nullable?: boolean | undefined;
|
|
5478
5515
|
}[];
|
|
5479
5516
|
};
|
|
5480
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5481
|
-
}) => void;
|
|
5482
|
-
edit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
|
|
5483
|
-
type: "requestExample";
|
|
5484
|
-
uid: string;
|
|
5485
|
-
name: string;
|
|
5486
5517
|
body: {
|
|
5487
|
-
activeBody: "
|
|
5518
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5519
|
+
binary?: Blob | undefined;
|
|
5488
5520
|
formData?: {
|
|
5489
5521
|
value: {
|
|
5490
5522
|
value: string;
|
|
@@ -5503,13 +5535,18 @@ declare const client: import("vue").Ref<{
|
|
|
5503
5535
|
}[];
|
|
5504
5536
|
encoding: "form-data" | "urlencoded";
|
|
5505
5537
|
} | undefined;
|
|
5506
|
-
binary?: Blob | undefined;
|
|
5507
5538
|
raw?: {
|
|
5508
5539
|
value: string;
|
|
5509
5540
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5510
5541
|
} | undefined;
|
|
5511
5542
|
};
|
|
5512
5543
|
requestUid: string;
|
|
5544
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5545
|
+
}) => void;
|
|
5546
|
+
edit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
|
|
5547
|
+
type: "requestExample";
|
|
5548
|
+
uid: string;
|
|
5549
|
+
name: string;
|
|
5513
5550
|
parameters: {
|
|
5514
5551
|
path: {
|
|
5515
5552
|
value: string;
|
|
@@ -5572,13 +5609,9 @@ declare const client: import("vue").Ref<{
|
|
|
5572
5609
|
nullable?: boolean | undefined;
|
|
5573
5610
|
}[];
|
|
5574
5611
|
};
|
|
5575
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5576
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
5577
|
-
type: "requestExample";
|
|
5578
|
-
uid: string;
|
|
5579
|
-
name: string;
|
|
5580
5612
|
body: {
|
|
5581
|
-
activeBody: "
|
|
5613
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5614
|
+
binary?: Blob | undefined;
|
|
5582
5615
|
formData?: {
|
|
5583
5616
|
value: {
|
|
5584
5617
|
value: string;
|
|
@@ -5597,13 +5630,17 @@ declare const client: import("vue").Ref<{
|
|
|
5597
5630
|
}[];
|
|
5598
5631
|
encoding: "form-data" | "urlencoded";
|
|
5599
5632
|
} | undefined;
|
|
5600
|
-
binary?: Blob | undefined;
|
|
5601
5633
|
raw?: {
|
|
5602
5634
|
value: string;
|
|
5603
5635
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5604
5636
|
} | undefined;
|
|
5605
5637
|
};
|
|
5606
5638
|
requestUid: string;
|
|
5639
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5640
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
5641
|
+
type: "requestExample";
|
|
5642
|
+
uid: string;
|
|
5643
|
+
name: string;
|
|
5607
5644
|
parameters: {
|
|
5608
5645
|
path: {
|
|
5609
5646
|
value: string;
|
|
@@ -5666,13 +5703,9 @@ declare const client: import("vue").Ref<{
|
|
|
5666
5703
|
nullable?: boolean | undefined;
|
|
5667
5704
|
}[];
|
|
5668
5705
|
};
|
|
5669
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5670
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
5671
|
-
type: "requestExample";
|
|
5672
|
-
uid: string;
|
|
5673
|
-
name: string;
|
|
5674
5706
|
body: {
|
|
5675
|
-
activeBody: "
|
|
5707
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5708
|
+
binary?: Blob | undefined;
|
|
5676
5709
|
formData?: {
|
|
5677
5710
|
value: {
|
|
5678
5711
|
value: string;
|
|
@@ -5691,13 +5724,17 @@ declare const client: import("vue").Ref<{
|
|
|
5691
5724
|
}[];
|
|
5692
5725
|
encoding: "form-data" | "urlencoded";
|
|
5693
5726
|
} | undefined;
|
|
5694
|
-
binary?: Blob | undefined;
|
|
5695
5727
|
raw?: {
|
|
5696
5728
|
value: string;
|
|
5697
5729
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5698
5730
|
} | undefined;
|
|
5699
5731
|
};
|
|
5700
5732
|
requestUid: string;
|
|
5733
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5734
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
5735
|
+
type: "requestExample";
|
|
5736
|
+
uid: string;
|
|
5737
|
+
name: string;
|
|
5701
5738
|
parameters: {
|
|
5702
5739
|
path: {
|
|
5703
5740
|
value: string;
|
|
@@ -5760,14 +5797,9 @@ declare const client: import("vue").Ref<{
|
|
|
5760
5797
|
nullable?: boolean | undefined;
|
|
5761
5798
|
}[];
|
|
5762
5799
|
};
|
|
5763
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5764
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
5765
|
-
untrackedEdit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
|
|
5766
|
-
type: "requestExample";
|
|
5767
|
-
uid: string;
|
|
5768
|
-
name: string;
|
|
5769
5800
|
body: {
|
|
5770
|
-
activeBody: "
|
|
5801
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5802
|
+
binary?: Blob | undefined;
|
|
5771
5803
|
formData?: {
|
|
5772
5804
|
value: {
|
|
5773
5805
|
value: string;
|
|
@@ -5786,13 +5818,18 @@ declare const client: import("vue").Ref<{
|
|
|
5786
5818
|
}[];
|
|
5787
5819
|
encoding: "form-data" | "urlencoded";
|
|
5788
5820
|
} | undefined;
|
|
5789
|
-
binary?: Blob | undefined;
|
|
5790
5821
|
raw?: {
|
|
5791
5822
|
value: string;
|
|
5792
5823
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5793
5824
|
} | undefined;
|
|
5794
5825
|
};
|
|
5795
5826
|
requestUid: string;
|
|
5827
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5828
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
5829
|
+
untrackedEdit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
|
|
5830
|
+
type: "requestExample";
|
|
5831
|
+
uid: string;
|
|
5832
|
+
name: string;
|
|
5796
5833
|
parameters: {
|
|
5797
5834
|
path: {
|
|
5798
5835
|
value: string;
|
|
@@ -5855,13 +5892,9 @@ declare const client: import("vue").Ref<{
|
|
|
5855
5892
|
nullable?: boolean | undefined;
|
|
5856
5893
|
}[];
|
|
5857
5894
|
};
|
|
5858
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5859
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
5860
|
-
type: "requestExample";
|
|
5861
|
-
uid: string;
|
|
5862
|
-
name: string;
|
|
5863
5895
|
body: {
|
|
5864
|
-
activeBody: "
|
|
5896
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5897
|
+
binary?: Blob | undefined;
|
|
5865
5898
|
formData?: {
|
|
5866
5899
|
value: {
|
|
5867
5900
|
value: string;
|
|
@@ -5880,13 +5913,17 @@ declare const client: import("vue").Ref<{
|
|
|
5880
5913
|
}[];
|
|
5881
5914
|
encoding: "form-data" | "urlencoded";
|
|
5882
5915
|
} | undefined;
|
|
5883
|
-
binary?: Blob | undefined;
|
|
5884
5916
|
raw?: {
|
|
5885
5917
|
value: string;
|
|
5886
5918
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5887
5919
|
} | undefined;
|
|
5888
5920
|
};
|
|
5889
5921
|
requestUid: string;
|
|
5922
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5923
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
5924
|
+
type: "requestExample";
|
|
5925
|
+
uid: string;
|
|
5926
|
+
name: string;
|
|
5890
5927
|
parameters: {
|
|
5891
5928
|
path: {
|
|
5892
5929
|
value: string;
|
|
@@ -5949,13 +5986,9 @@ declare const client: import("vue").Ref<{
|
|
|
5949
5986
|
nullable?: boolean | undefined;
|
|
5950
5987
|
}[];
|
|
5951
5988
|
};
|
|
5952
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5953
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
5954
|
-
type: "requestExample";
|
|
5955
|
-
uid: string;
|
|
5956
|
-
name: string;
|
|
5957
5989
|
body: {
|
|
5958
|
-
activeBody: "
|
|
5990
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5991
|
+
binary?: Blob | undefined;
|
|
5959
5992
|
formData?: {
|
|
5960
5993
|
value: {
|
|
5961
5994
|
value: string;
|
|
@@ -5974,13 +6007,17 @@ declare const client: import("vue").Ref<{
|
|
|
5974
6007
|
}[];
|
|
5975
6008
|
encoding: "form-data" | "urlencoded";
|
|
5976
6009
|
} | undefined;
|
|
5977
|
-
binary?: Blob | undefined;
|
|
5978
6010
|
raw?: {
|
|
5979
6011
|
value: string;
|
|
5980
6012
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5981
6013
|
} | undefined;
|
|
5982
6014
|
};
|
|
5983
6015
|
requestUid: string;
|
|
6016
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
6017
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6018
|
+
type: "requestExample";
|
|
6019
|
+
uid: string;
|
|
6020
|
+
name: string;
|
|
5984
6021
|
parameters: {
|
|
5985
6022
|
path: {
|
|
5986
6023
|
value: string;
|
|
@@ -6043,6 +6080,33 @@ declare const client: import("vue").Ref<{
|
|
|
6043
6080
|
nullable?: boolean | undefined;
|
|
6044
6081
|
}[];
|
|
6045
6082
|
};
|
|
6083
|
+
body: {
|
|
6084
|
+
activeBody: "binary" | "formData" | "raw";
|
|
6085
|
+
binary?: Blob | undefined;
|
|
6086
|
+
formData?: {
|
|
6087
|
+
value: {
|
|
6088
|
+
value: string;
|
|
6089
|
+
key: string;
|
|
6090
|
+
enabled: boolean;
|
|
6091
|
+
minimum?: number | undefined;
|
|
6092
|
+
type?: string | undefined;
|
|
6093
|
+
maximum?: number | undefined;
|
|
6094
|
+
default?: any;
|
|
6095
|
+
required?: boolean | undefined;
|
|
6096
|
+
description?: string | undefined;
|
|
6097
|
+
enum?: string[] | undefined;
|
|
6098
|
+
format?: string | undefined;
|
|
6099
|
+
file?: any;
|
|
6100
|
+
nullable?: boolean | undefined;
|
|
6101
|
+
}[];
|
|
6102
|
+
encoding: "form-data" | "urlencoded";
|
|
6103
|
+
} | undefined;
|
|
6104
|
+
raw?: {
|
|
6105
|
+
value: string;
|
|
6106
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
6107
|
+
} | undefined;
|
|
6108
|
+
};
|
|
6109
|
+
requestUid: string;
|
|
6046
6110
|
serverVariables?: Record<string, string[]> | undefined;
|
|
6047
6111
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
6048
6112
|
undo: (uid: string) => void;
|
|
@@ -6832,6 +6896,8 @@ declare const client: import("vue").Ref<{
|
|
|
6832
6896
|
"x-scalar-children"?: {
|
|
6833
6897
|
tagName: string;
|
|
6834
6898
|
}[] | undefined;
|
|
6899
|
+
"x-internal"?: boolean | undefined;
|
|
6900
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
6835
6901
|
}) => void;
|
|
6836
6902
|
add: (payload: import("@scalar/oas-utils/entities/spec").TagPayload, collectionUid: string) => void | {
|
|
6837
6903
|
type: "tag";
|
|
@@ -6846,6 +6912,8 @@ declare const client: import("vue").Ref<{
|
|
|
6846
6912
|
"x-scalar-children"?: {
|
|
6847
6913
|
tagName: string;
|
|
6848
6914
|
}[] | undefined;
|
|
6915
|
+
"x-internal"?: boolean | undefined;
|
|
6916
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
6849
6917
|
};
|
|
6850
6918
|
delete: (tag: import("@scalar/oas-utils/entities/spec").Tag, collectionUid: string) => void;
|
|
6851
6919
|
set: (item: {
|
|
@@ -6861,8 +6929,10 @@ declare const client: import("vue").Ref<{
|
|
|
6861
6929
|
"x-scalar-children"?: {
|
|
6862
6930
|
tagName: string;
|
|
6863
6931
|
}[] | undefined;
|
|
6932
|
+
"x-internal"?: boolean | undefined;
|
|
6933
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
6864
6934
|
}) => void;
|
|
6865
|
-
edit: <P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
|
|
6935
|
+
edit: <P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
|
|
6866
6936
|
type: "tag";
|
|
6867
6937
|
uid: string;
|
|
6868
6938
|
name: string;
|
|
@@ -6875,7 +6945,9 @@ declare const client: import("vue").Ref<{
|
|
|
6875
6945
|
"x-scalar-children"?: {
|
|
6876
6946
|
tagName: string;
|
|
6877
6947
|
}[] | undefined;
|
|
6878
|
-
|
|
6948
|
+
"x-internal"?: boolean | undefined;
|
|
6949
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
6950
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
6879
6951
|
type: "tag";
|
|
6880
6952
|
uid: string;
|
|
6881
6953
|
name: string;
|
|
@@ -6888,6 +6960,8 @@ declare const client: import("vue").Ref<{
|
|
|
6888
6960
|
"x-scalar-children"?: {
|
|
6889
6961
|
tagName: string;
|
|
6890
6962
|
}[] | undefined;
|
|
6963
|
+
"x-internal"?: boolean | undefined;
|
|
6964
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
6891
6965
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6892
6966
|
type: "tag";
|
|
6893
6967
|
uid: string;
|
|
@@ -6901,8 +6975,10 @@ declare const client: import("vue").Ref<{
|
|
|
6901
6975
|
"x-scalar-children"?: {
|
|
6902
6976
|
tagName: string;
|
|
6903
6977
|
}[] | undefined;
|
|
6978
|
+
"x-internal"?: boolean | undefined;
|
|
6979
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
6904
6980
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
6905
|
-
untrackedEdit: <P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
|
|
6981
|
+
untrackedEdit: <P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
|
|
6906
6982
|
type: "tag";
|
|
6907
6983
|
uid: string;
|
|
6908
6984
|
name: string;
|
|
@@ -6915,7 +6991,9 @@ declare const client: import("vue").Ref<{
|
|
|
6915
6991
|
"x-scalar-children"?: {
|
|
6916
6992
|
tagName: string;
|
|
6917
6993
|
}[] | undefined;
|
|
6918
|
-
|
|
6994
|
+
"x-internal"?: boolean | undefined;
|
|
6995
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
6996
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
6919
6997
|
type: "tag";
|
|
6920
6998
|
uid: string;
|
|
6921
6999
|
name: string;
|
|
@@ -6928,6 +7006,8 @@ declare const client: import("vue").Ref<{
|
|
|
6928
7006
|
"x-scalar-children"?: {
|
|
6929
7007
|
tagName: string;
|
|
6930
7008
|
}[] | undefined;
|
|
7009
|
+
"x-internal"?: boolean | undefined;
|
|
7010
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
6931
7011
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6932
7012
|
type: "tag";
|
|
6933
7013
|
uid: string;
|
|
@@ -6941,6 +7021,8 @@ declare const client: import("vue").Ref<{
|
|
|
6941
7021
|
"x-scalar-children"?: {
|
|
6942
7022
|
tagName: string;
|
|
6943
7023
|
}[] | undefined;
|
|
7024
|
+
"x-internal"?: boolean | undefined;
|
|
7025
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
6944
7026
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
6945
7027
|
undo: (uid: string) => void;
|
|
6946
7028
|
redo: (uid: string) => void;
|