@scalar/api-client 2.2.32 → 2.2.34
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 +38 -0
- package/dist/components/AddressBar/AddressBar.vue.js +2 -2
- package/dist/components/AddressBar/AddressBar.vue2.js +27 -26
- 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 +171 -128
- package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
- package/dist/layouts/Modal/create-api-client-modal.d.ts +342 -256
- package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
- package/dist/layouts/Web/create-api-client-web.d.ts +171 -128
- package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
- package/dist/libs/create-client.d.ts +172 -129
- 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 +93 -93
- 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/events.d.ts +3 -1
- package/dist/store/events.d.ts.map +1 -1
- 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 +174 -129
- 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 +13 -13
|
@@ -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;
|
|
@@ -354,7 +358,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
354
358
|
hide: () => void;
|
|
355
359
|
};
|
|
356
360
|
events: {
|
|
357
|
-
executeRequest: import("../../libs/index.js").EventBus<
|
|
361
|
+
executeRequest: import("../../libs/index.js").EventBus<{
|
|
362
|
+
requestUid?: string;
|
|
363
|
+
}>;
|
|
358
364
|
cancelRequest: import("../../libs/index.js").EventBus<any>;
|
|
359
365
|
requestStatus: import("../../libs/index.js").EventBus<import("../../libs/index.js").RequestStatus>;
|
|
360
366
|
commandPalette: import("../../libs/index.js").EventBus<import("../../components/CommandPalette/TheCommandPalette.vue.js").CommandPaletteEvent>;
|
|
@@ -366,6 +372,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
366
372
|
isReadOnly: boolean;
|
|
367
373
|
hideClientButton: boolean | undefined;
|
|
368
374
|
showSidebar: boolean;
|
|
375
|
+
integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
|
|
369
376
|
importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
|
|
370
377
|
type?: "collection" | undefined;
|
|
371
378
|
uid?: string | undefined;
|
|
@@ -922,7 +929,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
922
929
|
documentUrl?: string | undefined;
|
|
923
930
|
integration?: string | null | undefined;
|
|
924
931
|
}) => void;
|
|
925
|
-
edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
932
|
+
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
933
|
type: "collection";
|
|
927
934
|
uid: string;
|
|
928
935
|
children: string[];
|
|
@@ -976,7 +983,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
976
983
|
}> | undefined;
|
|
977
984
|
documentUrl?: string | undefined;
|
|
978
985
|
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" | "
|
|
986
|
+
}[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
987
|
type: "collection";
|
|
981
988
|
uid: string;
|
|
982
989
|
children: string[];
|
|
@@ -1085,7 +1092,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1085
1092
|
documentUrl?: string | undefined;
|
|
1086
1093
|
integration?: string | null | undefined;
|
|
1087
1094
|
}[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" | "
|
|
1095
|
+
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
1096
|
type: "collection";
|
|
1090
1097
|
uid: string;
|
|
1091
1098
|
children: string[];
|
|
@@ -1139,7 +1146,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1139
1146
|
}> | undefined;
|
|
1140
1147
|
documentUrl?: string | undefined;
|
|
1141
1148
|
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" | "
|
|
1149
|
+
}[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
1150
|
type: "collection";
|
|
1144
1151
|
uid: string;
|
|
1145
1152
|
children: string[];
|
|
@@ -1326,6 +1333,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1326
1333
|
url: string;
|
|
1327
1334
|
description?: string | undefined;
|
|
1328
1335
|
} | undefined;
|
|
1336
|
+
'x-internal'?: boolean | undefined;
|
|
1337
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1329
1338
|
security?: Record<string, string[]>[] | undefined;
|
|
1330
1339
|
tags?: string[] | undefined;
|
|
1331
1340
|
deprecated?: boolean | undefined;
|
|
@@ -1363,6 +1372,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1363
1372
|
url: string;
|
|
1364
1373
|
description?: string | undefined;
|
|
1365
1374
|
} | undefined;
|
|
1375
|
+
'x-internal'?: boolean | undefined;
|
|
1376
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1366
1377
|
security?: Record<string, string[]>[] | undefined;
|
|
1367
1378
|
tags?: string[] | undefined;
|
|
1368
1379
|
deprecated?: boolean | undefined;
|
|
@@ -1401,6 +1412,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1401
1412
|
url: string;
|
|
1402
1413
|
description?: string | undefined;
|
|
1403
1414
|
} | undefined;
|
|
1415
|
+
'x-internal'?: boolean | undefined;
|
|
1416
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1404
1417
|
security?: Record<string, string[]>[] | undefined;
|
|
1405
1418
|
tags?: string[] | undefined;
|
|
1406
1419
|
deprecated?: boolean | undefined;
|
|
@@ -1423,7 +1436,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1423
1436
|
requestBody?: any;
|
|
1424
1437
|
responses?: Record<string, any> | undefined;
|
|
1425
1438
|
}) => void;
|
|
1426
|
-
edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
1439
|
+
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
1440
|
path: string;
|
|
1428
1441
|
type: "request";
|
|
1429
1442
|
uid: string;
|
|
@@ -1438,6 +1451,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1438
1451
|
url: string;
|
|
1439
1452
|
description?: string | undefined;
|
|
1440
1453
|
} | undefined;
|
|
1454
|
+
'x-internal'?: boolean | undefined;
|
|
1455
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1441
1456
|
security?: Record<string, string[]>[] | undefined;
|
|
1442
1457
|
tags?: string[] | undefined;
|
|
1443
1458
|
deprecated?: boolean | undefined;
|
|
@@ -1459,7 +1474,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1459
1474
|
}[] | undefined;
|
|
1460
1475
|
requestBody?: any;
|
|
1461
1476
|
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" | "
|
|
1477
|
+
}[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
1478
|
path: string;
|
|
1464
1479
|
type: "request";
|
|
1465
1480
|
uid: string;
|
|
@@ -1474,6 +1489,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1474
1489
|
url: string;
|
|
1475
1490
|
description?: string | undefined;
|
|
1476
1491
|
} | undefined;
|
|
1492
|
+
'x-internal'?: boolean | undefined;
|
|
1493
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1477
1494
|
security?: Record<string, string[]>[] | undefined;
|
|
1478
1495
|
tags?: string[] | undefined;
|
|
1479
1496
|
deprecated?: boolean | undefined;
|
|
@@ -1510,6 +1527,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1510
1527
|
url: string;
|
|
1511
1528
|
description?: string | undefined;
|
|
1512
1529
|
} | undefined;
|
|
1530
|
+
'x-internal'?: boolean | undefined;
|
|
1531
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1513
1532
|
security?: Record<string, string[]>[] | undefined;
|
|
1514
1533
|
tags?: string[] | undefined;
|
|
1515
1534
|
deprecated?: boolean | undefined;
|
|
@@ -1532,7 +1551,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1532
1551
|
requestBody?: any;
|
|
1533
1552
|
responses?: Record<string, any> | undefined;
|
|
1534
1553
|
}[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" |
|
|
1554
|
+
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
1555
|
path: string;
|
|
1537
1556
|
type: "request";
|
|
1538
1557
|
uid: string;
|
|
@@ -1547,6 +1566,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1547
1566
|
url: string;
|
|
1548
1567
|
description?: string | undefined;
|
|
1549
1568
|
} | undefined;
|
|
1569
|
+
'x-internal'?: boolean | undefined;
|
|
1570
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1550
1571
|
security?: Record<string, string[]>[] | undefined;
|
|
1551
1572
|
tags?: string[] | undefined;
|
|
1552
1573
|
deprecated?: boolean | undefined;
|
|
@@ -1568,7 +1589,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1568
1589
|
}[] | undefined;
|
|
1569
1590
|
requestBody?: any;
|
|
1570
1591
|
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" | "
|
|
1592
|
+
}[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
1593
|
path: string;
|
|
1573
1594
|
type: "request";
|
|
1574
1595
|
uid: string;
|
|
@@ -1583,6 +1604,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1583
1604
|
url: string;
|
|
1584
1605
|
description?: string | undefined;
|
|
1585
1606
|
} | undefined;
|
|
1607
|
+
'x-internal'?: boolean | undefined;
|
|
1608
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1586
1609
|
security?: Record<string, string[]>[] | undefined;
|
|
1587
1610
|
tags?: string[] | undefined;
|
|
1588
1611
|
deprecated?: boolean | undefined;
|
|
@@ -1619,6 +1642,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1619
1642
|
url: string;
|
|
1620
1643
|
description?: string | undefined;
|
|
1621
1644
|
} | undefined;
|
|
1645
|
+
'x-internal'?: boolean | undefined;
|
|
1646
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1622
1647
|
security?: Record<string, string[]>[] | undefined;
|
|
1623
1648
|
tags?: string[] | undefined;
|
|
1624
1649
|
deprecated?: boolean | undefined;
|
|
@@ -1651,33 +1676,6 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1651
1676
|
type: "requestExample";
|
|
1652
1677
|
uid: string;
|
|
1653
1678
|
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
1679
|
parameters: {
|
|
1682
1680
|
path: {
|
|
1683
1681
|
value: string;
|
|
@@ -1740,14 +1738,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1740
1738
|
nullable?: boolean | undefined;
|
|
1741
1739
|
}[];
|
|
1742
1740
|
};
|
|
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
1741
|
body: {
|
|
1750
|
-
activeBody: "
|
|
1742
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1743
|
+
binary?: Blob | undefined;
|
|
1751
1744
|
formData?: {
|
|
1752
1745
|
value: {
|
|
1753
1746
|
value: string;
|
|
@@ -1766,13 +1759,18 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1766
1759
|
}[];
|
|
1767
1760
|
encoding: "form-data" | "urlencoded";
|
|
1768
1761
|
} | undefined;
|
|
1769
|
-
binary?: Blob | undefined;
|
|
1770
1762
|
raw?: {
|
|
1771
1763
|
value: string;
|
|
1772
1764
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1773
1765
|
} | undefined;
|
|
1774
1766
|
};
|
|
1775
1767
|
requestUid: string;
|
|
1768
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1769
|
+
}) => void;
|
|
1770
|
+
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
1771
|
+
type: "requestExample";
|
|
1772
|
+
uid: string;
|
|
1773
|
+
name: string;
|
|
1776
1774
|
parameters: {
|
|
1777
1775
|
path: {
|
|
1778
1776
|
value: string;
|
|
@@ -1835,15 +1833,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1835
1833
|
nullable?: boolean | undefined;
|
|
1836
1834
|
}[];
|
|
1837
1835
|
};
|
|
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
1836
|
body: {
|
|
1846
|
-
activeBody: "
|
|
1837
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1838
|
+
binary?: Blob | undefined;
|
|
1847
1839
|
formData?: {
|
|
1848
1840
|
value: {
|
|
1849
1841
|
value: string;
|
|
@@ -1862,13 +1854,19 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1862
1854
|
}[];
|
|
1863
1855
|
encoding: "form-data" | "urlencoded";
|
|
1864
1856
|
} | undefined;
|
|
1865
|
-
binary?: Blob | undefined;
|
|
1866
1857
|
raw?: {
|
|
1867
1858
|
value: string;
|
|
1868
1859
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1869
1860
|
} | undefined;
|
|
1870
1861
|
};
|
|
1871
1862
|
requestUid: string;
|
|
1863
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1864
|
+
};
|
|
1865
|
+
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
1866
|
+
set: (item: {
|
|
1867
|
+
type: "requestExample";
|
|
1868
|
+
uid: string;
|
|
1869
|
+
name: string;
|
|
1872
1870
|
parameters: {
|
|
1873
1871
|
path: {
|
|
1874
1872
|
value: string;
|
|
@@ -1931,14 +1929,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1931
1929
|
nullable?: boolean | undefined;
|
|
1932
1930
|
}[];
|
|
1933
1931
|
};
|
|
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
1932
|
body: {
|
|
1941
|
-
activeBody: "
|
|
1933
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1934
|
+
binary?: Blob | undefined;
|
|
1942
1935
|
formData?: {
|
|
1943
1936
|
value: {
|
|
1944
1937
|
value: string;
|
|
@@ -1957,13 +1950,18 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1957
1950
|
}[];
|
|
1958
1951
|
encoding: "form-data" | "urlencoded";
|
|
1959
1952
|
} | undefined;
|
|
1960
|
-
binary?: Blob | undefined;
|
|
1961
1953
|
raw?: {
|
|
1962
1954
|
value: string;
|
|
1963
1955
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1964
1956
|
} | undefined;
|
|
1965
1957
|
};
|
|
1966
1958
|
requestUid: string;
|
|
1959
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1960
|
+
}) => void;
|
|
1961
|
+
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" ? {
|
|
1962
|
+
type: "requestExample";
|
|
1963
|
+
uid: string;
|
|
1964
|
+
name: string;
|
|
1967
1965
|
parameters: {
|
|
1968
1966
|
path: {
|
|
1969
1967
|
value: string;
|
|
@@ -2026,13 +2024,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2026
2024
|
nullable?: boolean | undefined;
|
|
2027
2025
|
}[];
|
|
2028
2026
|
};
|
|
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
2027
|
body: {
|
|
2035
|
-
activeBody: "
|
|
2028
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2029
|
+
binary?: Blob | undefined;
|
|
2036
2030
|
formData?: {
|
|
2037
2031
|
value: {
|
|
2038
2032
|
value: string;
|
|
@@ -2051,13 +2045,17 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2051
2045
|
}[];
|
|
2052
2046
|
encoding: "form-data" | "urlencoded";
|
|
2053
2047
|
} | undefined;
|
|
2054
|
-
binary?: Blob | undefined;
|
|
2055
2048
|
raw?: {
|
|
2056
2049
|
value: string;
|
|
2057
2050
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2058
2051
|
} | undefined;
|
|
2059
2052
|
};
|
|
2060
2053
|
requestUid: string;
|
|
2054
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2055
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2056
|
+
type: "requestExample";
|
|
2057
|
+
uid: string;
|
|
2058
|
+
name: string;
|
|
2061
2059
|
parameters: {
|
|
2062
2060
|
path: {
|
|
2063
2061
|
value: string;
|
|
@@ -2120,13 +2118,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2120
2118
|
nullable?: boolean | undefined;
|
|
2121
2119
|
}[];
|
|
2122
2120
|
};
|
|
2123
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2124
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2125
|
-
type: "requestExample";
|
|
2126
|
-
uid: string;
|
|
2127
|
-
name: string;
|
|
2128
2121
|
body: {
|
|
2129
|
-
activeBody: "
|
|
2122
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2123
|
+
binary?: Blob | undefined;
|
|
2130
2124
|
formData?: {
|
|
2131
2125
|
value: {
|
|
2132
2126
|
value: string;
|
|
@@ -2145,13 +2139,17 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2145
2139
|
}[];
|
|
2146
2140
|
encoding: "form-data" | "urlencoded";
|
|
2147
2141
|
} | undefined;
|
|
2148
|
-
binary?: Blob | undefined;
|
|
2149
2142
|
raw?: {
|
|
2150
2143
|
value: string;
|
|
2151
2144
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2152
2145
|
} | undefined;
|
|
2153
2146
|
};
|
|
2154
2147
|
requestUid: string;
|
|
2148
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2149
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2150
|
+
type: "requestExample";
|
|
2151
|
+
uid: string;
|
|
2152
|
+
name: string;
|
|
2155
2153
|
parameters: {
|
|
2156
2154
|
path: {
|
|
2157
2155
|
value: string;
|
|
@@ -2214,14 +2212,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2214
2212
|
nullable?: boolean | undefined;
|
|
2215
2213
|
}[];
|
|
2216
2214
|
};
|
|
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
2215
|
body: {
|
|
2224
|
-
activeBody: "
|
|
2216
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2217
|
+
binary?: Blob | undefined;
|
|
2225
2218
|
formData?: {
|
|
2226
2219
|
value: {
|
|
2227
2220
|
value: string;
|
|
@@ -2240,13 +2233,18 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2240
2233
|
}[];
|
|
2241
2234
|
encoding: "form-data" | "urlencoded";
|
|
2242
2235
|
} | undefined;
|
|
2243
|
-
binary?: Blob | undefined;
|
|
2244
2236
|
raw?: {
|
|
2245
2237
|
value: string;
|
|
2246
2238
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2247
2239
|
} | undefined;
|
|
2248
2240
|
};
|
|
2249
2241
|
requestUid: string;
|
|
2242
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2243
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2244
|
+
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" ? {
|
|
2245
|
+
type: "requestExample";
|
|
2246
|
+
uid: string;
|
|
2247
|
+
name: string;
|
|
2250
2248
|
parameters: {
|
|
2251
2249
|
path: {
|
|
2252
2250
|
value: string;
|
|
@@ -2309,13 +2307,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2309
2307
|
nullable?: boolean | undefined;
|
|
2310
2308
|
}[];
|
|
2311
2309
|
};
|
|
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
2310
|
body: {
|
|
2318
|
-
activeBody: "
|
|
2311
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2312
|
+
binary?: Blob | undefined;
|
|
2319
2313
|
formData?: {
|
|
2320
2314
|
value: {
|
|
2321
2315
|
value: string;
|
|
@@ -2334,13 +2328,17 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2334
2328
|
}[];
|
|
2335
2329
|
encoding: "form-data" | "urlencoded";
|
|
2336
2330
|
} | undefined;
|
|
2337
|
-
binary?: Blob | undefined;
|
|
2338
2331
|
raw?: {
|
|
2339
2332
|
value: string;
|
|
2340
2333
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2341
2334
|
} | undefined;
|
|
2342
2335
|
};
|
|
2343
2336
|
requestUid: string;
|
|
2337
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2338
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2339
|
+
type: "requestExample";
|
|
2340
|
+
uid: string;
|
|
2341
|
+
name: string;
|
|
2344
2342
|
parameters: {
|
|
2345
2343
|
path: {
|
|
2346
2344
|
value: string;
|
|
@@ -2403,13 +2401,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2403
2401
|
nullable?: boolean | undefined;
|
|
2404
2402
|
}[];
|
|
2405
2403
|
};
|
|
2406
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2407
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2408
|
-
type: "requestExample";
|
|
2409
|
-
uid: string;
|
|
2410
|
-
name: string;
|
|
2411
2404
|
body: {
|
|
2412
|
-
activeBody: "
|
|
2405
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2406
|
+
binary?: Blob | undefined;
|
|
2413
2407
|
formData?: {
|
|
2414
2408
|
value: {
|
|
2415
2409
|
value: string;
|
|
@@ -2428,13 +2422,17 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2428
2422
|
}[];
|
|
2429
2423
|
encoding: "form-data" | "urlencoded";
|
|
2430
2424
|
} | undefined;
|
|
2431
|
-
binary?: Blob | undefined;
|
|
2432
2425
|
raw?: {
|
|
2433
2426
|
value: string;
|
|
2434
2427
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2435
2428
|
} | undefined;
|
|
2436
2429
|
};
|
|
2437
2430
|
requestUid: string;
|
|
2431
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2432
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2433
|
+
type: "requestExample";
|
|
2434
|
+
uid: string;
|
|
2435
|
+
name: string;
|
|
2438
2436
|
parameters: {
|
|
2439
2437
|
path: {
|
|
2440
2438
|
value: string;
|
|
@@ -2497,6 +2495,33 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
2497
2495
|
nullable?: boolean | undefined;
|
|
2498
2496
|
}[];
|
|
2499
2497
|
};
|
|
2498
|
+
body: {
|
|
2499
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2500
|
+
binary?: Blob | undefined;
|
|
2501
|
+
formData?: {
|
|
2502
|
+
value: {
|
|
2503
|
+
value: string;
|
|
2504
|
+
key: string;
|
|
2505
|
+
enabled: boolean;
|
|
2506
|
+
minimum?: number | undefined;
|
|
2507
|
+
type?: string | undefined;
|
|
2508
|
+
maximum?: number | undefined;
|
|
2509
|
+
default?: any;
|
|
2510
|
+
required?: boolean | undefined;
|
|
2511
|
+
description?: string | undefined;
|
|
2512
|
+
enum?: string[] | undefined;
|
|
2513
|
+
format?: string | undefined;
|
|
2514
|
+
file?: any;
|
|
2515
|
+
nullable?: boolean | undefined;
|
|
2516
|
+
}[];
|
|
2517
|
+
encoding: "form-data" | "urlencoded";
|
|
2518
|
+
} | undefined;
|
|
2519
|
+
raw?: {
|
|
2520
|
+
value: string;
|
|
2521
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2522
|
+
} | undefined;
|
|
2523
|
+
};
|
|
2524
|
+
requestUid: string;
|
|
2500
2525
|
serverVariables?: Record<string, string[]> | undefined;
|
|
2501
2526
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2502
2527
|
undo: (uid: string) => void;
|
|
@@ -3287,6 +3312,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3287
3312
|
'x-scalar-children'?: {
|
|
3288
3313
|
tagName: string;
|
|
3289
3314
|
}[] | undefined;
|
|
3315
|
+
'x-internal'?: boolean | undefined;
|
|
3316
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3290
3317
|
}) => void;
|
|
3291
3318
|
add: (payload: import("@scalar/oas-utils/entities/spec").TagPayload, collectionUid: string) => void | {
|
|
3292
3319
|
type: "tag";
|
|
@@ -3301,6 +3328,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3301
3328
|
'x-scalar-children'?: {
|
|
3302
3329
|
tagName: string;
|
|
3303
3330
|
}[] | undefined;
|
|
3331
|
+
'x-internal'?: boolean | undefined;
|
|
3332
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3304
3333
|
};
|
|
3305
3334
|
delete: (tag: import("@scalar/oas-utils/entities/spec").Tag, collectionUid: string) => void;
|
|
3306
3335
|
set: (item: {
|
|
@@ -3316,8 +3345,10 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3316
3345
|
'x-scalar-children'?: {
|
|
3317
3346
|
tagName: string;
|
|
3318
3347
|
}[] | undefined;
|
|
3348
|
+
'x-internal'?: boolean | undefined;
|
|
3349
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3319
3350
|
}) => 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" ? {
|
|
3351
|
+
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
3352
|
type: "tag";
|
|
3322
3353
|
uid: string;
|
|
3323
3354
|
name: string;
|
|
@@ -3330,7 +3361,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3330
3361
|
'x-scalar-children'?: {
|
|
3331
3362
|
tagName: string;
|
|
3332
3363
|
}[] | undefined;
|
|
3333
|
-
|
|
3364
|
+
'x-internal'?: boolean | undefined;
|
|
3365
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3366
|
+
}[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
3367
|
type: "tag";
|
|
3335
3368
|
uid: string;
|
|
3336
3369
|
name: string;
|
|
@@ -3343,6 +3376,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3343
3376
|
'x-scalar-children'?: {
|
|
3344
3377
|
tagName: string;
|
|
3345
3378
|
}[] | undefined;
|
|
3379
|
+
'x-internal'?: boolean | undefined;
|
|
3380
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3346
3381
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
3347
3382
|
type: "tag";
|
|
3348
3383
|
uid: string;
|
|
@@ -3356,8 +3391,10 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3356
3391
|
'x-scalar-children'?: {
|
|
3357
3392
|
tagName: string;
|
|
3358
3393
|
}[] | undefined;
|
|
3394
|
+
'x-internal'?: boolean | undefined;
|
|
3395
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3359
3396
|
}[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" ? {
|
|
3397
|
+
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
3398
|
type: "tag";
|
|
3362
3399
|
uid: string;
|
|
3363
3400
|
name: string;
|
|
@@ -3370,7 +3407,9 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3370
3407
|
'x-scalar-children'?: {
|
|
3371
3408
|
tagName: string;
|
|
3372
3409
|
}[] | undefined;
|
|
3373
|
-
|
|
3410
|
+
'x-internal'?: boolean | undefined;
|
|
3411
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3412
|
+
}[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
3413
|
type: "tag";
|
|
3375
3414
|
uid: string;
|
|
3376
3415
|
name: string;
|
|
@@ -3383,6 +3422,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3383
3422
|
'x-scalar-children'?: {
|
|
3384
3423
|
tagName: string;
|
|
3385
3424
|
}[] | undefined;
|
|
3425
|
+
'x-internal'?: boolean | undefined;
|
|
3426
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3386
3427
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
3387
3428
|
type: "tag";
|
|
3388
3429
|
uid: string;
|
|
@@ -3396,6 +3437,8 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3396
3437
|
'x-scalar-children'?: {
|
|
3397
3438
|
tagName: string;
|
|
3398
3439
|
}[] | undefined;
|
|
3440
|
+
'x-internal'?: boolean | undefined;
|
|
3441
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3399
3442
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3400
3443
|
undo: (uid: string) => void;
|
|
3401
3444
|
redo: (uid: string) => void;
|
|
@@ -3681,6 +3724,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
3681
3724
|
'x-scalar-children'?: {
|
|
3682
3725
|
tagName: string;
|
|
3683
3726
|
}[] | undefined;
|
|
3727
|
+
'x-internal'?: boolean | undefined;
|
|
3728
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3684
3729
|
}>;
|
|
3685
3730
|
cookies: Record<string, {
|
|
3686
3731
|
value: string;
|
|
@@ -3706,33 +3751,6 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
3706
3751
|
type: "requestExample";
|
|
3707
3752
|
uid: string;
|
|
3708
3753
|
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
3754
|
parameters: {
|
|
3737
3755
|
path: {
|
|
3738
3756
|
value: string;
|
|
@@ -3795,6 +3813,33 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
3795
3813
|
nullable?: boolean | undefined;
|
|
3796
3814
|
}[];
|
|
3797
3815
|
};
|
|
3816
|
+
body: {
|
|
3817
|
+
activeBody: "binary" | "formData" | "raw";
|
|
3818
|
+
binary?: Blob | undefined;
|
|
3819
|
+
formData?: {
|
|
3820
|
+
value: {
|
|
3821
|
+
value: string;
|
|
3822
|
+
key: string;
|
|
3823
|
+
enabled: boolean;
|
|
3824
|
+
minimum?: number | undefined;
|
|
3825
|
+
type?: string | undefined;
|
|
3826
|
+
maximum?: number | undefined;
|
|
3827
|
+
default?: any;
|
|
3828
|
+
required?: boolean | undefined;
|
|
3829
|
+
description?: string | undefined;
|
|
3830
|
+
enum?: string[] | undefined;
|
|
3831
|
+
format?: string | undefined;
|
|
3832
|
+
file?: any;
|
|
3833
|
+
nullable?: boolean | undefined;
|
|
3834
|
+
}[];
|
|
3835
|
+
encoding: "form-data" | "urlencoded";
|
|
3836
|
+
} | undefined;
|
|
3837
|
+
raw?: {
|
|
3838
|
+
value: string;
|
|
3839
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
3840
|
+
} | undefined;
|
|
3841
|
+
};
|
|
3842
|
+
requestUid: string;
|
|
3798
3843
|
serverVariables?: Record<string, string[]> | undefined;
|
|
3799
3844
|
}>;
|
|
3800
3845
|
requests: Record<string, {
|
|
@@ -3812,6 +3857,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
3812
3857
|
url: string;
|
|
3813
3858
|
description?: string | undefined;
|
|
3814
3859
|
} | undefined;
|
|
3860
|
+
'x-internal'?: boolean | undefined;
|
|
3861
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3815
3862
|
security?: Record<string, string[]>[] | undefined;
|
|
3816
3863
|
tags?: string[] | undefined;
|
|
3817
3864
|
deprecated?: boolean | undefined;
|
|
@@ -3925,7 +3972,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
3925
3972
|
hide: () => void;
|
|
3926
3973
|
};
|
|
3927
3974
|
events: {
|
|
3928
|
-
executeRequest: import("../../libs/index.js").EventBus<
|
|
3975
|
+
executeRequest: import("../../libs/index.js").EventBus<{
|
|
3976
|
+
requestUid?: string;
|
|
3977
|
+
}>;
|
|
3929
3978
|
cancelRequest: import("../../libs/index.js").EventBus<any>;
|
|
3930
3979
|
requestStatus: import("../../libs/index.js").EventBus<import("../../libs/index.js").RequestStatus>;
|
|
3931
3980
|
commandPalette: import("../../libs/index.js").EventBus<import("../../components/CommandPalette/TheCommandPalette.vue.js").CommandPaletteEvent>;
|
|
@@ -3937,6 +3986,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
3937
3986
|
isReadOnly: boolean;
|
|
3938
3987
|
hideClientButton: boolean | undefined;
|
|
3939
3988
|
showSidebar: boolean;
|
|
3989
|
+
integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
|
|
3940
3990
|
importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
|
|
3941
3991
|
type?: "collection" | undefined;
|
|
3942
3992
|
uid?: string | undefined;
|
|
@@ -4493,7 +4543,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4493
4543
|
documentUrl?: string | undefined;
|
|
4494
4544
|
integration?: string | null | undefined;
|
|
4495
4545
|
}) => void;
|
|
4496
|
-
edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
4546
|
+
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
4547
|
type: "collection";
|
|
4498
4548
|
uid: string;
|
|
4499
4549
|
children: string[];
|
|
@@ -4547,7 +4597,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4547
4597
|
}> | undefined;
|
|
4548
4598
|
documentUrl?: string | undefined;
|
|
4549
4599
|
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" | "
|
|
4600
|
+
}[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
4601
|
type: "collection";
|
|
4552
4602
|
uid: string;
|
|
4553
4603
|
children: string[];
|
|
@@ -4656,7 +4706,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4656
4706
|
documentUrl?: string | undefined;
|
|
4657
4707
|
integration?: string | null | undefined;
|
|
4658
4708
|
}[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" | "
|
|
4709
|
+
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
4710
|
type: "collection";
|
|
4661
4711
|
uid: string;
|
|
4662
4712
|
children: string[];
|
|
@@ -4710,7 +4760,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4710
4760
|
}> | undefined;
|
|
4711
4761
|
documentUrl?: string | undefined;
|
|
4712
4762
|
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" | "
|
|
4763
|
+
}[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
4764
|
type: "collection";
|
|
4715
4765
|
uid: string;
|
|
4716
4766
|
children: string[];
|
|
@@ -4897,6 +4947,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4897
4947
|
url: string;
|
|
4898
4948
|
description?: string | undefined;
|
|
4899
4949
|
} | undefined;
|
|
4950
|
+
'x-internal'?: boolean | undefined;
|
|
4951
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
4900
4952
|
security?: Record<string, string[]>[] | undefined;
|
|
4901
4953
|
tags?: string[] | undefined;
|
|
4902
4954
|
deprecated?: boolean | undefined;
|
|
@@ -4934,6 +4986,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4934
4986
|
url: string;
|
|
4935
4987
|
description?: string | undefined;
|
|
4936
4988
|
} | undefined;
|
|
4989
|
+
'x-internal'?: boolean | undefined;
|
|
4990
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
4937
4991
|
security?: Record<string, string[]>[] | undefined;
|
|
4938
4992
|
tags?: string[] | undefined;
|
|
4939
4993
|
deprecated?: boolean | undefined;
|
|
@@ -4972,6 +5026,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4972
5026
|
url: string;
|
|
4973
5027
|
description?: string | undefined;
|
|
4974
5028
|
} | undefined;
|
|
5029
|
+
'x-internal'?: boolean | undefined;
|
|
5030
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
4975
5031
|
security?: Record<string, string[]>[] | undefined;
|
|
4976
5032
|
tags?: string[] | undefined;
|
|
4977
5033
|
deprecated?: boolean | undefined;
|
|
@@ -4994,7 +5050,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4994
5050
|
requestBody?: any;
|
|
4995
5051
|
responses?: Record<string, any> | undefined;
|
|
4996
5052
|
}) => void;
|
|
4997
|
-
edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
5053
|
+
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
5054
|
path: string;
|
|
4999
5055
|
type: "request";
|
|
5000
5056
|
uid: string;
|
|
@@ -5009,6 +5065,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5009
5065
|
url: string;
|
|
5010
5066
|
description?: string | undefined;
|
|
5011
5067
|
} | undefined;
|
|
5068
|
+
'x-internal'?: boolean | undefined;
|
|
5069
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
5012
5070
|
security?: Record<string, string[]>[] | undefined;
|
|
5013
5071
|
tags?: string[] | undefined;
|
|
5014
5072
|
deprecated?: boolean | undefined;
|
|
@@ -5030,7 +5088,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5030
5088
|
}[] | undefined;
|
|
5031
5089
|
requestBody?: any;
|
|
5032
5090
|
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" | "
|
|
5091
|
+
}[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
5092
|
path: string;
|
|
5035
5093
|
type: "request";
|
|
5036
5094
|
uid: string;
|
|
@@ -5045,6 +5103,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5045
5103
|
url: string;
|
|
5046
5104
|
description?: string | undefined;
|
|
5047
5105
|
} | undefined;
|
|
5106
|
+
'x-internal'?: boolean | undefined;
|
|
5107
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
5048
5108
|
security?: Record<string, string[]>[] | undefined;
|
|
5049
5109
|
tags?: string[] | undefined;
|
|
5050
5110
|
deprecated?: boolean | undefined;
|
|
@@ -5081,6 +5141,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5081
5141
|
url: string;
|
|
5082
5142
|
description?: string | undefined;
|
|
5083
5143
|
} | undefined;
|
|
5144
|
+
'x-internal'?: boolean | undefined;
|
|
5145
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
5084
5146
|
security?: Record<string, string[]>[] | undefined;
|
|
5085
5147
|
tags?: string[] | undefined;
|
|
5086
5148
|
deprecated?: boolean | undefined;
|
|
@@ -5103,7 +5165,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5103
5165
|
requestBody?: any;
|
|
5104
5166
|
responses?: Record<string, any> | undefined;
|
|
5105
5167
|
}[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" |
|
|
5168
|
+
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
5169
|
path: string;
|
|
5108
5170
|
type: "request";
|
|
5109
5171
|
uid: string;
|
|
@@ -5118,6 +5180,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5118
5180
|
url: string;
|
|
5119
5181
|
description?: string | undefined;
|
|
5120
5182
|
} | undefined;
|
|
5183
|
+
'x-internal'?: boolean | undefined;
|
|
5184
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
5121
5185
|
security?: Record<string, string[]>[] | undefined;
|
|
5122
5186
|
tags?: string[] | undefined;
|
|
5123
5187
|
deprecated?: boolean | undefined;
|
|
@@ -5139,7 +5203,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5139
5203
|
}[] | undefined;
|
|
5140
5204
|
requestBody?: any;
|
|
5141
5205
|
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" | "
|
|
5206
|
+
}[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
5207
|
path: string;
|
|
5144
5208
|
type: "request";
|
|
5145
5209
|
uid: string;
|
|
@@ -5154,6 +5218,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5154
5218
|
url: string;
|
|
5155
5219
|
description?: string | undefined;
|
|
5156
5220
|
} | undefined;
|
|
5221
|
+
'x-internal'?: boolean | undefined;
|
|
5222
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
5157
5223
|
security?: Record<string, string[]>[] | undefined;
|
|
5158
5224
|
tags?: string[] | undefined;
|
|
5159
5225
|
deprecated?: boolean | undefined;
|
|
@@ -5190,6 +5256,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5190
5256
|
url: string;
|
|
5191
5257
|
description?: string | undefined;
|
|
5192
5258
|
} | undefined;
|
|
5259
|
+
'x-internal'?: boolean | undefined;
|
|
5260
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
5193
5261
|
security?: Record<string, string[]>[] | undefined;
|
|
5194
5262
|
tags?: string[] | undefined;
|
|
5195
5263
|
deprecated?: boolean | undefined;
|
|
@@ -5222,33 +5290,6 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5222
5290
|
type: "requestExample";
|
|
5223
5291
|
uid: string;
|
|
5224
5292
|
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
5293
|
parameters: {
|
|
5253
5294
|
path: {
|
|
5254
5295
|
value: string;
|
|
@@ -5311,14 +5352,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5311
5352
|
nullable?: boolean | undefined;
|
|
5312
5353
|
}[];
|
|
5313
5354
|
};
|
|
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
5355
|
body: {
|
|
5321
|
-
activeBody: "
|
|
5356
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5357
|
+
binary?: Blob | undefined;
|
|
5322
5358
|
formData?: {
|
|
5323
5359
|
value: {
|
|
5324
5360
|
value: string;
|
|
@@ -5337,13 +5373,18 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5337
5373
|
}[];
|
|
5338
5374
|
encoding: "form-data" | "urlencoded";
|
|
5339
5375
|
} | undefined;
|
|
5340
|
-
binary?: Blob | undefined;
|
|
5341
5376
|
raw?: {
|
|
5342
5377
|
value: string;
|
|
5343
5378
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5344
5379
|
} | undefined;
|
|
5345
5380
|
};
|
|
5346
5381
|
requestUid: string;
|
|
5382
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5383
|
+
}) => void;
|
|
5384
|
+
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
5385
|
+
type: "requestExample";
|
|
5386
|
+
uid: string;
|
|
5387
|
+
name: string;
|
|
5347
5388
|
parameters: {
|
|
5348
5389
|
path: {
|
|
5349
5390
|
value: string;
|
|
@@ -5406,15 +5447,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5406
5447
|
nullable?: boolean | undefined;
|
|
5407
5448
|
}[];
|
|
5408
5449
|
};
|
|
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
5450
|
body: {
|
|
5417
|
-
activeBody: "
|
|
5451
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5452
|
+
binary?: Blob | undefined;
|
|
5418
5453
|
formData?: {
|
|
5419
5454
|
value: {
|
|
5420
5455
|
value: string;
|
|
@@ -5433,13 +5468,19 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5433
5468
|
}[];
|
|
5434
5469
|
encoding: "form-data" | "urlencoded";
|
|
5435
5470
|
} | undefined;
|
|
5436
|
-
binary?: Blob | undefined;
|
|
5437
5471
|
raw?: {
|
|
5438
5472
|
value: string;
|
|
5439
5473
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5440
5474
|
} | undefined;
|
|
5441
5475
|
};
|
|
5442
5476
|
requestUid: string;
|
|
5477
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5478
|
+
};
|
|
5479
|
+
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
5480
|
+
set: (item: {
|
|
5481
|
+
type: "requestExample";
|
|
5482
|
+
uid: string;
|
|
5483
|
+
name: string;
|
|
5443
5484
|
parameters: {
|
|
5444
5485
|
path: {
|
|
5445
5486
|
value: string;
|
|
@@ -5502,14 +5543,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5502
5543
|
nullable?: boolean | undefined;
|
|
5503
5544
|
}[];
|
|
5504
5545
|
};
|
|
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
5546
|
body: {
|
|
5512
|
-
activeBody: "
|
|
5547
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5548
|
+
binary?: Blob | undefined;
|
|
5513
5549
|
formData?: {
|
|
5514
5550
|
value: {
|
|
5515
5551
|
value: string;
|
|
@@ -5528,13 +5564,18 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5528
5564
|
}[];
|
|
5529
5565
|
encoding: "form-data" | "urlencoded";
|
|
5530
5566
|
} | undefined;
|
|
5531
|
-
binary?: Blob | undefined;
|
|
5532
5567
|
raw?: {
|
|
5533
5568
|
value: string;
|
|
5534
5569
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5535
5570
|
} | undefined;
|
|
5536
5571
|
};
|
|
5537
5572
|
requestUid: string;
|
|
5573
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5574
|
+
}) => void;
|
|
5575
|
+
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" ? {
|
|
5576
|
+
type: "requestExample";
|
|
5577
|
+
uid: string;
|
|
5578
|
+
name: string;
|
|
5538
5579
|
parameters: {
|
|
5539
5580
|
path: {
|
|
5540
5581
|
value: string;
|
|
@@ -5597,13 +5638,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5597
5638
|
nullable?: boolean | undefined;
|
|
5598
5639
|
}[];
|
|
5599
5640
|
};
|
|
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
5641
|
body: {
|
|
5606
|
-
activeBody: "
|
|
5642
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5643
|
+
binary?: Blob | undefined;
|
|
5607
5644
|
formData?: {
|
|
5608
5645
|
value: {
|
|
5609
5646
|
value: string;
|
|
@@ -5622,13 +5659,17 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5622
5659
|
}[];
|
|
5623
5660
|
encoding: "form-data" | "urlencoded";
|
|
5624
5661
|
} | undefined;
|
|
5625
|
-
binary?: Blob | undefined;
|
|
5626
5662
|
raw?: {
|
|
5627
5663
|
value: string;
|
|
5628
5664
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5629
5665
|
} | undefined;
|
|
5630
5666
|
};
|
|
5631
5667
|
requestUid: string;
|
|
5668
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5669
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
5670
|
+
type: "requestExample";
|
|
5671
|
+
uid: string;
|
|
5672
|
+
name: string;
|
|
5632
5673
|
parameters: {
|
|
5633
5674
|
path: {
|
|
5634
5675
|
value: string;
|
|
@@ -5691,13 +5732,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5691
5732
|
nullable?: boolean | undefined;
|
|
5692
5733
|
}[];
|
|
5693
5734
|
};
|
|
5694
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5695
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
5696
|
-
type: "requestExample";
|
|
5697
|
-
uid: string;
|
|
5698
|
-
name: string;
|
|
5699
5735
|
body: {
|
|
5700
|
-
activeBody: "
|
|
5736
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5737
|
+
binary?: Blob | undefined;
|
|
5701
5738
|
formData?: {
|
|
5702
5739
|
value: {
|
|
5703
5740
|
value: string;
|
|
@@ -5716,13 +5753,17 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5716
5753
|
}[];
|
|
5717
5754
|
encoding: "form-data" | "urlencoded";
|
|
5718
5755
|
} | undefined;
|
|
5719
|
-
binary?: Blob | undefined;
|
|
5720
5756
|
raw?: {
|
|
5721
5757
|
value: string;
|
|
5722
5758
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5723
5759
|
} | undefined;
|
|
5724
5760
|
};
|
|
5725
5761
|
requestUid: string;
|
|
5762
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5763
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
5764
|
+
type: "requestExample";
|
|
5765
|
+
uid: string;
|
|
5766
|
+
name: string;
|
|
5726
5767
|
parameters: {
|
|
5727
5768
|
path: {
|
|
5728
5769
|
value: string;
|
|
@@ -5785,14 +5826,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5785
5826
|
nullable?: boolean | undefined;
|
|
5786
5827
|
}[];
|
|
5787
5828
|
};
|
|
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
5829
|
body: {
|
|
5795
|
-
activeBody: "
|
|
5830
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5831
|
+
binary?: Blob | undefined;
|
|
5796
5832
|
formData?: {
|
|
5797
5833
|
value: {
|
|
5798
5834
|
value: string;
|
|
@@ -5811,13 +5847,18 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5811
5847
|
}[];
|
|
5812
5848
|
encoding: "form-data" | "urlencoded";
|
|
5813
5849
|
} | undefined;
|
|
5814
|
-
binary?: Blob | undefined;
|
|
5815
5850
|
raw?: {
|
|
5816
5851
|
value: string;
|
|
5817
5852
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5818
5853
|
} | undefined;
|
|
5819
5854
|
};
|
|
5820
5855
|
requestUid: string;
|
|
5856
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5857
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
5858
|
+
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" ? {
|
|
5859
|
+
type: "requestExample";
|
|
5860
|
+
uid: string;
|
|
5861
|
+
name: string;
|
|
5821
5862
|
parameters: {
|
|
5822
5863
|
path: {
|
|
5823
5864
|
value: string;
|
|
@@ -5880,13 +5921,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5880
5921
|
nullable?: boolean | undefined;
|
|
5881
5922
|
}[];
|
|
5882
5923
|
};
|
|
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
5924
|
body: {
|
|
5889
|
-
activeBody: "
|
|
5925
|
+
activeBody: "binary" | "formData" | "raw";
|
|
5926
|
+
binary?: Blob | undefined;
|
|
5890
5927
|
formData?: {
|
|
5891
5928
|
value: {
|
|
5892
5929
|
value: string;
|
|
@@ -5905,13 +5942,17 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5905
5942
|
}[];
|
|
5906
5943
|
encoding: "form-data" | "urlencoded";
|
|
5907
5944
|
} | undefined;
|
|
5908
|
-
binary?: Blob | undefined;
|
|
5909
5945
|
raw?: {
|
|
5910
5946
|
value: string;
|
|
5911
5947
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
5912
5948
|
} | undefined;
|
|
5913
5949
|
};
|
|
5914
5950
|
requestUid: string;
|
|
5951
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
5952
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
5953
|
+
type: "requestExample";
|
|
5954
|
+
uid: string;
|
|
5955
|
+
name: string;
|
|
5915
5956
|
parameters: {
|
|
5916
5957
|
path: {
|
|
5917
5958
|
value: string;
|
|
@@ -5974,13 +6015,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5974
6015
|
nullable?: boolean | undefined;
|
|
5975
6016
|
}[];
|
|
5976
6017
|
};
|
|
5977
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
5978
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
5979
|
-
type: "requestExample";
|
|
5980
|
-
uid: string;
|
|
5981
|
-
name: string;
|
|
5982
6018
|
body: {
|
|
5983
|
-
activeBody: "
|
|
6019
|
+
activeBody: "binary" | "formData" | "raw";
|
|
6020
|
+
binary?: Blob | undefined;
|
|
5984
6021
|
formData?: {
|
|
5985
6022
|
value: {
|
|
5986
6023
|
value: string;
|
|
@@ -5999,13 +6036,17 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5999
6036
|
}[];
|
|
6000
6037
|
encoding: "form-data" | "urlencoded";
|
|
6001
6038
|
} | undefined;
|
|
6002
|
-
binary?: Blob | undefined;
|
|
6003
6039
|
raw?: {
|
|
6004
6040
|
value: string;
|
|
6005
6041
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
6006
6042
|
} | undefined;
|
|
6007
6043
|
};
|
|
6008
6044
|
requestUid: string;
|
|
6045
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
6046
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6047
|
+
type: "requestExample";
|
|
6048
|
+
uid: string;
|
|
6049
|
+
name: string;
|
|
6009
6050
|
parameters: {
|
|
6010
6051
|
path: {
|
|
6011
6052
|
value: string;
|
|
@@ -6068,6 +6109,33 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6068
6109
|
nullable?: boolean | undefined;
|
|
6069
6110
|
}[];
|
|
6070
6111
|
};
|
|
6112
|
+
body: {
|
|
6113
|
+
activeBody: "binary" | "formData" | "raw";
|
|
6114
|
+
binary?: Blob | undefined;
|
|
6115
|
+
formData?: {
|
|
6116
|
+
value: {
|
|
6117
|
+
value: string;
|
|
6118
|
+
key: string;
|
|
6119
|
+
enabled: boolean;
|
|
6120
|
+
minimum?: number | undefined;
|
|
6121
|
+
type?: string | undefined;
|
|
6122
|
+
maximum?: number | undefined;
|
|
6123
|
+
default?: any;
|
|
6124
|
+
required?: boolean | undefined;
|
|
6125
|
+
description?: string | undefined;
|
|
6126
|
+
enum?: string[] | undefined;
|
|
6127
|
+
format?: string | undefined;
|
|
6128
|
+
file?: any;
|
|
6129
|
+
nullable?: boolean | undefined;
|
|
6130
|
+
}[];
|
|
6131
|
+
encoding: "form-data" | "urlencoded";
|
|
6132
|
+
} | undefined;
|
|
6133
|
+
raw?: {
|
|
6134
|
+
value: string;
|
|
6135
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
6136
|
+
} | undefined;
|
|
6137
|
+
};
|
|
6138
|
+
requestUid: string;
|
|
6071
6139
|
serverVariables?: Record<string, string[]> | undefined;
|
|
6072
6140
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
6073
6141
|
undo: (uid: string) => void;
|
|
@@ -6858,6 +6926,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6858
6926
|
'x-scalar-children'?: {
|
|
6859
6927
|
tagName: string;
|
|
6860
6928
|
}[] | undefined;
|
|
6929
|
+
'x-internal'?: boolean | undefined;
|
|
6930
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
6861
6931
|
}) => void;
|
|
6862
6932
|
add: (payload: import("@scalar/oas-utils/entities/spec").TagPayload, collectionUid: string) => void | {
|
|
6863
6933
|
type: "tag";
|
|
@@ -6872,6 +6942,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6872
6942
|
'x-scalar-children'?: {
|
|
6873
6943
|
tagName: string;
|
|
6874
6944
|
}[] | undefined;
|
|
6945
|
+
'x-internal'?: boolean | undefined;
|
|
6946
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
6875
6947
|
};
|
|
6876
6948
|
delete: (tag: import("@scalar/oas-utils/entities/spec").Tag, collectionUid: string) => void;
|
|
6877
6949
|
set: (item: {
|
|
@@ -6887,8 +6959,10 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6887
6959
|
'x-scalar-children'?: {
|
|
6888
6960
|
tagName: string;
|
|
6889
6961
|
}[] | undefined;
|
|
6962
|
+
'x-internal'?: boolean | undefined;
|
|
6963
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
6890
6964
|
}) => 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" ? {
|
|
6965
|
+
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
6966
|
type: "tag";
|
|
6893
6967
|
uid: string;
|
|
6894
6968
|
name: string;
|
|
@@ -6901,7 +6975,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6901
6975
|
'x-scalar-children'?: {
|
|
6902
6976
|
tagName: string;
|
|
6903
6977
|
}[] | undefined;
|
|
6904
|
-
|
|
6978
|
+
'x-internal'?: boolean | undefined;
|
|
6979
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
6980
|
+
}[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
6981
|
type: "tag";
|
|
6906
6982
|
uid: string;
|
|
6907
6983
|
name: string;
|
|
@@ -6914,6 +6990,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6914
6990
|
'x-scalar-children'?: {
|
|
6915
6991
|
tagName: string;
|
|
6916
6992
|
}[] | undefined;
|
|
6993
|
+
'x-internal'?: boolean | undefined;
|
|
6994
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
6917
6995
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6918
6996
|
type: "tag";
|
|
6919
6997
|
uid: string;
|
|
@@ -6927,8 +7005,10 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6927
7005
|
'x-scalar-children'?: {
|
|
6928
7006
|
tagName: string;
|
|
6929
7007
|
}[] | undefined;
|
|
7008
|
+
'x-internal'?: boolean | undefined;
|
|
7009
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
6930
7010
|
}[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" ? {
|
|
7011
|
+
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
7012
|
type: "tag";
|
|
6933
7013
|
uid: string;
|
|
6934
7014
|
name: string;
|
|
@@ -6941,7 +7021,9 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6941
7021
|
'x-scalar-children'?: {
|
|
6942
7022
|
tagName: string;
|
|
6943
7023
|
}[] | undefined;
|
|
6944
|
-
|
|
7024
|
+
'x-internal'?: boolean | undefined;
|
|
7025
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
7026
|
+
}[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
7027
|
type: "tag";
|
|
6946
7028
|
uid: string;
|
|
6947
7029
|
name: string;
|
|
@@ -6954,6 +7036,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6954
7036
|
'x-scalar-children'?: {
|
|
6955
7037
|
tagName: string;
|
|
6956
7038
|
}[] | undefined;
|
|
7039
|
+
'x-internal'?: boolean | undefined;
|
|
7040
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
6957
7041
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6958
7042
|
type: "tag";
|
|
6959
7043
|
uid: string;
|
|
@@ -6967,6 +7051,8 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
6967
7051
|
'x-scalar-children'?: {
|
|
6968
7052
|
tagName: string;
|
|
6969
7053
|
}[] | undefined;
|
|
7054
|
+
'x-internal'?: boolean | undefined;
|
|
7055
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
6970
7056
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
6971
7057
|
undo: (uid: string) => void;
|
|
6972
7058
|
redo: (uid: string) => void;
|