@scalar/api-client-react 1.1.11 → 1.1.13
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 +21 -0
- package/dist/index.d.ts +228 -187
- package/dist/style.css +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -149,6 +149,8 @@ export declare const useApiClientModal: () => {
|
|
|
149
149
|
"x-scalar-children"?: {
|
|
150
150
|
tagName: string;
|
|
151
151
|
}[] | undefined;
|
|
152
|
+
"x-internal"?: boolean | undefined;
|
|
153
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
152
154
|
}>;
|
|
153
155
|
cookies: Record<string, {
|
|
154
156
|
value: string;
|
|
@@ -174,33 +176,6 @@ export declare const useApiClientModal: () => {
|
|
|
174
176
|
type: "requestExample";
|
|
175
177
|
uid: string;
|
|
176
178
|
name: string;
|
|
177
|
-
body: {
|
|
178
|
-
activeBody: "formData" | "binary" | "raw";
|
|
179
|
-
formData?: {
|
|
180
|
-
value: {
|
|
181
|
-
value: string;
|
|
182
|
-
key: string;
|
|
183
|
-
enabled: boolean;
|
|
184
|
-
minimum?: number | undefined;
|
|
185
|
-
type?: string | undefined;
|
|
186
|
-
maximum?: number | undefined;
|
|
187
|
-
default?: any;
|
|
188
|
-
required?: boolean | undefined;
|
|
189
|
-
description?: string | undefined;
|
|
190
|
-
enum?: string[] | undefined;
|
|
191
|
-
format?: string | undefined;
|
|
192
|
-
file?: any;
|
|
193
|
-
nullable?: boolean | undefined;
|
|
194
|
-
}[];
|
|
195
|
-
encoding: "form-data" | "urlencoded";
|
|
196
|
-
} | undefined;
|
|
197
|
-
binary?: Blob | undefined;
|
|
198
|
-
raw?: {
|
|
199
|
-
value: string;
|
|
200
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
201
|
-
} | undefined;
|
|
202
|
-
};
|
|
203
|
-
requestUid: string;
|
|
204
179
|
parameters: {
|
|
205
180
|
path: {
|
|
206
181
|
value: string;
|
|
@@ -263,6 +238,33 @@ export declare const useApiClientModal: () => {
|
|
|
263
238
|
nullable?: boolean | undefined;
|
|
264
239
|
}[];
|
|
265
240
|
};
|
|
241
|
+
body: {
|
|
242
|
+
activeBody: "binary" | "formData" | "raw";
|
|
243
|
+
binary?: Blob | undefined;
|
|
244
|
+
formData?: {
|
|
245
|
+
value: {
|
|
246
|
+
value: string;
|
|
247
|
+
key: string;
|
|
248
|
+
enabled: boolean;
|
|
249
|
+
minimum?: number | undefined;
|
|
250
|
+
type?: string | undefined;
|
|
251
|
+
maximum?: number | undefined;
|
|
252
|
+
default?: any;
|
|
253
|
+
required?: boolean | undefined;
|
|
254
|
+
description?: string | undefined;
|
|
255
|
+
enum?: string[] | undefined;
|
|
256
|
+
format?: string | undefined;
|
|
257
|
+
file?: any;
|
|
258
|
+
nullable?: boolean | undefined;
|
|
259
|
+
}[];
|
|
260
|
+
encoding: "form-data" | "urlencoded";
|
|
261
|
+
} | undefined;
|
|
262
|
+
raw?: {
|
|
263
|
+
value: string;
|
|
264
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
265
|
+
} | undefined;
|
|
266
|
+
};
|
|
267
|
+
requestUid: string;
|
|
266
268
|
serverVariables?: Record<string, string[]> | undefined;
|
|
267
269
|
}>;
|
|
268
270
|
requests: Record<string, {
|
|
@@ -280,6 +282,8 @@ export declare const useApiClientModal: () => {
|
|
|
280
282
|
url: string;
|
|
281
283
|
description?: string | undefined;
|
|
282
284
|
} | undefined;
|
|
285
|
+
"x-internal"?: boolean | undefined;
|
|
286
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
283
287
|
security?: Record<string, string[]>[] | undefined;
|
|
284
288
|
tags?: string[] | undefined;
|
|
285
289
|
deprecated?: boolean | undefined;
|
|
@@ -405,6 +409,7 @@ export declare const useApiClientModal: () => {
|
|
|
405
409
|
isReadOnly: boolean;
|
|
406
410
|
hideClientButton: boolean | undefined;
|
|
407
411
|
showSidebar: boolean;
|
|
412
|
+
integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
|
|
408
413
|
importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
|
|
409
414
|
type?: "collection" | undefined;
|
|
410
415
|
uid?: string | undefined;
|
|
@@ -961,7 +966,7 @@ export declare const useApiClientModal: () => {
|
|
|
961
966
|
documentUrl?: string | undefined;
|
|
962
967
|
integration?: string | null | undefined;
|
|
963
968
|
}) => void;
|
|
964
|
-
edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
969
|
+
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" ? {
|
|
965
970
|
type: "collection";
|
|
966
971
|
uid: string;
|
|
967
972
|
children: string[];
|
|
@@ -1015,7 +1020,7 @@ export declare const useApiClientModal: () => {
|
|
|
1015
1020
|
}> | undefined;
|
|
1016
1021
|
documentUrl?: string | undefined;
|
|
1017
1022
|
integration?: string | null | undefined;
|
|
1018
|
-
}[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" | "
|
|
1023
|
+
}[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 Path< {
|
|
1019
1024
|
type: "collection";
|
|
1020
1025
|
uid: string;
|
|
1021
1026
|
children: string[];
|
|
@@ -1124,7 +1129,7 @@ export declare const useApiClientModal: () => {
|
|
|
1124
1129
|
documentUrl?: string | undefined;
|
|
1125
1130
|
integration?: string | null | undefined;
|
|
1126
1131
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1127
|
-
untrackedEdit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
1132
|
+
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" ? {
|
|
1128
1133
|
type: "collection";
|
|
1129
1134
|
uid: string;
|
|
1130
1135
|
children: string[];
|
|
@@ -1178,7 +1183,7 @@ export declare const useApiClientModal: () => {
|
|
|
1178
1183
|
}> | undefined;
|
|
1179
1184
|
documentUrl?: string | undefined;
|
|
1180
1185
|
integration?: string | null | undefined;
|
|
1181
|
-
}[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" | "
|
|
1186
|
+
}[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 Path< {
|
|
1182
1187
|
type: "collection";
|
|
1183
1188
|
uid: string;
|
|
1184
1189
|
children: string[];
|
|
@@ -1365,6 +1370,8 @@ export declare const useApiClientModal: () => {
|
|
|
1365
1370
|
url: string;
|
|
1366
1371
|
description?: string | undefined;
|
|
1367
1372
|
} | undefined;
|
|
1373
|
+
"x-internal"?: boolean | undefined;
|
|
1374
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1368
1375
|
security?: Record<string, string[]>[] | undefined;
|
|
1369
1376
|
tags?: string[] | undefined;
|
|
1370
1377
|
deprecated?: boolean | undefined;
|
|
@@ -1402,6 +1409,8 @@ export declare const useApiClientModal: () => {
|
|
|
1402
1409
|
url: string;
|
|
1403
1410
|
description?: string | undefined;
|
|
1404
1411
|
} | undefined;
|
|
1412
|
+
"x-internal"?: boolean | undefined;
|
|
1413
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1405
1414
|
security?: Record<string, string[]>[] | undefined;
|
|
1406
1415
|
tags?: string[] | undefined;
|
|
1407
1416
|
deprecated?: boolean | undefined;
|
|
@@ -1440,6 +1449,8 @@ export declare const useApiClientModal: () => {
|
|
|
1440
1449
|
url: string;
|
|
1441
1450
|
description?: string | undefined;
|
|
1442
1451
|
} | undefined;
|
|
1452
|
+
"x-internal"?: boolean | undefined;
|
|
1453
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1443
1454
|
security?: Record<string, string[]>[] | undefined;
|
|
1444
1455
|
tags?: string[] | undefined;
|
|
1445
1456
|
deprecated?: boolean | undefined;
|
|
@@ -1462,7 +1473,7 @@ export declare const useApiClientModal: () => {
|
|
|
1462
1473
|
requestBody?: any;
|
|
1463
1474
|
responses?: Record<string, any> | undefined;
|
|
1464
1475
|
}) => void;
|
|
1465
|
-
edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
1476
|
+
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" ? {
|
|
1466
1477
|
path: string;
|
|
1467
1478
|
type: "request";
|
|
1468
1479
|
uid: string;
|
|
@@ -1477,6 +1488,8 @@ export declare const useApiClientModal: () => {
|
|
|
1477
1488
|
url: string;
|
|
1478
1489
|
description?: string | undefined;
|
|
1479
1490
|
} | undefined;
|
|
1491
|
+
"x-internal"?: boolean | undefined;
|
|
1492
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1480
1493
|
security?: Record<string, string[]>[] | undefined;
|
|
1481
1494
|
tags?: string[] | undefined;
|
|
1482
1495
|
deprecated?: boolean | undefined;
|
|
@@ -1498,7 +1511,7 @@ export declare const useApiClientModal: () => {
|
|
|
1498
1511
|
}[] | undefined;
|
|
1499
1512
|
requestBody?: any;
|
|
1500
1513
|
responses?: Record<string, any> | undefined;
|
|
1501
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "
|
|
1514
|
+
}[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 Path< {
|
|
1502
1515
|
path: string;
|
|
1503
1516
|
type: "request";
|
|
1504
1517
|
uid: string;
|
|
@@ -1513,6 +1526,8 @@ export declare const useApiClientModal: () => {
|
|
|
1513
1526
|
url: string;
|
|
1514
1527
|
description?: string | undefined;
|
|
1515
1528
|
} | undefined;
|
|
1529
|
+
"x-internal"?: boolean | undefined;
|
|
1530
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1516
1531
|
security?: Record<string, string[]>[] | undefined;
|
|
1517
1532
|
tags?: string[] | undefined;
|
|
1518
1533
|
deprecated?: boolean | undefined;
|
|
@@ -1549,6 +1564,8 @@ export declare const useApiClientModal: () => {
|
|
|
1549
1564
|
url: string;
|
|
1550
1565
|
description?: string | undefined;
|
|
1551
1566
|
} | undefined;
|
|
1567
|
+
"x-internal"?: boolean | undefined;
|
|
1568
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1552
1569
|
security?: Record<string, string[]>[] | undefined;
|
|
1553
1570
|
tags?: string[] | undefined;
|
|
1554
1571
|
deprecated?: boolean | undefined;
|
|
@@ -1571,7 +1588,7 @@ export declare const useApiClientModal: () => {
|
|
|
1571
1588
|
requestBody?: any;
|
|
1572
1589
|
responses?: Record<string, any> | undefined;
|
|
1573
1590
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1574
|
-
untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
1591
|
+
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" ? {
|
|
1575
1592
|
path: string;
|
|
1576
1593
|
type: "request";
|
|
1577
1594
|
uid: string;
|
|
@@ -1586,6 +1603,8 @@ export declare const useApiClientModal: () => {
|
|
|
1586
1603
|
url: string;
|
|
1587
1604
|
description?: string | undefined;
|
|
1588
1605
|
} | undefined;
|
|
1606
|
+
"x-internal"?: boolean | undefined;
|
|
1607
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1589
1608
|
security?: Record<string, string[]>[] | undefined;
|
|
1590
1609
|
tags?: string[] | undefined;
|
|
1591
1610
|
deprecated?: boolean | undefined;
|
|
@@ -1607,7 +1626,7 @@ export declare const useApiClientModal: () => {
|
|
|
1607
1626
|
}[] | undefined;
|
|
1608
1627
|
requestBody?: any;
|
|
1609
1628
|
responses?: Record<string, any> | undefined;
|
|
1610
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "
|
|
1629
|
+
}[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 Path< {
|
|
1611
1630
|
path: string;
|
|
1612
1631
|
type: "request";
|
|
1613
1632
|
uid: string;
|
|
@@ -1622,6 +1641,8 @@ export declare const useApiClientModal: () => {
|
|
|
1622
1641
|
url: string;
|
|
1623
1642
|
description?: string | undefined;
|
|
1624
1643
|
} | undefined;
|
|
1644
|
+
"x-internal"?: boolean | undefined;
|
|
1645
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1625
1646
|
security?: Record<string, string[]>[] | undefined;
|
|
1626
1647
|
tags?: string[] | undefined;
|
|
1627
1648
|
deprecated?: boolean | undefined;
|
|
@@ -1658,6 +1679,8 @@ export declare const useApiClientModal: () => {
|
|
|
1658
1679
|
url: string;
|
|
1659
1680
|
description?: string | undefined;
|
|
1660
1681
|
} | undefined;
|
|
1682
|
+
"x-internal"?: boolean | undefined;
|
|
1683
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
1661
1684
|
security?: Record<string, string[]>[] | undefined;
|
|
1662
1685
|
tags?: string[] | undefined;
|
|
1663
1686
|
deprecated?: boolean | undefined;
|
|
@@ -1690,33 +1713,6 @@ export declare const useApiClientModal: () => {
|
|
|
1690
1713
|
type: "requestExample";
|
|
1691
1714
|
uid: string;
|
|
1692
1715
|
name: string;
|
|
1693
|
-
body: {
|
|
1694
|
-
activeBody: "formData" | "binary" | "raw";
|
|
1695
|
-
formData?: {
|
|
1696
|
-
value: {
|
|
1697
|
-
value: string;
|
|
1698
|
-
key: string;
|
|
1699
|
-
enabled: boolean;
|
|
1700
|
-
minimum?: number | undefined;
|
|
1701
|
-
type?: string | undefined;
|
|
1702
|
-
maximum?: number | undefined;
|
|
1703
|
-
default?: any;
|
|
1704
|
-
required?: boolean | undefined;
|
|
1705
|
-
description?: string | undefined;
|
|
1706
|
-
enum?: string[] | undefined;
|
|
1707
|
-
format?: string | undefined;
|
|
1708
|
-
file?: any;
|
|
1709
|
-
nullable?: boolean | undefined;
|
|
1710
|
-
}[];
|
|
1711
|
-
encoding: "form-data" | "urlencoded";
|
|
1712
|
-
} | undefined;
|
|
1713
|
-
binary?: Blob | undefined;
|
|
1714
|
-
raw?: {
|
|
1715
|
-
value: string;
|
|
1716
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1717
|
-
} | undefined;
|
|
1718
|
-
};
|
|
1719
|
-
requestUid: string;
|
|
1720
1716
|
parameters: {
|
|
1721
1717
|
path: {
|
|
1722
1718
|
value: string;
|
|
@@ -1779,14 +1775,9 @@ export declare const useApiClientModal: () => {
|
|
|
1779
1775
|
nullable?: boolean | undefined;
|
|
1780
1776
|
}[];
|
|
1781
1777
|
};
|
|
1782
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1783
|
-
}) => void;
|
|
1784
|
-
add: (request: Request_2, _name?: string) => {
|
|
1785
|
-
type: "requestExample";
|
|
1786
|
-
uid: string;
|
|
1787
|
-
name: string;
|
|
1788
1778
|
body: {
|
|
1789
|
-
activeBody: "
|
|
1779
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1780
|
+
binary?: Blob | undefined;
|
|
1790
1781
|
formData?: {
|
|
1791
1782
|
value: {
|
|
1792
1783
|
value: string;
|
|
@@ -1805,13 +1796,18 @@ export declare const useApiClientModal: () => {
|
|
|
1805
1796
|
}[];
|
|
1806
1797
|
encoding: "form-data" | "urlencoded";
|
|
1807
1798
|
} | undefined;
|
|
1808
|
-
binary?: Blob | undefined;
|
|
1809
1799
|
raw?: {
|
|
1810
1800
|
value: string;
|
|
1811
1801
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1812
1802
|
} | undefined;
|
|
1813
1803
|
};
|
|
1814
1804
|
requestUid: string;
|
|
1805
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1806
|
+
}) => void;
|
|
1807
|
+
add: (request: Request_2, _name?: string) => {
|
|
1808
|
+
type: "requestExample";
|
|
1809
|
+
uid: string;
|
|
1810
|
+
name: string;
|
|
1815
1811
|
parameters: {
|
|
1816
1812
|
path: {
|
|
1817
1813
|
value: string;
|
|
@@ -1874,15 +1870,9 @@ export declare const useApiClientModal: () => {
|
|
|
1874
1870
|
nullable?: boolean | undefined;
|
|
1875
1871
|
}[];
|
|
1876
1872
|
};
|
|
1877
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1878
|
-
};
|
|
1879
|
-
delete: (requestExample: RequestExample) => void;
|
|
1880
|
-
set: (item: {
|
|
1881
|
-
type: "requestExample";
|
|
1882
|
-
uid: string;
|
|
1883
|
-
name: string;
|
|
1884
1873
|
body: {
|
|
1885
|
-
activeBody: "
|
|
1874
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1875
|
+
binary?: Blob | undefined;
|
|
1886
1876
|
formData?: {
|
|
1887
1877
|
value: {
|
|
1888
1878
|
value: string;
|
|
@@ -1901,13 +1891,19 @@ export declare const useApiClientModal: () => {
|
|
|
1901
1891
|
}[];
|
|
1902
1892
|
encoding: "form-data" | "urlencoded";
|
|
1903
1893
|
} | undefined;
|
|
1904
|
-
binary?: Blob | undefined;
|
|
1905
1894
|
raw?: {
|
|
1906
1895
|
value: string;
|
|
1907
1896
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1908
1897
|
} | undefined;
|
|
1909
1898
|
};
|
|
1910
1899
|
requestUid: string;
|
|
1900
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1901
|
+
};
|
|
1902
|
+
delete: (requestExample: RequestExample) => void;
|
|
1903
|
+
set: (item: {
|
|
1904
|
+
type: "requestExample";
|
|
1905
|
+
uid: string;
|
|
1906
|
+
name: string;
|
|
1911
1907
|
parameters: {
|
|
1912
1908
|
path: {
|
|
1913
1909
|
value: string;
|
|
@@ -1970,14 +1966,9 @@ export declare const useApiClientModal: () => {
|
|
|
1970
1966
|
nullable?: boolean | undefined;
|
|
1971
1967
|
}[];
|
|
1972
1968
|
};
|
|
1973
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1974
|
-
}) => void;
|
|
1975
|
-
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" ? {
|
|
1976
|
-
type: "requestExample";
|
|
1977
|
-
uid: string;
|
|
1978
|
-
name: string;
|
|
1979
1969
|
body: {
|
|
1980
|
-
activeBody: "
|
|
1970
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1971
|
+
binary?: Blob | undefined;
|
|
1981
1972
|
formData?: {
|
|
1982
1973
|
value: {
|
|
1983
1974
|
value: string;
|
|
@@ -1996,13 +1987,18 @@ export declare const useApiClientModal: () => {
|
|
|
1996
1987
|
}[];
|
|
1997
1988
|
encoding: "form-data" | "urlencoded";
|
|
1998
1989
|
} | undefined;
|
|
1999
|
-
binary?: Blob | undefined;
|
|
2000
1990
|
raw?: {
|
|
2001
1991
|
value: string;
|
|
2002
1992
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2003
1993
|
} | undefined;
|
|
2004
1994
|
};
|
|
2005
1995
|
requestUid: string;
|
|
1996
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1997
|
+
}) => void;
|
|
1998
|
+
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" ? {
|
|
1999
|
+
type: "requestExample";
|
|
2000
|
+
uid: string;
|
|
2001
|
+
name: string;
|
|
2006
2002
|
parameters: {
|
|
2007
2003
|
path: {
|
|
2008
2004
|
value: string;
|
|
@@ -2065,38 +2061,38 @@ export declare const useApiClientModal: () => {
|
|
|
2065
2061
|
nullable?: boolean | undefined;
|
|
2066
2062
|
}[];
|
|
2067
2063
|
};
|
|
2064
|
+
body: {
|
|
2065
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2066
|
+
binary?: Blob | undefined;
|
|
2067
|
+
formData?: {
|
|
2068
|
+
value: {
|
|
2069
|
+
value: string;
|
|
2070
|
+
key: string;
|
|
2071
|
+
enabled: boolean;
|
|
2072
|
+
minimum?: number | undefined;
|
|
2073
|
+
type?: string | undefined;
|
|
2074
|
+
maximum?: number | undefined;
|
|
2075
|
+
default?: any;
|
|
2076
|
+
required?: boolean | undefined;
|
|
2077
|
+
description?: string | undefined;
|
|
2078
|
+
enum?: string[] | undefined;
|
|
2079
|
+
format?: string | undefined;
|
|
2080
|
+
file?: any;
|
|
2081
|
+
nullable?: boolean | undefined;
|
|
2082
|
+
}[];
|
|
2083
|
+
encoding: "form-data" | "urlencoded";
|
|
2084
|
+
} | undefined;
|
|
2085
|
+
raw?: {
|
|
2086
|
+
value: string;
|
|
2087
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2088
|
+
} | undefined;
|
|
2089
|
+
};
|
|
2090
|
+
requestUid: string;
|
|
2068
2091
|
serverVariables?: Record<string, string[]> | undefined;
|
|
2069
2092
|
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path< {
|
|
2070
2093
|
type: "requestExample";
|
|
2071
2094
|
uid: string;
|
|
2072
2095
|
name: string;
|
|
2073
|
-
body: {
|
|
2074
|
-
activeBody: "formData" | "binary" | "raw";
|
|
2075
|
-
formData?: {
|
|
2076
|
-
value: {
|
|
2077
|
-
value: string;
|
|
2078
|
-
key: string;
|
|
2079
|
-
enabled: boolean;
|
|
2080
|
-
minimum?: number | undefined;
|
|
2081
|
-
type?: string | undefined;
|
|
2082
|
-
maximum?: number | undefined;
|
|
2083
|
-
default?: any;
|
|
2084
|
-
required?: boolean | undefined;
|
|
2085
|
-
description?: string | undefined;
|
|
2086
|
-
enum?: string[] | undefined;
|
|
2087
|
-
format?: string | undefined;
|
|
2088
|
-
file?: any;
|
|
2089
|
-
nullable?: boolean | undefined;
|
|
2090
|
-
}[];
|
|
2091
|
-
encoding: "form-data" | "urlencoded";
|
|
2092
|
-
} | undefined;
|
|
2093
|
-
binary?: Blob | undefined;
|
|
2094
|
-
raw?: {
|
|
2095
|
-
value: string;
|
|
2096
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2097
|
-
} | undefined;
|
|
2098
|
-
};
|
|
2099
|
-
requestUid: string;
|
|
2100
2096
|
parameters: {
|
|
2101
2097
|
path: {
|
|
2102
2098
|
value: string;
|
|
@@ -2159,13 +2155,9 @@ export declare const useApiClientModal: () => {
|
|
|
2159
2155
|
nullable?: boolean | undefined;
|
|
2160
2156
|
}[];
|
|
2161
2157
|
};
|
|
2162
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2163
|
-
}[K]> ? PathValue< {
|
|
2164
|
-
type: "requestExample";
|
|
2165
|
-
uid: string;
|
|
2166
|
-
name: string;
|
|
2167
2158
|
body: {
|
|
2168
|
-
activeBody: "
|
|
2159
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2160
|
+
binary?: Blob | undefined;
|
|
2169
2161
|
formData?: {
|
|
2170
2162
|
value: {
|
|
2171
2163
|
value: string;
|
|
@@ -2184,13 +2176,17 @@ export declare const useApiClientModal: () => {
|
|
|
2184
2176
|
}[];
|
|
2185
2177
|
encoding: "form-data" | "urlencoded";
|
|
2186
2178
|
} | undefined;
|
|
2187
|
-
binary?: Blob | undefined;
|
|
2188
2179
|
raw?: {
|
|
2189
2180
|
value: string;
|
|
2190
2181
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2191
2182
|
} | undefined;
|
|
2192
2183
|
};
|
|
2193
2184
|
requestUid: string;
|
|
2185
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2186
|
+
}[K]> ? PathValue< {
|
|
2187
|
+
type: "requestExample";
|
|
2188
|
+
uid: string;
|
|
2189
|
+
name: string;
|
|
2194
2190
|
parameters: {
|
|
2195
2191
|
path: {
|
|
2196
2192
|
value: string;
|
|
@@ -2253,39 +2249,39 @@ export declare const useApiClientModal: () => {
|
|
|
2253
2249
|
nullable?: boolean | undefined;
|
|
2254
2250
|
}[];
|
|
2255
2251
|
};
|
|
2252
|
+
body: {
|
|
2253
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2254
|
+
binary?: Blob | undefined;
|
|
2255
|
+
formData?: {
|
|
2256
|
+
value: {
|
|
2257
|
+
value: string;
|
|
2258
|
+
key: string;
|
|
2259
|
+
enabled: boolean;
|
|
2260
|
+
minimum?: number | undefined;
|
|
2261
|
+
type?: string | undefined;
|
|
2262
|
+
maximum?: number | undefined;
|
|
2263
|
+
default?: any;
|
|
2264
|
+
required?: boolean | undefined;
|
|
2265
|
+
description?: string | undefined;
|
|
2266
|
+
enum?: string[] | undefined;
|
|
2267
|
+
format?: string | undefined;
|
|
2268
|
+
file?: any;
|
|
2269
|
+
nullable?: boolean | undefined;
|
|
2270
|
+
}[];
|
|
2271
|
+
encoding: "form-data" | "urlencoded";
|
|
2272
|
+
} | undefined;
|
|
2273
|
+
raw?: {
|
|
2274
|
+
value: string;
|
|
2275
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2276
|
+
} | undefined;
|
|
2277
|
+
};
|
|
2278
|
+
requestUid: string;
|
|
2256
2279
|
serverVariables?: Record<string, string[]> | undefined;
|
|
2257
2280
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2258
|
-
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}` |
|
|
2281
|
+
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" ? {
|
|
2259
2282
|
type: "requestExample";
|
|
2260
2283
|
uid: string;
|
|
2261
2284
|
name: string;
|
|
2262
|
-
body: {
|
|
2263
|
-
activeBody: "formData" | "binary" | "raw";
|
|
2264
|
-
formData?: {
|
|
2265
|
-
value: {
|
|
2266
|
-
value: string;
|
|
2267
|
-
key: string;
|
|
2268
|
-
enabled: boolean;
|
|
2269
|
-
minimum?: number | undefined;
|
|
2270
|
-
type?: string | undefined;
|
|
2271
|
-
maximum?: number | undefined;
|
|
2272
|
-
default?: any;
|
|
2273
|
-
required?: boolean | undefined;
|
|
2274
|
-
description?: string | undefined;
|
|
2275
|
-
enum?: string[] | undefined;
|
|
2276
|
-
format?: string | undefined;
|
|
2277
|
-
file?: any;
|
|
2278
|
-
nullable?: boolean | undefined;
|
|
2279
|
-
}[];
|
|
2280
|
-
encoding: "form-data" | "urlencoded";
|
|
2281
|
-
} | undefined;
|
|
2282
|
-
binary?: Blob | undefined;
|
|
2283
|
-
raw?: {
|
|
2284
|
-
value: string;
|
|
2285
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2286
|
-
} | undefined;
|
|
2287
|
-
};
|
|
2288
|
-
requestUid: string;
|
|
2289
2285
|
parameters: {
|
|
2290
2286
|
path: {
|
|
2291
2287
|
value: string;
|
|
@@ -2348,38 +2344,38 @@ export declare const useApiClientModal: () => {
|
|
|
2348
2344
|
nullable?: boolean | undefined;
|
|
2349
2345
|
}[];
|
|
2350
2346
|
};
|
|
2347
|
+
body: {
|
|
2348
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2349
|
+
binary?: Blob | undefined;
|
|
2350
|
+
formData?: {
|
|
2351
|
+
value: {
|
|
2352
|
+
value: string;
|
|
2353
|
+
key: string;
|
|
2354
|
+
enabled: boolean;
|
|
2355
|
+
minimum?: number | undefined;
|
|
2356
|
+
type?: string | undefined;
|
|
2357
|
+
maximum?: number | undefined;
|
|
2358
|
+
default?: any;
|
|
2359
|
+
required?: boolean | undefined;
|
|
2360
|
+
description?: string | undefined;
|
|
2361
|
+
enum?: string[] | undefined;
|
|
2362
|
+
format?: string | undefined;
|
|
2363
|
+
file?: any;
|
|
2364
|
+
nullable?: boolean | undefined;
|
|
2365
|
+
}[];
|
|
2366
|
+
encoding: "form-data" | "urlencoded";
|
|
2367
|
+
} | undefined;
|
|
2368
|
+
raw?: {
|
|
2369
|
+
value: string;
|
|
2370
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2371
|
+
} | undefined;
|
|
2372
|
+
};
|
|
2373
|
+
requestUid: string;
|
|
2351
2374
|
serverVariables?: Record<string, string[]> | undefined;
|
|
2352
2375
|
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path< {
|
|
2353
2376
|
type: "requestExample";
|
|
2354
2377
|
uid: string;
|
|
2355
2378
|
name: string;
|
|
2356
|
-
body: {
|
|
2357
|
-
activeBody: "formData" | "binary" | "raw";
|
|
2358
|
-
formData?: {
|
|
2359
|
-
value: {
|
|
2360
|
-
value: string;
|
|
2361
|
-
key: string;
|
|
2362
|
-
enabled: boolean;
|
|
2363
|
-
minimum?: number | undefined;
|
|
2364
|
-
type?: string | undefined;
|
|
2365
|
-
maximum?: number | undefined;
|
|
2366
|
-
default?: any;
|
|
2367
|
-
required?: boolean | undefined;
|
|
2368
|
-
description?: string | undefined;
|
|
2369
|
-
enum?: string[] | undefined;
|
|
2370
|
-
format?: string | undefined;
|
|
2371
|
-
file?: any;
|
|
2372
|
-
nullable?: boolean | undefined;
|
|
2373
|
-
}[];
|
|
2374
|
-
encoding: "form-data" | "urlencoded";
|
|
2375
|
-
} | undefined;
|
|
2376
|
-
binary?: Blob | undefined;
|
|
2377
|
-
raw?: {
|
|
2378
|
-
value: string;
|
|
2379
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2380
|
-
} | undefined;
|
|
2381
|
-
};
|
|
2382
|
-
requestUid: string;
|
|
2383
2379
|
parameters: {
|
|
2384
2380
|
path: {
|
|
2385
2381
|
value: string;
|
|
@@ -2442,13 +2438,9 @@ export declare const useApiClientModal: () => {
|
|
|
2442
2438
|
nullable?: boolean | undefined;
|
|
2443
2439
|
}[];
|
|
2444
2440
|
};
|
|
2445
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2446
|
-
}[K]> ? PathValue< {
|
|
2447
|
-
type: "requestExample";
|
|
2448
|
-
uid: string;
|
|
2449
|
-
name: string;
|
|
2450
2441
|
body: {
|
|
2451
|
-
activeBody: "
|
|
2442
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2443
|
+
binary?: Blob | undefined;
|
|
2452
2444
|
formData?: {
|
|
2453
2445
|
value: {
|
|
2454
2446
|
value: string;
|
|
@@ -2467,13 +2459,17 @@ export declare const useApiClientModal: () => {
|
|
|
2467
2459
|
}[];
|
|
2468
2460
|
encoding: "form-data" | "urlencoded";
|
|
2469
2461
|
} | undefined;
|
|
2470
|
-
binary?: Blob | undefined;
|
|
2471
2462
|
raw?: {
|
|
2472
2463
|
value: string;
|
|
2473
2464
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2474
2465
|
} | undefined;
|
|
2475
2466
|
};
|
|
2476
2467
|
requestUid: string;
|
|
2468
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2469
|
+
}[K]> ? PathValue< {
|
|
2470
|
+
type: "requestExample";
|
|
2471
|
+
uid: string;
|
|
2472
|
+
name: string;
|
|
2477
2473
|
parameters: {
|
|
2478
2474
|
path: {
|
|
2479
2475
|
value: string;
|
|
@@ -2536,6 +2532,33 @@ export declare const useApiClientModal: () => {
|
|
|
2536
2532
|
nullable?: boolean | undefined;
|
|
2537
2533
|
}[];
|
|
2538
2534
|
};
|
|
2535
|
+
body: {
|
|
2536
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2537
|
+
binary?: Blob | undefined;
|
|
2538
|
+
formData?: {
|
|
2539
|
+
value: {
|
|
2540
|
+
value: string;
|
|
2541
|
+
key: string;
|
|
2542
|
+
enabled: boolean;
|
|
2543
|
+
minimum?: number | undefined;
|
|
2544
|
+
type?: string | undefined;
|
|
2545
|
+
maximum?: number | undefined;
|
|
2546
|
+
default?: any;
|
|
2547
|
+
required?: boolean | undefined;
|
|
2548
|
+
description?: string | undefined;
|
|
2549
|
+
enum?: string[] | undefined;
|
|
2550
|
+
format?: string | undefined;
|
|
2551
|
+
file?: any;
|
|
2552
|
+
nullable?: boolean | undefined;
|
|
2553
|
+
}[];
|
|
2554
|
+
encoding: "form-data" | "urlencoded";
|
|
2555
|
+
} | undefined;
|
|
2556
|
+
raw?: {
|
|
2557
|
+
value: string;
|
|
2558
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2559
|
+
} | undefined;
|
|
2560
|
+
};
|
|
2561
|
+
requestUid: string;
|
|
2539
2562
|
serverVariables?: Record<string, string[]> | undefined;
|
|
2540
2563
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2541
2564
|
undo: (uid: string) => void;
|
|
@@ -3326,6 +3349,8 @@ export declare const useApiClientModal: () => {
|
|
|
3326
3349
|
"x-scalar-children"?: {
|
|
3327
3350
|
tagName: string;
|
|
3328
3351
|
}[] | undefined;
|
|
3352
|
+
"x-internal"?: boolean | undefined;
|
|
3353
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3329
3354
|
}) => void;
|
|
3330
3355
|
add: (payload: TagPayload, collectionUid: string) => void | {
|
|
3331
3356
|
type: "tag";
|
|
@@ -3340,6 +3365,8 @@ export declare const useApiClientModal: () => {
|
|
|
3340
3365
|
"x-scalar-children"?: {
|
|
3341
3366
|
tagName: string;
|
|
3342
3367
|
}[] | undefined;
|
|
3368
|
+
"x-internal"?: boolean | undefined;
|
|
3369
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3343
3370
|
};
|
|
3344
3371
|
delete: (tag: Tag, collectionUid: string) => void;
|
|
3345
3372
|
set: (item: {
|
|
@@ -3355,8 +3382,10 @@ export declare const useApiClientModal: () => {
|
|
|
3355
3382
|
"x-scalar-children"?: {
|
|
3356
3383
|
tagName: string;
|
|
3357
3384
|
}[] | undefined;
|
|
3385
|
+
"x-internal"?: boolean | undefined;
|
|
3386
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3358
3387
|
}) => void;
|
|
3359
|
-
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" ? {
|
|
3388
|
+
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" ? {
|
|
3360
3389
|
type: "tag";
|
|
3361
3390
|
uid: string;
|
|
3362
3391
|
name: string;
|
|
@@ -3369,7 +3398,9 @@ export declare const useApiClientModal: () => {
|
|
|
3369
3398
|
"x-scalar-children"?: {
|
|
3370
3399
|
tagName: string;
|
|
3371
3400
|
}[] | undefined;
|
|
3372
|
-
|
|
3401
|
+
"x-internal"?: boolean | undefined;
|
|
3402
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3403
|
+
}[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 Path< {
|
|
3373
3404
|
type: "tag";
|
|
3374
3405
|
uid: string;
|
|
3375
3406
|
name: string;
|
|
@@ -3382,6 +3413,8 @@ export declare const useApiClientModal: () => {
|
|
|
3382
3413
|
"x-scalar-children"?: {
|
|
3383
3414
|
tagName: string;
|
|
3384
3415
|
}[] | undefined;
|
|
3416
|
+
"x-internal"?: boolean | undefined;
|
|
3417
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3385
3418
|
}[K]> ? PathValue< {
|
|
3386
3419
|
type: "tag";
|
|
3387
3420
|
uid: string;
|
|
@@ -3395,8 +3428,10 @@ export declare const useApiClientModal: () => {
|
|
|
3395
3428
|
"x-scalar-children"?: {
|
|
3396
3429
|
tagName: string;
|
|
3397
3430
|
}[] | undefined;
|
|
3431
|
+
"x-internal"?: boolean | undefined;
|
|
3432
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3398
3433
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3399
|
-
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" ? {
|
|
3434
|
+
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" ? {
|
|
3400
3435
|
type: "tag";
|
|
3401
3436
|
uid: string;
|
|
3402
3437
|
name: string;
|
|
@@ -3409,7 +3444,9 @@ export declare const useApiClientModal: () => {
|
|
|
3409
3444
|
"x-scalar-children"?: {
|
|
3410
3445
|
tagName: string;
|
|
3411
3446
|
}[] | undefined;
|
|
3412
|
-
|
|
3447
|
+
"x-internal"?: boolean | undefined;
|
|
3448
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3449
|
+
}[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 Path< {
|
|
3413
3450
|
type: "tag";
|
|
3414
3451
|
uid: string;
|
|
3415
3452
|
name: string;
|
|
@@ -3422,6 +3459,8 @@ export declare const useApiClientModal: () => {
|
|
|
3422
3459
|
"x-scalar-children"?: {
|
|
3423
3460
|
tagName: string;
|
|
3424
3461
|
}[] | undefined;
|
|
3462
|
+
"x-internal"?: boolean | undefined;
|
|
3463
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3425
3464
|
}[K]> ? PathValue< {
|
|
3426
3465
|
type: "tag";
|
|
3427
3466
|
uid: string;
|
|
@@ -3435,6 +3474,8 @@ export declare const useApiClientModal: () => {
|
|
|
3435
3474
|
"x-scalar-children"?: {
|
|
3436
3475
|
tagName: string;
|
|
3437
3476
|
}[] | undefined;
|
|
3477
|
+
"x-internal"?: boolean | undefined;
|
|
3478
|
+
"x-scalar-ignore"?: boolean | undefined;
|
|
3438
3479
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3439
3480
|
undo: (uid: string) => void;
|
|
3440
3481
|
redo: (uid: string) => void;
|