@scalar/api-client 2.2.31 → 2.2.33
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 +36 -0
- package/dist/components/CommandPalette/CommandPaletteServer.vue.d.ts +9 -3
- package/dist/components/CommandPalette/CommandPaletteServer.vue.d.ts.map +1 -1
- package/dist/components/CommandPalette/CommandPaletteServer.vue.js +62 -54
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts +13 -3
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts.map +1 -1
- package/dist/components/DataTable/DataTable.vue.js +7 -7
- package/dist/components/DataTable/DataTableCell.vue.js +6 -6
- package/dist/components/Form/Form.vue.d.ts.map +1 -1
- package/dist/components/Form/Form.vue.js +5 -5
- package/dist/components/ImportCollection/ImportCollectionModal.vue.d.ts.map +1 -1
- package/dist/components/ImportCollection/ImportCollectionModal.vue.js +72 -71
- package/dist/components/ImportCollection/WorkspaceSelector.vue.d.ts.map +1 -1
- package/dist/components/ImportCollection/WorkspaceSelector.vue.js +23 -22
- package/dist/components/Search/useSearch.d.ts.map +1 -1
- package/dist/components/Search/useSearch.js +61 -48
- package/dist/components/SideNav/SideNavLink.vue.js +2 -2
- package/dist/components/Sidebar/Sidebar.vue.js +2 -2
- package/dist/components/Sidebar/Sidebar.vue2.js +5 -5
- package/dist/components/Sidebar/SidebarList.vue.js +1 -1
- package/dist/components/Sidebar/SidebarListElement.vue.d.ts +1 -1
- package/dist/components/Sidebar/SidebarListElement.vue.d.ts.map +1 -1
- package/dist/components/Sidebar/SidebarListElement.vue.js +2 -2
- package/dist/components/Sidebar/SidebarListElement.vue2.js +12 -12
- package/dist/components/ViewLayout/ViewLayoutCollapse.vue.d.ts.map +1 -1
- package/dist/components/ViewLayout/ViewLayoutCollapse.vue.js +1 -1
- package/dist/components/ViewLayout/ViewLayoutSection.vue.d.ts.map +1 -1
- package/dist/components/ViewLayout/ViewLayoutSection.vue.js +1 -1
- package/dist/constants.d.ts +4 -0
- package/dist/constants.d.ts.map +1 -1
- package/dist/constants.js +2 -2
- package/dist/layouts/App/create-api-client-app.d.ts +168 -127
- package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
- package/dist/layouts/Modal/create-api-client-modal.d.ts +336 -254
- package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
- package/dist/layouts/Web/create-api-client-web.d.ts +168 -127
- package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
- package/dist/libs/create-client.d.ts +169 -128
- package/dist/libs/create-client.d.ts.map +1 -1
- package/dist/libs/create-client.js +8 -7
- package/dist/libs/find-request.d.ts +2 -0
- package/dist/libs/find-request.d.ts.map +1 -1
- package/dist/libs/send-request/send-request.d.ts.map +1 -1
- package/dist/libs/send-request/send-request.js +114 -116
- package/dist/routes.d.ts +1 -0
- package/dist/routes.d.ts.map +1 -1
- package/dist/routes.js +12 -7
- package/dist/store/active-entities.d.ts +29 -27
- package/dist/store/active-entities.d.ts.map +1 -1
- package/dist/store/collections.d.ts +4 -4
- package/dist/store/request-example.d.ts +134 -134
- package/dist/store/request-example.d.ts.map +1 -1
- package/dist/store/requests.d.ts +26 -4
- package/dist/store/requests.d.ts.map +1 -1
- package/dist/store/store.d.ts +171 -128
- package/dist/store/store.d.ts.map +1 -1
- package/dist/store/store.js +48 -46
- package/dist/store/tags.d.ts +24 -4
- package/dist/store/tags.d.ts.map +1 -1
- package/dist/style.css +1 -1
- package/dist/views/Cookies/CookieForm.vue.d.ts.map +1 -1
- package/dist/views/Cookies/CookieForm.vue.js +12 -12
- package/dist/views/Cookies/Cookies.vue2.js +12 -12
- package/dist/views/Environment/Environment.vue.d.ts.map +1 -1
- package/dist/views/Environment/Environment.vue2.js +98 -97
- package/dist/views/Environment/EnvironmentModal.vue.js +1 -1
- package/dist/views/Environment/EnvironmentVariableDropdown.vue.js +6 -6
- package/dist/views/Request/RequestSidebar.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSidebar.vue.js +3 -3
- package/dist/views/Request/RequestSidebar.vue2.js +14 -14
- package/dist/views/Request/RequestSidebarItem.vue.d.ts +2 -2
- package/dist/views/Request/RequestSidebarItem.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSidebarItem.vue.js +2 -2
- package/dist/views/Request/RequestSidebarItem.vue2.js +132 -125
- package/dist/views/Request/RequestSubpageHeader.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSubpageHeader.vue.js +1 -1
- package/dist/views/Request/RequestSubpageHeader.vue2.js +21 -21
- package/dist/views/Request/ResponseSection/ResponseEmpty.vue.d.ts.map +1 -1
- package/dist/views/Request/ResponseSection/ResponseEmpty.vue.js +1 -1
- package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +12 -12
- package/dist/views/Servers/ServerForm.vue.d.ts +8 -1
- package/dist/views/Servers/ServerForm.vue.d.ts.map +1 -1
- package/dist/views/Servers/ServerForm.vue.js +28 -59
- package/dist/views/Servers/Servers.vue.d.ts.map +1 -1
- package/dist/views/Servers/Servers.vue2.js +141 -53
- package/package.json +12 -12
|
@@ -110,6 +110,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
110
110
|
'x-scalar-children'?: {
|
|
111
111
|
tagName: string;
|
|
112
112
|
}[] | undefined;
|
|
113
|
+
'x-internal'?: boolean | undefined;
|
|
114
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
113
115
|
}>;
|
|
114
116
|
cookies: Record<string, {
|
|
115
117
|
value: string;
|
|
@@ -135,33 +137,6 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
135
137
|
type: "requestExample";
|
|
136
138
|
uid: string;
|
|
137
139
|
name: string;
|
|
138
|
-
body: {
|
|
139
|
-
activeBody: "formData" | "binary" | "raw";
|
|
140
|
-
formData?: {
|
|
141
|
-
value: {
|
|
142
|
-
value: string;
|
|
143
|
-
key: string;
|
|
144
|
-
enabled: boolean;
|
|
145
|
-
minimum?: number | undefined;
|
|
146
|
-
type?: string | undefined;
|
|
147
|
-
maximum?: number | undefined;
|
|
148
|
-
default?: any;
|
|
149
|
-
required?: boolean | undefined;
|
|
150
|
-
description?: string | undefined;
|
|
151
|
-
enum?: string[] | undefined;
|
|
152
|
-
format?: string | undefined;
|
|
153
|
-
file?: any;
|
|
154
|
-
nullable?: boolean | undefined;
|
|
155
|
-
}[];
|
|
156
|
-
encoding: "form-data" | "urlencoded";
|
|
157
|
-
} | undefined;
|
|
158
|
-
binary?: Blob | undefined;
|
|
159
|
-
raw?: {
|
|
160
|
-
value: string;
|
|
161
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
162
|
-
} | undefined;
|
|
163
|
-
};
|
|
164
|
-
requestUid: string;
|
|
165
140
|
parameters: {
|
|
166
141
|
path: {
|
|
167
142
|
value: string;
|
|
@@ -224,6 +199,33 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
224
199
|
nullable?: boolean | undefined;
|
|
225
200
|
}[];
|
|
226
201
|
};
|
|
202
|
+
body: {
|
|
203
|
+
activeBody: "binary" | "formData" | "raw";
|
|
204
|
+
binary?: Blob | undefined;
|
|
205
|
+
formData?: {
|
|
206
|
+
value: {
|
|
207
|
+
value: string;
|
|
208
|
+
key: string;
|
|
209
|
+
enabled: boolean;
|
|
210
|
+
minimum?: number | undefined;
|
|
211
|
+
type?: string | undefined;
|
|
212
|
+
maximum?: number | undefined;
|
|
213
|
+
default?: any;
|
|
214
|
+
required?: boolean | undefined;
|
|
215
|
+
description?: string | undefined;
|
|
216
|
+
enum?: string[] | undefined;
|
|
217
|
+
format?: string | undefined;
|
|
218
|
+
file?: any;
|
|
219
|
+
nullable?: boolean | undefined;
|
|
220
|
+
}[];
|
|
221
|
+
encoding: "form-data" | "urlencoded";
|
|
222
|
+
} | undefined;
|
|
223
|
+
raw?: {
|
|
224
|
+
value: string;
|
|
225
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
226
|
+
} | undefined;
|
|
227
|
+
};
|
|
228
|
+
requestUid: string;
|
|
227
229
|
serverVariables?: Record<string, string[]> | undefined;
|
|
228
230
|
}>;
|
|
229
231
|
requests: Record<string, {
|
|
@@ -241,6 +243,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
241
243
|
url: string;
|
|
242
244
|
description?: string | undefined;
|
|
243
245
|
} | undefined;
|
|
246
|
+
'x-internal'?: boolean | undefined;
|
|
247
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
244
248
|
security?: Record<string, string[]>[] | undefined;
|
|
245
249
|
tags?: string[] | undefined;
|
|
246
250
|
deprecated?: boolean | undefined;
|
|
@@ -366,6 +370,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
366
370
|
isReadOnly: boolean;
|
|
367
371
|
hideClientButton: boolean | undefined;
|
|
368
372
|
showSidebar: boolean;
|
|
373
|
+
integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
|
|
369
374
|
importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
|
|
370
375
|
type?: "collection" | undefined;
|
|
371
376
|
uid?: string | undefined;
|
|
@@ -922,7 +927,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
922
927
|
documentUrl?: string | undefined;
|
|
923
928
|
integration?: string | null | undefined;
|
|
924
929
|
}) => void;
|
|
925
|
-
edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
930
|
+
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" ? {
|
|
926
931
|
type: "collection";
|
|
927
932
|
uid: string;
|
|
928
933
|
children: string[];
|
|
@@ -976,7 +981,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
976
981
|
}> | undefined;
|
|
977
982
|
documentUrl?: string | undefined;
|
|
978
983
|
integration?: string | null | undefined;
|
|
979
|
-
}[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" | "
|
|
984
|
+
}[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<{
|
|
980
985
|
type: "collection";
|
|
981
986
|
uid: string;
|
|
982
987
|
children: string[];
|
|
@@ -1085,7 +1090,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1085
1090
|
documentUrl?: string | undefined;
|
|
1086
1091
|
integration?: string | null | undefined;
|
|
1087
1092
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1088
|
-
untrackedEdit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
1093
|
+
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" ? {
|
|
1089
1094
|
type: "collection";
|
|
1090
1095
|
uid: string;
|
|
1091
1096
|
children: string[];
|
|
@@ -1139,7 +1144,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1139
1144
|
}> | undefined;
|
|
1140
1145
|
documentUrl?: string | undefined;
|
|
1141
1146
|
integration?: string | null | undefined;
|
|
1142
|
-
}[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" | "
|
|
1147
|
+
}[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<{
|
|
1143
1148
|
type: "collection";
|
|
1144
1149
|
uid: string;
|
|
1145
1150
|
children: string[];
|
|
@@ -1326,6 +1331,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1326
1331
|
url: string;
|
|
1327
1332
|
description?: string | undefined;
|
|
1328
1333
|
} | undefined;
|
|
1334
|
+
'x-internal'?: boolean | undefined;
|
|
1335
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1329
1336
|
security?: Record<string, string[]>[] | undefined;
|
|
1330
1337
|
tags?: string[] | undefined;
|
|
1331
1338
|
deprecated?: boolean | undefined;
|
|
@@ -1363,6 +1370,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1363
1370
|
url: string;
|
|
1364
1371
|
description?: string | undefined;
|
|
1365
1372
|
} | undefined;
|
|
1373
|
+
'x-internal'?: boolean | undefined;
|
|
1374
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1366
1375
|
security?: Record<string, string[]>[] | undefined;
|
|
1367
1376
|
tags?: string[] | undefined;
|
|
1368
1377
|
deprecated?: boolean | undefined;
|
|
@@ -1401,6 +1410,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1401
1410
|
url: string;
|
|
1402
1411
|
description?: string | undefined;
|
|
1403
1412
|
} | undefined;
|
|
1413
|
+
'x-internal'?: boolean | undefined;
|
|
1414
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1404
1415
|
security?: Record<string, string[]>[] | undefined;
|
|
1405
1416
|
tags?: string[] | undefined;
|
|
1406
1417
|
deprecated?: boolean | undefined;
|
|
@@ -1423,7 +1434,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1423
1434
|
requestBody?: any;
|
|
1424
1435
|
responses?: Record<string, any> | undefined;
|
|
1425
1436
|
}) => void;
|
|
1426
|
-
edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
1437
|
+
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" ? {
|
|
1427
1438
|
path: string;
|
|
1428
1439
|
type: "request";
|
|
1429
1440
|
uid: string;
|
|
@@ -1438,6 +1449,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1438
1449
|
url: string;
|
|
1439
1450
|
description?: string | undefined;
|
|
1440
1451
|
} | undefined;
|
|
1452
|
+
'x-internal'?: boolean | undefined;
|
|
1453
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1441
1454
|
security?: Record<string, string[]>[] | undefined;
|
|
1442
1455
|
tags?: string[] | undefined;
|
|
1443
1456
|
deprecated?: boolean | undefined;
|
|
@@ -1459,7 +1472,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1459
1472
|
}[] | undefined;
|
|
1460
1473
|
requestBody?: any;
|
|
1461
1474
|
responses?: Record<string, any> | undefined;
|
|
1462
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "
|
|
1475
|
+
}[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<{
|
|
1463
1476
|
path: string;
|
|
1464
1477
|
type: "request";
|
|
1465
1478
|
uid: string;
|
|
@@ -1474,6 +1487,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1474
1487
|
url: string;
|
|
1475
1488
|
description?: string | undefined;
|
|
1476
1489
|
} | undefined;
|
|
1490
|
+
'x-internal'?: boolean | undefined;
|
|
1491
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1477
1492
|
security?: Record<string, string[]>[] | undefined;
|
|
1478
1493
|
tags?: string[] | undefined;
|
|
1479
1494
|
deprecated?: boolean | undefined;
|
|
@@ -1510,6 +1525,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1510
1525
|
url: string;
|
|
1511
1526
|
description?: string | undefined;
|
|
1512
1527
|
} | undefined;
|
|
1528
|
+
'x-internal'?: boolean | undefined;
|
|
1529
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1513
1530
|
security?: Record<string, string[]>[] | undefined;
|
|
1514
1531
|
tags?: string[] | undefined;
|
|
1515
1532
|
deprecated?: boolean | undefined;
|
|
@@ -1532,7 +1549,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1532
1549
|
requestBody?: any;
|
|
1533
1550
|
responses?: Record<string, any> | undefined;
|
|
1534
1551
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1535
|
-
untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
1552
|
+
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" ? {
|
|
1536
1553
|
path: string;
|
|
1537
1554
|
type: "request";
|
|
1538
1555
|
uid: string;
|
|
@@ -1547,6 +1564,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1547
1564
|
url: string;
|
|
1548
1565
|
description?: string | undefined;
|
|
1549
1566
|
} | undefined;
|
|
1567
|
+
'x-internal'?: boolean | undefined;
|
|
1568
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1550
1569
|
security?: Record<string, string[]>[] | undefined;
|
|
1551
1570
|
tags?: string[] | undefined;
|
|
1552
1571
|
deprecated?: boolean | undefined;
|
|
@@ -1568,7 +1587,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1568
1587
|
}[] | undefined;
|
|
1569
1588
|
requestBody?: any;
|
|
1570
1589
|
responses?: Record<string, any> | undefined;
|
|
1571
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "
|
|
1590
|
+
}[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<{
|
|
1572
1591
|
path: string;
|
|
1573
1592
|
type: "request";
|
|
1574
1593
|
uid: string;
|
|
@@ -1583,6 +1602,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1583
1602
|
url: string;
|
|
1584
1603
|
description?: string | undefined;
|
|
1585
1604
|
} | undefined;
|
|
1605
|
+
'x-internal'?: boolean | undefined;
|
|
1606
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1586
1607
|
security?: Record<string, string[]>[] | undefined;
|
|
1587
1608
|
tags?: string[] | undefined;
|
|
1588
1609
|
deprecated?: boolean | undefined;
|
|
@@ -1619,6 +1640,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1619
1640
|
url: string;
|
|
1620
1641
|
description?: string | undefined;
|
|
1621
1642
|
} | undefined;
|
|
1643
|
+
'x-internal'?: boolean | undefined;
|
|
1644
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1622
1645
|
security?: Record<string, string[]>[] | undefined;
|
|
1623
1646
|
tags?: string[] | undefined;
|
|
1624
1647
|
deprecated?: boolean | undefined;
|
|
@@ -1651,33 +1674,6 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1651
1674
|
type: "requestExample";
|
|
1652
1675
|
uid: string;
|
|
1653
1676
|
name: string;
|
|
1654
|
-
body: {
|
|
1655
|
-
activeBody: "formData" | "binary" | "raw";
|
|
1656
|
-
formData?: {
|
|
1657
|
-
value: {
|
|
1658
|
-
value: string;
|
|
1659
|
-
key: string;
|
|
1660
|
-
enabled: boolean;
|
|
1661
|
-
minimum?: number | undefined;
|
|
1662
|
-
type?: string | undefined;
|
|
1663
|
-
maximum?: number | undefined;
|
|
1664
|
-
default?: any;
|
|
1665
|
-
required?: boolean | undefined;
|
|
1666
|
-
description?: string | undefined;
|
|
1667
|
-
enum?: string[] | undefined;
|
|
1668
|
-
format?: string | undefined;
|
|
1669
|
-
file?: any;
|
|
1670
|
-
nullable?: boolean | undefined;
|
|
1671
|
-
}[];
|
|
1672
|
-
encoding: "form-data" | "urlencoded";
|
|
1673
|
-
} | undefined;
|
|
1674
|
-
binary?: Blob | undefined;
|
|
1675
|
-
raw?: {
|
|
1676
|
-
value: string;
|
|
1677
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1678
|
-
} | undefined;
|
|
1679
|
-
};
|
|
1680
|
-
requestUid: string;
|
|
1681
1677
|
parameters: {
|
|
1682
1678
|
path: {
|
|
1683
1679
|
value: string;
|
|
@@ -1740,14 +1736,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1740
1736
|
nullable?: boolean | undefined;
|
|
1741
1737
|
}[];
|
|
1742
1738
|
};
|
|
1743
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1744
|
-
}) => void;
|
|
1745
|
-
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
1746
|
-
type: "requestExample";
|
|
1747
|
-
uid: string;
|
|
1748
|
-
name: string;
|
|
1749
1739
|
body: {
|
|
1750
|
-
activeBody: "
|
|
1740
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1741
|
+
binary?: Blob | undefined;
|
|
1751
1742
|
formData?: {
|
|
1752
1743
|
value: {
|
|
1753
1744
|
value: string;
|
|
@@ -1766,13 +1757,18 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1766
1757
|
}[];
|
|
1767
1758
|
encoding: "form-data" | "urlencoded";
|
|
1768
1759
|
} | undefined;
|
|
1769
|
-
binary?: Blob | undefined;
|
|
1770
1760
|
raw?: {
|
|
1771
1761
|
value: string;
|
|
1772
1762
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1773
1763
|
} | undefined;
|
|
1774
1764
|
};
|
|
1775
1765
|
requestUid: string;
|
|
1766
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1767
|
+
}) => void;
|
|
1768
|
+
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
1769
|
+
type: "requestExample";
|
|
1770
|
+
uid: string;
|
|
1771
|
+
name: string;
|
|
1776
1772
|
parameters: {
|
|
1777
1773
|
path: {
|
|
1778
1774
|
value: string;
|
|
@@ -1835,15 +1831,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1835
1831
|
nullable?: boolean | undefined;
|
|
1836
1832
|
}[];
|
|
1837
1833
|
};
|
|
1838
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1839
|
-
};
|
|
1840
|
-
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
1841
|
-
set: (item: {
|
|
1842
|
-
type: "requestExample";
|
|
1843
|
-
uid: string;
|
|
1844
|
-
name: string;
|
|
1845
1834
|
body: {
|
|
1846
|
-
activeBody: "
|
|
1835
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1836
|
+
binary?: Blob | undefined;
|
|
1847
1837
|
formData?: {
|
|
1848
1838
|
value: {
|
|
1849
1839
|
value: string;
|
|
@@ -1862,13 +1852,19 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1862
1852
|
}[];
|
|
1863
1853
|
encoding: "form-data" | "urlencoded";
|
|
1864
1854
|
} | undefined;
|
|
1865
|
-
binary?: Blob | undefined;
|
|
1866
1855
|
raw?: {
|
|
1867
1856
|
value: string;
|
|
1868
1857
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1869
1858
|
} | undefined;
|
|
1870
1859
|
};
|
|
1871
1860
|
requestUid: string;
|
|
1861
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1862
|
+
};
|
|
1863
|
+
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
1864
|
+
set: (item: {
|
|
1865
|
+
type: "requestExample";
|
|
1866
|
+
uid: string;
|
|
1867
|
+
name: string;
|
|
1872
1868
|
parameters: {
|
|
1873
1869
|
path: {
|
|
1874
1870
|
value: string;
|
|
@@ -1931,14 +1927,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1931
1927
|
nullable?: boolean | undefined;
|
|
1932
1928
|
}[];
|
|
1933
1929
|
};
|
|
1934
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1935
|
-
}) => void;
|
|
1936
|
-
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" ? {
|
|
1937
|
-
type: "requestExample";
|
|
1938
|
-
uid: string;
|
|
1939
|
-
name: string;
|
|
1940
1930
|
body: {
|
|
1941
|
-
activeBody: "
|
|
1931
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1932
|
+
binary?: Blob | undefined;
|
|
1942
1933
|
formData?: {
|
|
1943
1934
|
value: {
|
|
1944
1935
|
value: string;
|
|
@@ -1957,13 +1948,18 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1957
1948
|
}[];
|
|
1958
1949
|
encoding: "form-data" | "urlencoded";
|
|
1959
1950
|
} | undefined;
|
|
1960
|
-
binary?: Blob | undefined;
|
|
1961
1951
|
raw?: {
|
|
1962
1952
|
value: string;
|
|
1963
1953
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1964
1954
|
} | undefined;
|
|
1965
1955
|
};
|
|
1966
1956
|
requestUid: string;
|
|
1957
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1958
|
+
}) => void;
|
|
1959
|
+
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" ? {
|
|
1960
|
+
type: "requestExample";
|
|
1961
|
+
uid: string;
|
|
1962
|
+
name: string;
|
|
1967
1963
|
parameters: {
|
|
1968
1964
|
path: {
|
|
1969
1965
|
value: string;
|
|
@@ -2026,13 +2022,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2026
2022
|
nullable?: boolean | undefined;
|
|
2027
2023
|
}[];
|
|
2028
2024
|
};
|
|
2029
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2030
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2031
|
-
type: "requestExample";
|
|
2032
|
-
uid: string;
|
|
2033
|
-
name: string;
|
|
2034
2025
|
body: {
|
|
2035
|
-
activeBody: "
|
|
2026
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2027
|
+
binary?: Blob | undefined;
|
|
2036
2028
|
formData?: {
|
|
2037
2029
|
value: {
|
|
2038
2030
|
value: string;
|
|
@@ -2051,13 +2043,17 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2051
2043
|
}[];
|
|
2052
2044
|
encoding: "form-data" | "urlencoded";
|
|
2053
2045
|
} | undefined;
|
|
2054
|
-
binary?: Blob | undefined;
|
|
2055
2046
|
raw?: {
|
|
2056
2047
|
value: string;
|
|
2057
2048
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2058
2049
|
} | undefined;
|
|
2059
2050
|
};
|
|
2060
2051
|
requestUid: string;
|
|
2052
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2053
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2054
|
+
type: "requestExample";
|
|
2055
|
+
uid: string;
|
|
2056
|
+
name: string;
|
|
2061
2057
|
parameters: {
|
|
2062
2058
|
path: {
|
|
2063
2059
|
value: string;
|
|
@@ -2120,13 +2116,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2120
2116
|
nullable?: boolean | undefined;
|
|
2121
2117
|
}[];
|
|
2122
2118
|
};
|
|
2123
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2124
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2125
|
-
type: "requestExample";
|
|
2126
|
-
uid: string;
|
|
2127
|
-
name: string;
|
|
2128
2119
|
body: {
|
|
2129
|
-
activeBody: "
|
|
2120
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2121
|
+
binary?: Blob | undefined;
|
|
2130
2122
|
formData?: {
|
|
2131
2123
|
value: {
|
|
2132
2124
|
value: string;
|
|
@@ -2145,13 +2137,17 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2145
2137
|
}[];
|
|
2146
2138
|
encoding: "form-data" | "urlencoded";
|
|
2147
2139
|
} | undefined;
|
|
2148
|
-
binary?: Blob | undefined;
|
|
2149
2140
|
raw?: {
|
|
2150
2141
|
value: string;
|
|
2151
2142
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2152
2143
|
} | undefined;
|
|
2153
2144
|
};
|
|
2154
2145
|
requestUid: string;
|
|
2146
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2147
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2148
|
+
type: "requestExample";
|
|
2149
|
+
uid: string;
|
|
2150
|
+
name: string;
|
|
2155
2151
|
parameters: {
|
|
2156
2152
|
path: {
|
|
2157
2153
|
value: string;
|
|
@@ -2214,14 +2210,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2214
2210
|
nullable?: boolean | undefined;
|
|
2215
2211
|
}[];
|
|
2216
2212
|
};
|
|
2217
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2218
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2219
|
-
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" ? {
|
|
2220
|
-
type: "requestExample";
|
|
2221
|
-
uid: string;
|
|
2222
|
-
name: string;
|
|
2223
2213
|
body: {
|
|
2224
|
-
activeBody: "
|
|
2214
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2215
|
+
binary?: Blob | undefined;
|
|
2225
2216
|
formData?: {
|
|
2226
2217
|
value: {
|
|
2227
2218
|
value: string;
|
|
@@ -2240,13 +2231,18 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2240
2231
|
}[];
|
|
2241
2232
|
encoding: "form-data" | "urlencoded";
|
|
2242
2233
|
} | undefined;
|
|
2243
|
-
binary?: Blob | undefined;
|
|
2244
2234
|
raw?: {
|
|
2245
2235
|
value: string;
|
|
2246
2236
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2247
2237
|
} | undefined;
|
|
2248
2238
|
};
|
|
2249
2239
|
requestUid: string;
|
|
2240
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2241
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2242
|
+
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" ? {
|
|
2243
|
+
type: "requestExample";
|
|
2244
|
+
uid: string;
|
|
2245
|
+
name: string;
|
|
2250
2246
|
parameters: {
|
|
2251
2247
|
path: {
|
|
2252
2248
|
value: string;
|
|
@@ -2309,13 +2305,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2309
2305
|
nullable?: boolean | undefined;
|
|
2310
2306
|
}[];
|
|
2311
2307
|
};
|
|
2312
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2313
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2314
|
-
type: "requestExample";
|
|
2315
|
-
uid: string;
|
|
2316
|
-
name: string;
|
|
2317
2308
|
body: {
|
|
2318
|
-
activeBody: "
|
|
2309
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2310
|
+
binary?: Blob | undefined;
|
|
2319
2311
|
formData?: {
|
|
2320
2312
|
value: {
|
|
2321
2313
|
value: string;
|
|
@@ -2334,13 +2326,17 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2334
2326
|
}[];
|
|
2335
2327
|
encoding: "form-data" | "urlencoded";
|
|
2336
2328
|
} | undefined;
|
|
2337
|
-
binary?: Blob | undefined;
|
|
2338
2329
|
raw?: {
|
|
2339
2330
|
value: string;
|
|
2340
2331
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2341
2332
|
} | undefined;
|
|
2342
2333
|
};
|
|
2343
2334
|
requestUid: string;
|
|
2335
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2336
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2337
|
+
type: "requestExample";
|
|
2338
|
+
uid: string;
|
|
2339
|
+
name: string;
|
|
2344
2340
|
parameters: {
|
|
2345
2341
|
path: {
|
|
2346
2342
|
value: string;
|
|
@@ -2403,13 +2399,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2403
2399
|
nullable?: boolean | undefined;
|
|
2404
2400
|
}[];
|
|
2405
2401
|
};
|
|
2406
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2407
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2408
|
-
type: "requestExample";
|
|
2409
|
-
uid: string;
|
|
2410
|
-
name: string;
|
|
2411
2402
|
body: {
|
|
2412
|
-
activeBody: "
|
|
2403
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2404
|
+
binary?: Blob | undefined;
|
|
2413
2405
|
formData?: {
|
|
2414
2406
|
value: {
|
|
2415
2407
|
value: string;
|
|
@@ -2428,13 +2420,17 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2428
2420
|
}[];
|
|
2429
2421
|
encoding: "form-data" | "urlencoded";
|
|
2430
2422
|
} | undefined;
|
|
2431
|
-
binary?: Blob | undefined;
|
|
2432
2423
|
raw?: {
|
|
2433
2424
|
value: string;
|
|
2434
2425
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2435
2426
|
} | undefined;
|
|
2436
2427
|
};
|
|
2437
2428
|
requestUid: string;
|
|
2429
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2430
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2431
|
+
type: "requestExample";
|
|
2432
|
+
uid: string;
|
|
2433
|
+
name: string;
|
|
2438
2434
|
parameters: {
|
|
2439
2435
|
path: {
|
|
2440
2436
|
value: string;
|
|
@@ -2497,6 +2493,33 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2497
2493
|
nullable?: boolean | undefined;
|
|
2498
2494
|
}[];
|
|
2499
2495
|
};
|
|
2496
|
+
body: {
|
|
2497
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2498
|
+
binary?: Blob | undefined;
|
|
2499
|
+
formData?: {
|
|
2500
|
+
value: {
|
|
2501
|
+
value: string;
|
|
2502
|
+
key: string;
|
|
2503
|
+
enabled: boolean;
|
|
2504
|
+
minimum?: number | undefined;
|
|
2505
|
+
type?: string | undefined;
|
|
2506
|
+
maximum?: number | undefined;
|
|
2507
|
+
default?: any;
|
|
2508
|
+
required?: boolean | undefined;
|
|
2509
|
+
description?: string | undefined;
|
|
2510
|
+
enum?: string[] | undefined;
|
|
2511
|
+
format?: string | undefined;
|
|
2512
|
+
file?: any;
|
|
2513
|
+
nullable?: boolean | undefined;
|
|
2514
|
+
}[];
|
|
2515
|
+
encoding: "form-data" | "urlencoded";
|
|
2516
|
+
} | undefined;
|
|
2517
|
+
raw?: {
|
|
2518
|
+
value: string;
|
|
2519
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2520
|
+
} | undefined;
|
|
2521
|
+
};
|
|
2522
|
+
requestUid: string;
|
|
2500
2523
|
serverVariables?: Record<string, string[]> | undefined;
|
|
2501
2524
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2502
2525
|
undo: (uid: string) => void;
|
|
@@ -3287,6 +3310,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3287
3310
|
'x-scalar-children'?: {
|
|
3288
3311
|
tagName: string;
|
|
3289
3312
|
}[] | undefined;
|
|
3313
|
+
'x-internal'?: boolean | undefined;
|
|
3314
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3290
3315
|
}) => void;
|
|
3291
3316
|
add: (payload: import("@scalar/oas-utils/entities/spec").TagPayload, collectionUid: string) => void | {
|
|
3292
3317
|
type: "tag";
|
|
@@ -3301,6 +3326,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3301
3326
|
'x-scalar-children'?: {
|
|
3302
3327
|
tagName: string;
|
|
3303
3328
|
}[] | undefined;
|
|
3329
|
+
'x-internal'?: boolean | undefined;
|
|
3330
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3304
3331
|
};
|
|
3305
3332
|
delete: (tag: import("@scalar/oas-utils/entities/spec").Tag, collectionUid: string) => void;
|
|
3306
3333
|
set: (item: {
|
|
@@ -3316,8 +3343,10 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3316
3343
|
'x-scalar-children'?: {
|
|
3317
3344
|
tagName: string;
|
|
3318
3345
|
}[] | undefined;
|
|
3346
|
+
'x-internal'?: boolean | undefined;
|
|
3347
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3319
3348
|
}) => void;
|
|
3320
|
-
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" ? {
|
|
3349
|
+
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" ? {
|
|
3321
3350
|
type: "tag";
|
|
3322
3351
|
uid: string;
|
|
3323
3352
|
name: string;
|
|
@@ -3330,7 +3359,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3330
3359
|
'x-scalar-children'?: {
|
|
3331
3360
|
tagName: string;
|
|
3332
3361
|
}[] | undefined;
|
|
3333
|
-
|
|
3362
|
+
'x-internal'?: boolean | undefined;
|
|
3363
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3364
|
+
}[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<{
|
|
3334
3365
|
type: "tag";
|
|
3335
3366
|
uid: string;
|
|
3336
3367
|
name: string;
|
|
@@ -3343,6 +3374,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3343
3374
|
'x-scalar-children'?: {
|
|
3344
3375
|
tagName: string;
|
|
3345
3376
|
}[] | undefined;
|
|
3377
|
+
'x-internal'?: boolean | undefined;
|
|
3378
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3346
3379
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
3347
3380
|
type: "tag";
|
|
3348
3381
|
uid: string;
|
|
@@ -3356,8 +3389,10 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3356
3389
|
'x-scalar-children'?: {
|
|
3357
3390
|
tagName: string;
|
|
3358
3391
|
}[] | undefined;
|
|
3392
|
+
'x-internal'?: boolean | undefined;
|
|
3393
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3359
3394
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3360
|
-
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" ? {
|
|
3395
|
+
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" ? {
|
|
3361
3396
|
type: "tag";
|
|
3362
3397
|
uid: string;
|
|
3363
3398
|
name: string;
|
|
@@ -3370,7 +3405,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3370
3405
|
'x-scalar-children'?: {
|
|
3371
3406
|
tagName: string;
|
|
3372
3407
|
}[] | undefined;
|
|
3373
|
-
|
|
3408
|
+
'x-internal'?: boolean | undefined;
|
|
3409
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3410
|
+
}[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<{
|
|
3374
3411
|
type: "tag";
|
|
3375
3412
|
uid: string;
|
|
3376
3413
|
name: string;
|
|
@@ -3383,6 +3420,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3383
3420
|
'x-scalar-children'?: {
|
|
3384
3421
|
tagName: string;
|
|
3385
3422
|
}[] | undefined;
|
|
3423
|
+
'x-internal'?: boolean | undefined;
|
|
3424
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3386
3425
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
3387
3426
|
type: "tag";
|
|
3388
3427
|
uid: string;
|
|
@@ -3396,6 +3435,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3396
3435
|
'x-scalar-children'?: {
|
|
3397
3436
|
tagName: string;
|
|
3398
3437
|
}[] | undefined;
|
|
3438
|
+
'x-internal'?: boolean | undefined;
|
|
3439
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3399
3440
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3400
3441
|
undo: (uid: string) => void;
|
|
3401
3442
|
redo: (uid: string) => void;
|
|
@@ -3681,6 +3722,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
3681
3722
|
'x-scalar-children'?: {
|
|
3682
3723
|
tagName: string;
|
|
3683
3724
|
}[] | undefined;
|
|
3725
|
+
'x-internal'?: boolean | undefined;
|
|
3726
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3684
3727
|
}>;
|
|
3685
3728
|
cookies: Record<string, {
|
|
3686
3729
|
value: string;
|
|
@@ -3706,33 +3749,6 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
3706
3749
|
type: "requestExample";
|
|
3707
3750
|
uid: string;
|
|
3708
3751
|
name: string;
|
|
3709
|
-
body: {
|
|
3710
|
-
activeBody: "formData" | "binary" | "raw";
|
|
3711
|
-
formData?: {
|
|
3712
|
-
value: {
|
|
3713
|
-
value: string;
|
|
3714
|
-
key: string;
|
|
3715
|
-
enabled: boolean;
|
|
3716
|
-
minimum?: number | undefined;
|
|
3717
|
-
type?: string | undefined;
|
|
3718
|
-
maximum?: number | undefined;
|
|
3719
|
-
default?: any;
|
|
3720
|
-
required?: boolean | undefined;
|
|
3721
|
-
description?: string | undefined;
|
|
3722
|
-
enum?: string[] | undefined;
|
|
3723
|
-
format?: string | undefined;
|
|
3724
|
-
file?: any;
|
|
3725
|
-
nullable?: boolean | undefined;
|
|
3726
|
-
}[];
|
|
3727
|
-
encoding: "form-data" | "urlencoded";
|
|
3728
|
-
} | undefined;
|
|
3729
|
-
binary?: Blob | undefined;
|
|
3730
|
-
raw?: {
|
|
3731
|
-
value: string;
|
|
3732
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
3733
|
-
} | undefined;
|
|
3734
|
-
};
|
|
3735
|
-
requestUid: string;
|
|
3736
3752
|
parameters: {
|
|
3737
3753
|
path: {
|
|
3738
3754
|
value: string;
|
|
@@ -3795,6 +3811,33 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
3795
3811
|
nullable?: boolean | undefined;
|
|
3796
3812
|
}[];
|
|
3797
3813
|
};
|
|
3814
|
+
body: {
|
|
3815
|
+
activeBody: "binary" | "formData" | "raw";
|
|
3816
|
+
binary?: Blob | undefined;
|
|
3817
|
+
formData?: {
|
|
3818
|
+
value: {
|
|
3819
|
+
value: string;
|
|
3820
|
+
key: string;
|
|
3821
|
+
enabled: boolean;
|
|
3822
|
+
minimum?: number | undefined;
|
|
3823
|
+
type?: string | undefined;
|
|
3824
|
+
maximum?: number | undefined;
|
|
3825
|
+
default?: any;
|
|
3826
|
+
required?: boolean | undefined;
|
|
3827
|
+
description?: string | undefined;
|
|
3828
|
+
enum?: string[] | undefined;
|
|
3829
|
+
format?: string | undefined;
|
|
3830
|
+
file?: any;
|
|
3831
|
+
nullable?: boolean | undefined;
|
|
3832
|
+
}[];
|
|
3833
|
+
encoding: "form-data" | "urlencoded";
|
|
3834
|
+
} | undefined;
|
|
3835
|
+
raw?: {
|
|
3836
|
+
value: string;
|
|
3837
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
3838
|
+
} | undefined;
|
|
3839
|
+
};
|
|
3840
|
+
requestUid: string;
|
|
3798
3841
|
serverVariables?: Record<string, string[]> | undefined;
|
|
3799
3842
|
}>;
|
|
3800
3843
|
requests: Record<string, {
|
|
@@ -3812,6 +3855,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
3812
3855
|
url: string;
|
|
3813
3856
|
description?: string | undefined;
|
|
3814
3857
|
} | undefined;
|
|
3858
|
+
'x-internal'?: boolean | undefined;
|
|
3859
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3815
3860
|
security?: Record<string, string[]>[] | undefined;
|
|
3816
3861
|
tags?: string[] | undefined;
|
|
3817
3862
|
deprecated?: boolean | undefined;
|
|
@@ -3937,6 +3982,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
3937
3982
|
isReadOnly: boolean;
|
|
3938
3983
|
hideClientButton: boolean | undefined;
|
|
3939
3984
|
showSidebar: boolean;
|
|
3985
|
+
integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
|
|
3940
3986
|
importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
|
|
3941
3987
|
type?: "collection" | undefined;
|
|
3942
3988
|
uid?: string | undefined;
|
|
@@ -4493,7 +4539,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4493
4539
|
documentUrl?: string | undefined;
|
|
4494
4540
|
integration?: string | null | undefined;
|
|
4495
4541
|
}) => void;
|
|
4496
|
-
edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
4542
|
+
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" ? {
|
|
4497
4543
|
type: "collection";
|
|
4498
4544
|
uid: string;
|
|
4499
4545
|
children: string[];
|
|
@@ -4547,7 +4593,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4547
4593
|
}> | undefined;
|
|
4548
4594
|
documentUrl?: string | undefined;
|
|
4549
4595
|
integration?: string | null | undefined;
|
|
4550
|
-
}[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" | "
|
|
4596
|
+
}[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<{
|
|
4551
4597
|
type: "collection";
|
|
4552
4598
|
uid: string;
|
|
4553
4599
|
children: string[];
|
|
@@ -4656,7 +4702,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4656
4702
|
documentUrl?: string | undefined;
|
|
4657
4703
|
integration?: string | null | undefined;
|
|
4658
4704
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
4659
|
-
untrackedEdit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
4705
|
+
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" ? {
|
|
4660
4706
|
type: "collection";
|
|
4661
4707
|
uid: string;
|
|
4662
4708
|
children: string[];
|
|
@@ -4710,7 +4756,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4710
4756
|
}> | undefined;
|
|
4711
4757
|
documentUrl?: string | undefined;
|
|
4712
4758
|
integration?: string | null | undefined;
|
|
4713
|
-
}[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" | "
|
|
4759
|
+
}[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<{
|
|
4714
4760
|
type: "collection";
|
|
4715
4761
|
uid: string;
|
|
4716
4762
|
children: string[];
|
|
@@ -4897,6 +4943,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4897
4943
|
url: string;
|
|
4898
4944
|
description?: string | undefined;
|
|
4899
4945
|
} | undefined;
|
|
4946
|
+
'x-internal'?: boolean | undefined;
|
|
4947
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
4900
4948
|
security?: Record<string, string[]>[] | undefined;
|
|
4901
4949
|
tags?: string[] | undefined;
|
|
4902
4950
|
deprecated?: boolean | undefined;
|
|
@@ -4934,6 +4982,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4934
4982
|
url: string;
|
|
4935
4983
|
description?: string | undefined;
|
|
4936
4984
|
} | undefined;
|
|
4985
|
+
'x-internal'?: boolean | undefined;
|
|
4986
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
4937
4987
|
security?: Record<string, string[]>[] | undefined;
|
|
4938
4988
|
tags?: string[] | undefined;
|
|
4939
4989
|
deprecated?: boolean | undefined;
|
|
@@ -4972,6 +5022,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4972
5022
|
url: string;
|
|
4973
5023
|
description?: string | undefined;
|
|
4974
5024
|
} | undefined;
|
|
5025
|
+
'x-internal'?: boolean | undefined;
|
|
5026
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
4975
5027
|
security?: Record<string, string[]>[] | undefined;
|
|
4976
5028
|
tags?: string[] | undefined;
|
|
4977
5029
|
deprecated?: boolean | undefined;
|
|
@@ -4994,7 +5046,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4994
5046
|
requestBody?: any;
|
|
4995
5047
|
responses?: Record<string, any> | undefined;
|
|
4996
5048
|
}) => void;
|
|
4997
|
-
edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
5049
|
+
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" ? {
|
|
4998
5050
|
path: string;
|
|
4999
5051
|
type: "request";
|
|
5000
5052
|
uid: string;
|
|
@@ -5009,6 +5061,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5009
5061
|
url: string;
|
|
5010
5062
|
description?: string | undefined;
|
|
5011
5063
|
} | undefined;
|
|
5064
|
+
'x-internal'?: boolean | undefined;
|
|
5065
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
5012
5066
|
security?: Record<string, string[]>[] | undefined;
|
|
5013
5067
|
tags?: string[] | undefined;
|
|
5014
5068
|
deprecated?: boolean | undefined;
|
|
@@ -5030,7 +5084,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5030
5084
|
}[] | undefined;
|
|
5031
5085
|
requestBody?: any;
|
|
5032
5086
|
responses?: Record<string, any> | undefined;
|
|
5033
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "
|
|
5087
|
+
}[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<{
|
|
5034
5088
|
path: string;
|
|
5035
5089
|
type: "request";
|
|
5036
5090
|
uid: string;
|
|
@@ -5045,6 +5099,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5045
5099
|
url: string;
|
|
5046
5100
|
description?: string | undefined;
|
|
5047
5101
|
} | undefined;
|
|
5102
|
+
'x-internal'?: boolean | undefined;
|
|
5103
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
5048
5104
|
security?: Record<string, string[]>[] | undefined;
|
|
5049
5105
|
tags?: string[] | undefined;
|
|
5050
5106
|
deprecated?: boolean | undefined;
|
|
@@ -5081,6 +5137,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5081
5137
|
url: string;
|
|
5082
5138
|
description?: string | undefined;
|
|
5083
5139
|
} | undefined;
|
|
5140
|
+
'x-internal'?: boolean | undefined;
|
|
5141
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
5084
5142
|
security?: Record<string, string[]>[] | undefined;
|
|
5085
5143
|
tags?: string[] | undefined;
|
|
5086
5144
|
deprecated?: boolean | undefined;
|
|
@@ -5103,7 +5161,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5103
5161
|
requestBody?: any;
|
|
5104
5162
|
responses?: Record<string, any> | undefined;
|
|
5105
5163
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
5106
|
-
untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
5164
|
+
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" ? {
|
|
5107
5165
|
path: string;
|
|
5108
5166
|
type: "request";
|
|
5109
5167
|
uid: string;
|
|
@@ -5118,6 +5176,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5118
5176
|
url: string;
|
|
5119
5177
|
description?: string | undefined;
|
|
5120
5178
|
} | undefined;
|
|
5179
|
+
'x-internal'?: boolean | undefined;
|
|
5180
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
5121
5181
|
security?: Record<string, string[]>[] | undefined;
|
|
5122
5182
|
tags?: string[] | undefined;
|
|
5123
5183
|
deprecated?: boolean | undefined;
|
|
@@ -5139,7 +5199,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5139
5199
|
}[] | undefined;
|
|
5140
5200
|
requestBody?: any;
|
|
5141
5201
|
responses?: Record<string, any> | undefined;
|
|
5142
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "
|
|
5202
|
+
}[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<{
|
|
5143
5203
|
path: string;
|
|
5144
5204
|
type: "request";
|
|
5145
5205
|
uid: string;
|
|
@@ -5154,6 +5214,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5154
5214
|
url: string;
|
|
5155
5215
|
description?: string | undefined;
|
|
5156
5216
|
} | undefined;
|
|
5217
|
+
'x-internal'?: boolean | undefined;
|
|
5218
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
5157
5219
|
security?: Record<string, string[]>[] | undefined;
|
|
5158
5220
|
tags?: string[] | undefined;
|
|
5159
5221
|
deprecated?: boolean | undefined;
|
|
@@ -5190,6 +5252,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5190
5252
|
url: string;
|
|
5191
5253
|
description?: string | undefined;
|
|
5192
5254
|
} | undefined;
|
|
5255
|
+
'x-internal'?: boolean | undefined;
|
|
5256
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
5193
5257
|
security?: Record<string, string[]>[] | undefined;
|
|
5194
5258
|
tags?: string[] | undefined;
|
|
5195
5259
|
deprecated?: boolean | undefined;
|
|
@@ -5222,33 +5286,6 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5222
5286
|
type: "requestExample";
|
|
5223
5287
|
uid: string;
|
|
5224
5288
|
name: string;
|
|
5225
|
-
body: {
|
|
5226
|
-
activeBody: "formData" | "binary" | "raw";
|
|
5227
|
-
formData?: {
|
|
5228
|
-
value: {
|
|
5229
|
-
value: string;
|
|
5230
|
-
key: string;
|
|
5231
|
-
enabled: boolean;
|
|
5232
|
-
minimum?: number | undefined;
|
|
5233
|
-
type?: string | undefined;
|
|
5234
|
-
maximum?: number | undefined;
|
|
5235
|
-
default?: any;
|
|
5236
|
-
required?: boolean | undefined;
|
|
5237
|
-
description?: string | undefined;
|
|
5238
|
-
enum?: string[] | undefined;
|
|
5239
|
-
format?: string | undefined;
|
|
5240
|
-
file?: any;
|
|
5241
|
-
nullable?: boolean | undefined;
|
|
5242
|
-
}[];
|
|
5243
|
-
encoding: "form-data" | "urlencoded";
|
|
5244
|
-
} | undefined;
|
|
5245
|
-
binary?: Blob | undefined;
|
|
5246
|
-
raw?: {
|
|
5247
|
-
value: string;
|
|
5248
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5249
|
-
} | undefined;
|
|
5250
|
-
};
|
|
5251
|
-
requestUid: string;
|
|
5252
5289
|
parameters: {
|
|
5253
5290
|
path: {
|
|
5254
5291
|
value: string;
|
|
@@ -5311,14 +5348,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5311
5348
|
nullable?: boolean | undefined;
|
|
5312
5349
|
}[];
|
|
5313
5350
|
};
|
|
5314
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5315
|
-
}) => void;
|
|
5316
|
-
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
5317
|
-
type: "requestExample";
|
|
5318
|
-
uid: string;
|
|
5319
|
-
name: string;
|
|
5320
5351
|
body: {
|
|
5321
|
-
activeBody: "
|
|
5352
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5353
|
+
binary?: Blob | undefined;
|
|
5322
5354
|
formData?: {
|
|
5323
5355
|
value: {
|
|
5324
5356
|
value: string;
|
|
@@ -5337,13 +5369,18 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5337
5369
|
}[];
|
|
5338
5370
|
encoding: "form-data" | "urlencoded";
|
|
5339
5371
|
} | undefined;
|
|
5340
|
-
binary?: Blob | undefined;
|
|
5341
5372
|
raw?: {
|
|
5342
5373
|
value: string;
|
|
5343
5374
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5344
5375
|
} | undefined;
|
|
5345
5376
|
};
|
|
5346
5377
|
requestUid: string;
|
|
5378
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5379
|
+
}) => void;
|
|
5380
|
+
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
5381
|
+
type: "requestExample";
|
|
5382
|
+
uid: string;
|
|
5383
|
+
name: string;
|
|
5347
5384
|
parameters: {
|
|
5348
5385
|
path: {
|
|
5349
5386
|
value: string;
|
|
@@ -5406,15 +5443,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5406
5443
|
nullable?: boolean | undefined;
|
|
5407
5444
|
}[];
|
|
5408
5445
|
};
|
|
5409
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5410
|
-
};
|
|
5411
|
-
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
5412
|
-
set: (item: {
|
|
5413
|
-
type: "requestExample";
|
|
5414
|
-
uid: string;
|
|
5415
|
-
name: string;
|
|
5416
5446
|
body: {
|
|
5417
|
-
activeBody: "
|
|
5447
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5448
|
+
binary?: Blob | undefined;
|
|
5418
5449
|
formData?: {
|
|
5419
5450
|
value: {
|
|
5420
5451
|
value: string;
|
|
@@ -5433,13 +5464,19 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5433
5464
|
}[];
|
|
5434
5465
|
encoding: "form-data" | "urlencoded";
|
|
5435
5466
|
} | undefined;
|
|
5436
|
-
binary?: Blob | undefined;
|
|
5437
5467
|
raw?: {
|
|
5438
5468
|
value: string;
|
|
5439
5469
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5440
5470
|
} | undefined;
|
|
5441
5471
|
};
|
|
5442
5472
|
requestUid: string;
|
|
5473
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5474
|
+
};
|
|
5475
|
+
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
5476
|
+
set: (item: {
|
|
5477
|
+
type: "requestExample";
|
|
5478
|
+
uid: string;
|
|
5479
|
+
name: string;
|
|
5443
5480
|
parameters: {
|
|
5444
5481
|
path: {
|
|
5445
5482
|
value: string;
|
|
@@ -5502,14 +5539,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5502
5539
|
nullable?: boolean | undefined;
|
|
5503
5540
|
}[];
|
|
5504
5541
|
};
|
|
5505
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5506
|
-
}) => void;
|
|
5507
|
-
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" ? {
|
|
5508
|
-
type: "requestExample";
|
|
5509
|
-
uid: string;
|
|
5510
|
-
name: string;
|
|
5511
5542
|
body: {
|
|
5512
|
-
activeBody: "
|
|
5543
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5544
|
+
binary?: Blob | undefined;
|
|
5513
5545
|
formData?: {
|
|
5514
5546
|
value: {
|
|
5515
5547
|
value: string;
|
|
@@ -5528,13 +5560,18 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5528
5560
|
}[];
|
|
5529
5561
|
encoding: "form-data" | "urlencoded";
|
|
5530
5562
|
} | undefined;
|
|
5531
|
-
binary?: Blob | undefined;
|
|
5532
5563
|
raw?: {
|
|
5533
5564
|
value: string;
|
|
5534
5565
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5535
5566
|
} | undefined;
|
|
5536
5567
|
};
|
|
5537
5568
|
requestUid: string;
|
|
5569
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5570
|
+
}) => void;
|
|
5571
|
+
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" ? {
|
|
5572
|
+
type: "requestExample";
|
|
5573
|
+
uid: string;
|
|
5574
|
+
name: string;
|
|
5538
5575
|
parameters: {
|
|
5539
5576
|
path: {
|
|
5540
5577
|
value: string;
|
|
@@ -5597,13 +5634,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5597
5634
|
nullable?: boolean | undefined;
|
|
5598
5635
|
}[];
|
|
5599
5636
|
};
|
|
5600
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5601
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
5602
|
-
type: "requestExample";
|
|
5603
|
-
uid: string;
|
|
5604
|
-
name: string;
|
|
5605
5637
|
body: {
|
|
5606
|
-
activeBody: "
|
|
5638
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5639
|
+
binary?: Blob | undefined;
|
|
5607
5640
|
formData?: {
|
|
5608
5641
|
value: {
|
|
5609
5642
|
value: string;
|
|
@@ -5622,13 +5655,17 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5622
5655
|
}[];
|
|
5623
5656
|
encoding: "form-data" | "urlencoded";
|
|
5624
5657
|
} | undefined;
|
|
5625
|
-
binary?: Blob | undefined;
|
|
5626
5658
|
raw?: {
|
|
5627
5659
|
value: string;
|
|
5628
5660
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5629
5661
|
} | undefined;
|
|
5630
5662
|
};
|
|
5631
5663
|
requestUid: string;
|
|
5664
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5665
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
5666
|
+
type: "requestExample";
|
|
5667
|
+
uid: string;
|
|
5668
|
+
name: string;
|
|
5632
5669
|
parameters: {
|
|
5633
5670
|
path: {
|
|
5634
5671
|
value: string;
|
|
@@ -5691,13 +5728,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5691
5728
|
nullable?: boolean | undefined;
|
|
5692
5729
|
}[];
|
|
5693
5730
|
};
|
|
5694
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5695
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
5696
|
-
type: "requestExample";
|
|
5697
|
-
uid: string;
|
|
5698
|
-
name: string;
|
|
5699
5731
|
body: {
|
|
5700
|
-
activeBody: "
|
|
5732
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5733
|
+
binary?: Blob | undefined;
|
|
5701
5734
|
formData?: {
|
|
5702
5735
|
value: {
|
|
5703
5736
|
value: string;
|
|
@@ -5716,13 +5749,17 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5716
5749
|
}[];
|
|
5717
5750
|
encoding: "form-data" | "urlencoded";
|
|
5718
5751
|
} | undefined;
|
|
5719
|
-
binary?: Blob | undefined;
|
|
5720
5752
|
raw?: {
|
|
5721
5753
|
value: string;
|
|
5722
5754
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5723
5755
|
} | undefined;
|
|
5724
5756
|
};
|
|
5725
5757
|
requestUid: string;
|
|
5758
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5759
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
5760
|
+
type: "requestExample";
|
|
5761
|
+
uid: string;
|
|
5762
|
+
name: string;
|
|
5726
5763
|
parameters: {
|
|
5727
5764
|
path: {
|
|
5728
5765
|
value: string;
|
|
@@ -5785,14 +5822,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5785
5822
|
nullable?: boolean | undefined;
|
|
5786
5823
|
}[];
|
|
5787
5824
|
};
|
|
5788
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5789
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
5790
|
-
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" ? {
|
|
5791
|
-
type: "requestExample";
|
|
5792
|
-
uid: string;
|
|
5793
|
-
name: string;
|
|
5794
5825
|
body: {
|
|
5795
|
-
activeBody: "
|
|
5826
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5827
|
+
binary?: Blob | undefined;
|
|
5796
5828
|
formData?: {
|
|
5797
5829
|
value: {
|
|
5798
5830
|
value: string;
|
|
@@ -5811,13 +5843,18 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5811
5843
|
}[];
|
|
5812
5844
|
encoding: "form-data" | "urlencoded";
|
|
5813
5845
|
} | undefined;
|
|
5814
|
-
binary?: Blob | undefined;
|
|
5815
5846
|
raw?: {
|
|
5816
5847
|
value: string;
|
|
5817
5848
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5818
5849
|
} | undefined;
|
|
5819
5850
|
};
|
|
5820
5851
|
requestUid: string;
|
|
5852
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5853
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
5854
|
+
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" ? {
|
|
5855
|
+
type: "requestExample";
|
|
5856
|
+
uid: string;
|
|
5857
|
+
name: string;
|
|
5821
5858
|
parameters: {
|
|
5822
5859
|
path: {
|
|
5823
5860
|
value: string;
|
|
@@ -5880,13 +5917,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5880
5917
|
nullable?: boolean | undefined;
|
|
5881
5918
|
}[];
|
|
5882
5919
|
};
|
|
5883
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5884
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
5885
|
-
type: "requestExample";
|
|
5886
|
-
uid: string;
|
|
5887
|
-
name: string;
|
|
5888
5920
|
body: {
|
|
5889
|
-
activeBody: "
|
|
5921
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5922
|
+
binary?: Blob | undefined;
|
|
5890
5923
|
formData?: {
|
|
5891
5924
|
value: {
|
|
5892
5925
|
value: string;
|
|
@@ -5905,13 +5938,17 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5905
5938
|
}[];
|
|
5906
5939
|
encoding: "form-data" | "urlencoded";
|
|
5907
5940
|
} | undefined;
|
|
5908
|
-
binary?: Blob | undefined;
|
|
5909
5941
|
raw?: {
|
|
5910
5942
|
value: string;
|
|
5911
5943
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5912
5944
|
} | undefined;
|
|
5913
5945
|
};
|
|
5914
5946
|
requestUid: string;
|
|
5947
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5948
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
5949
|
+
type: "requestExample";
|
|
5950
|
+
uid: string;
|
|
5951
|
+
name: string;
|
|
5915
5952
|
parameters: {
|
|
5916
5953
|
path: {
|
|
5917
5954
|
value: string;
|
|
@@ -5974,13 +6011,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5974
6011
|
nullable?: boolean | undefined;
|
|
5975
6012
|
}[];
|
|
5976
6013
|
};
|
|
5977
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5978
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
5979
|
-
type: "requestExample";
|
|
5980
|
-
uid: string;
|
|
5981
|
-
name: string;
|
|
5982
6014
|
body: {
|
|
5983
|
-
activeBody: "
|
|
6015
|
+
activeBody: "binary" | "formData" | "raw";
|
|
6016
|
+
binary?: Blob | undefined;
|
|
5984
6017
|
formData?: {
|
|
5985
6018
|
value: {
|
|
5986
6019
|
value: string;
|
|
@@ -5999,13 +6032,17 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5999
6032
|
}[];
|
|
6000
6033
|
encoding: "form-data" | "urlencoded";
|
|
6001
6034
|
} | undefined;
|
|
6002
|
-
binary?: Blob | undefined;
|
|
6003
6035
|
raw?: {
|
|
6004
6036
|
value: string;
|
|
6005
6037
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
6006
6038
|
} | undefined;
|
|
6007
6039
|
};
|
|
6008
6040
|
requestUid: string;
|
|
6041
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
6042
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6043
|
+
type: "requestExample";
|
|
6044
|
+
uid: string;
|
|
6045
|
+
name: string;
|
|
6009
6046
|
parameters: {
|
|
6010
6047
|
path: {
|
|
6011
6048
|
value: string;
|
|
@@ -6068,6 +6105,33 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6068
6105
|
nullable?: boolean | undefined;
|
|
6069
6106
|
}[];
|
|
6070
6107
|
};
|
|
6108
|
+
body: {
|
|
6109
|
+
activeBody: "binary" | "formData" | "raw";
|
|
6110
|
+
binary?: Blob | undefined;
|
|
6111
|
+
formData?: {
|
|
6112
|
+
value: {
|
|
6113
|
+
value: string;
|
|
6114
|
+
key: string;
|
|
6115
|
+
enabled: boolean;
|
|
6116
|
+
minimum?: number | undefined;
|
|
6117
|
+
type?: string | undefined;
|
|
6118
|
+
maximum?: number | undefined;
|
|
6119
|
+
default?: any;
|
|
6120
|
+
required?: boolean | undefined;
|
|
6121
|
+
description?: string | undefined;
|
|
6122
|
+
enum?: string[] | undefined;
|
|
6123
|
+
format?: string | undefined;
|
|
6124
|
+
file?: any;
|
|
6125
|
+
nullable?: boolean | undefined;
|
|
6126
|
+
}[];
|
|
6127
|
+
encoding: "form-data" | "urlencoded";
|
|
6128
|
+
} | undefined;
|
|
6129
|
+
raw?: {
|
|
6130
|
+
value: string;
|
|
6131
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
6132
|
+
} | undefined;
|
|
6133
|
+
};
|
|
6134
|
+
requestUid: string;
|
|
6071
6135
|
serverVariables?: Record<string, string[]> | undefined;
|
|
6072
6136
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
6073
6137
|
undo: (uid: string) => void;
|
|
@@ -6858,6 +6922,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6858
6922
|
'x-scalar-children'?: {
|
|
6859
6923
|
tagName: string;
|
|
6860
6924
|
}[] | undefined;
|
|
6925
|
+
'x-internal'?: boolean | undefined;
|
|
6926
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
6861
6927
|
}) => void;
|
|
6862
6928
|
add: (payload: import("@scalar/oas-utils/entities/spec").TagPayload, collectionUid: string) => void | {
|
|
6863
6929
|
type: "tag";
|
|
@@ -6872,6 +6938,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6872
6938
|
'x-scalar-children'?: {
|
|
6873
6939
|
tagName: string;
|
|
6874
6940
|
}[] | undefined;
|
|
6941
|
+
'x-internal'?: boolean | undefined;
|
|
6942
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
6875
6943
|
};
|
|
6876
6944
|
delete: (tag: import("@scalar/oas-utils/entities/spec").Tag, collectionUid: string) => void;
|
|
6877
6945
|
set: (item: {
|
|
@@ -6887,8 +6955,10 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6887
6955
|
'x-scalar-children'?: {
|
|
6888
6956
|
tagName: string;
|
|
6889
6957
|
}[] | undefined;
|
|
6958
|
+
'x-internal'?: boolean | undefined;
|
|
6959
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
6890
6960
|
}) => void;
|
|
6891
|
-
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" ? {
|
|
6961
|
+
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" ? {
|
|
6892
6962
|
type: "tag";
|
|
6893
6963
|
uid: string;
|
|
6894
6964
|
name: string;
|
|
@@ -6901,7 +6971,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6901
6971
|
'x-scalar-children'?: {
|
|
6902
6972
|
tagName: string;
|
|
6903
6973
|
}[] | undefined;
|
|
6904
|
-
|
|
6974
|
+
'x-internal'?: boolean | undefined;
|
|
6975
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
6976
|
+
}[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<{
|
|
6905
6977
|
type: "tag";
|
|
6906
6978
|
uid: string;
|
|
6907
6979
|
name: string;
|
|
@@ -6914,6 +6986,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6914
6986
|
'x-scalar-children'?: {
|
|
6915
6987
|
tagName: string;
|
|
6916
6988
|
}[] | undefined;
|
|
6989
|
+
'x-internal'?: boolean | undefined;
|
|
6990
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
6917
6991
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6918
6992
|
type: "tag";
|
|
6919
6993
|
uid: string;
|
|
@@ -6927,8 +7001,10 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6927
7001
|
'x-scalar-children'?: {
|
|
6928
7002
|
tagName: string;
|
|
6929
7003
|
}[] | undefined;
|
|
7004
|
+
'x-internal'?: boolean | undefined;
|
|
7005
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
6930
7006
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
6931
|
-
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" ? {
|
|
7007
|
+
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" ? {
|
|
6932
7008
|
type: "tag";
|
|
6933
7009
|
uid: string;
|
|
6934
7010
|
name: string;
|
|
@@ -6941,7 +7017,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6941
7017
|
'x-scalar-children'?: {
|
|
6942
7018
|
tagName: string;
|
|
6943
7019
|
}[] | undefined;
|
|
6944
|
-
|
|
7020
|
+
'x-internal'?: boolean | undefined;
|
|
7021
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
7022
|
+
}[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<{
|
|
6945
7023
|
type: "tag";
|
|
6946
7024
|
uid: string;
|
|
6947
7025
|
name: string;
|
|
@@ -6954,6 +7032,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6954
7032
|
'x-scalar-children'?: {
|
|
6955
7033
|
tagName: string;
|
|
6956
7034
|
}[] | undefined;
|
|
7035
|
+
'x-internal'?: boolean | undefined;
|
|
7036
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
6957
7037
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6958
7038
|
type: "tag";
|
|
6959
7039
|
uid: string;
|
|
@@ -6967,6 +7047,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6967
7047
|
'x-scalar-children'?: {
|
|
6968
7048
|
tagName: string;
|
|
6969
7049
|
}[] | undefined;
|
|
7050
|
+
'x-internal'?: boolean | undefined;
|
|
7051
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
6970
7052
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
6971
7053
|
undo: (uid: string) => void;
|
|
6972
7054
|
redo: (uid: string) => void;
|