@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
|
@@ -108,6 +108,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
108
108
|
'x-scalar-children'?: {
|
|
109
109
|
tagName: string;
|
|
110
110
|
}[] | undefined;
|
|
111
|
+
'x-internal'?: boolean | undefined;
|
|
112
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
111
113
|
}>;
|
|
112
114
|
cookies: Record<string, {
|
|
113
115
|
value: string;
|
|
@@ -133,33 +135,6 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
133
135
|
type: "requestExample";
|
|
134
136
|
uid: string;
|
|
135
137
|
name: string;
|
|
136
|
-
body: {
|
|
137
|
-
activeBody: "formData" | "binary" | "raw";
|
|
138
|
-
formData?: {
|
|
139
|
-
value: {
|
|
140
|
-
value: string;
|
|
141
|
-
key: string;
|
|
142
|
-
enabled: boolean;
|
|
143
|
-
minimum?: number | undefined;
|
|
144
|
-
type?: string | undefined;
|
|
145
|
-
maximum?: number | undefined;
|
|
146
|
-
default?: any;
|
|
147
|
-
required?: boolean | undefined;
|
|
148
|
-
description?: string | undefined;
|
|
149
|
-
enum?: string[] | undefined;
|
|
150
|
-
format?: string | undefined;
|
|
151
|
-
file?: any;
|
|
152
|
-
nullable?: boolean | undefined;
|
|
153
|
-
}[];
|
|
154
|
-
encoding: "form-data" | "urlencoded";
|
|
155
|
-
} | undefined;
|
|
156
|
-
binary?: Blob | undefined;
|
|
157
|
-
raw?: {
|
|
158
|
-
value: string;
|
|
159
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
160
|
-
} | undefined;
|
|
161
|
-
};
|
|
162
|
-
requestUid: string;
|
|
163
138
|
parameters: {
|
|
164
139
|
path: {
|
|
165
140
|
value: string;
|
|
@@ -222,6 +197,33 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
222
197
|
nullable?: boolean | undefined;
|
|
223
198
|
}[];
|
|
224
199
|
};
|
|
200
|
+
body: {
|
|
201
|
+
activeBody: "binary" | "formData" | "raw";
|
|
202
|
+
binary?: Blob | undefined;
|
|
203
|
+
formData?: {
|
|
204
|
+
value: {
|
|
205
|
+
value: string;
|
|
206
|
+
key: string;
|
|
207
|
+
enabled: boolean;
|
|
208
|
+
minimum?: number | undefined;
|
|
209
|
+
type?: string | undefined;
|
|
210
|
+
maximum?: number | undefined;
|
|
211
|
+
default?: any;
|
|
212
|
+
required?: boolean | undefined;
|
|
213
|
+
description?: string | undefined;
|
|
214
|
+
enum?: string[] | undefined;
|
|
215
|
+
format?: string | undefined;
|
|
216
|
+
file?: any;
|
|
217
|
+
nullable?: boolean | undefined;
|
|
218
|
+
}[];
|
|
219
|
+
encoding: "form-data" | "urlencoded";
|
|
220
|
+
} | undefined;
|
|
221
|
+
raw?: {
|
|
222
|
+
value: string;
|
|
223
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
224
|
+
} | undefined;
|
|
225
|
+
};
|
|
226
|
+
requestUid: string;
|
|
225
227
|
serverVariables?: Record<string, string[]> | undefined;
|
|
226
228
|
}>;
|
|
227
229
|
requests: Record<string, {
|
|
@@ -239,6 +241,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
239
241
|
url: string;
|
|
240
242
|
description?: string | undefined;
|
|
241
243
|
} | undefined;
|
|
244
|
+
'x-internal'?: boolean | undefined;
|
|
245
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
242
246
|
security?: Record<string, string[]>[] | undefined;
|
|
243
247
|
tags?: string[] | undefined;
|
|
244
248
|
deprecated?: boolean | undefined;
|
|
@@ -352,7 +356,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
352
356
|
hide: () => void;
|
|
353
357
|
};
|
|
354
358
|
events: {
|
|
355
|
-
executeRequest: import("../../libs/index.js").EventBus<
|
|
359
|
+
executeRequest: import("../../libs/index.js").EventBus<{
|
|
360
|
+
requestUid?: string;
|
|
361
|
+
}>;
|
|
356
362
|
cancelRequest: import("../../libs/index.js").EventBus<any>;
|
|
357
363
|
requestStatus: import("../../libs/index.js").EventBus<import("../../libs/index.js").RequestStatus>;
|
|
358
364
|
commandPalette: import("../../libs/index.js").EventBus<import("../../components/CommandPalette/TheCommandPalette.vue.js").CommandPaletteEvent>;
|
|
@@ -364,6 +370,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
364
370
|
isReadOnly: boolean;
|
|
365
371
|
hideClientButton: boolean | undefined;
|
|
366
372
|
showSidebar: boolean;
|
|
373
|
+
integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
|
|
367
374
|
importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
|
|
368
375
|
type?: "collection" | undefined;
|
|
369
376
|
uid?: string | undefined;
|
|
@@ -920,7 +927,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
920
927
|
documentUrl?: string | undefined;
|
|
921
928
|
integration?: string | null | undefined;
|
|
922
929
|
}) => void;
|
|
923
|
-
edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
930
|
+
edit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? {
|
|
924
931
|
type: "collection";
|
|
925
932
|
uid: string;
|
|
926
933
|
children: string[];
|
|
@@ -974,7 +981,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
974
981
|
}> | undefined;
|
|
975
982
|
documentUrl?: string | undefined;
|
|
976
983
|
integration?: string | null | undefined;
|
|
977
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
984
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
978
985
|
type: "collection";
|
|
979
986
|
uid: string;
|
|
980
987
|
children: string[];
|
|
@@ -1083,7 +1090,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1083
1090
|
documentUrl?: string | undefined;
|
|
1084
1091
|
integration?: string | null | undefined;
|
|
1085
1092
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1086
|
-
untrackedEdit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
1093
|
+
untrackedEdit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? {
|
|
1087
1094
|
type: "collection";
|
|
1088
1095
|
uid: string;
|
|
1089
1096
|
children: string[];
|
|
@@ -1137,7 +1144,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1137
1144
|
}> | undefined;
|
|
1138
1145
|
documentUrl?: string | undefined;
|
|
1139
1146
|
integration?: string | null | undefined;
|
|
1140
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
1147
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1141
1148
|
type: "collection";
|
|
1142
1149
|
uid: string;
|
|
1143
1150
|
children: string[];
|
|
@@ -1324,6 +1331,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1324
1331
|
url: string;
|
|
1325
1332
|
description?: string | undefined;
|
|
1326
1333
|
} | undefined;
|
|
1334
|
+
'x-internal'?: boolean | undefined;
|
|
1335
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1327
1336
|
security?: Record<string, string[]>[] | undefined;
|
|
1328
1337
|
tags?: string[] | undefined;
|
|
1329
1338
|
deprecated?: boolean | undefined;
|
|
@@ -1361,6 +1370,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1361
1370
|
url: string;
|
|
1362
1371
|
description?: string | undefined;
|
|
1363
1372
|
} | undefined;
|
|
1373
|
+
'x-internal'?: boolean | undefined;
|
|
1374
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1364
1375
|
security?: Record<string, string[]>[] | undefined;
|
|
1365
1376
|
tags?: string[] | undefined;
|
|
1366
1377
|
deprecated?: boolean | undefined;
|
|
@@ -1399,6 +1410,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1399
1410
|
url: string;
|
|
1400
1411
|
description?: string | undefined;
|
|
1401
1412
|
} | undefined;
|
|
1413
|
+
'x-internal'?: boolean | undefined;
|
|
1414
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1402
1415
|
security?: Record<string, string[]>[] | undefined;
|
|
1403
1416
|
tags?: string[] | undefined;
|
|
1404
1417
|
deprecated?: boolean | undefined;
|
|
@@ -1421,7 +1434,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1421
1434
|
requestBody?: any;
|
|
1422
1435
|
responses?: Record<string, any> | undefined;
|
|
1423
1436
|
}) => void;
|
|
1424
|
-
edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
1437
|
+
edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | "method" | "path" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? {
|
|
1425
1438
|
path: string;
|
|
1426
1439
|
type: "request";
|
|
1427
1440
|
uid: string;
|
|
@@ -1436,6 +1449,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1436
1449
|
url: string;
|
|
1437
1450
|
description?: string | undefined;
|
|
1438
1451
|
} | undefined;
|
|
1452
|
+
'x-internal'?: boolean | undefined;
|
|
1453
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1439
1454
|
security?: Record<string, string[]>[] | undefined;
|
|
1440
1455
|
tags?: string[] | undefined;
|
|
1441
1456
|
deprecated?: boolean | undefined;
|
|
@@ -1457,7 +1472,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1457
1472
|
}[] | undefined;
|
|
1458
1473
|
requestBody?: any;
|
|
1459
1474
|
responses?: Record<string, any> | undefined;
|
|
1460
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "
|
|
1475
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1461
1476
|
path: string;
|
|
1462
1477
|
type: "request";
|
|
1463
1478
|
uid: string;
|
|
@@ -1472,6 +1487,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1472
1487
|
url: string;
|
|
1473
1488
|
description?: string | undefined;
|
|
1474
1489
|
} | undefined;
|
|
1490
|
+
'x-internal'?: boolean | undefined;
|
|
1491
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1475
1492
|
security?: Record<string, string[]>[] | undefined;
|
|
1476
1493
|
tags?: string[] | undefined;
|
|
1477
1494
|
deprecated?: boolean | undefined;
|
|
@@ -1508,6 +1525,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1508
1525
|
url: string;
|
|
1509
1526
|
description?: string | undefined;
|
|
1510
1527
|
} | undefined;
|
|
1528
|
+
'x-internal'?: boolean | undefined;
|
|
1529
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1511
1530
|
security?: Record<string, string[]>[] | undefined;
|
|
1512
1531
|
tags?: string[] | undefined;
|
|
1513
1532
|
deprecated?: boolean | undefined;
|
|
@@ -1530,7 +1549,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1530
1549
|
requestBody?: any;
|
|
1531
1550
|
responses?: Record<string, any> | undefined;
|
|
1532
1551
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1533
|
-
untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
1552
|
+
untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | "method" | "path" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? {
|
|
1534
1553
|
path: string;
|
|
1535
1554
|
type: "request";
|
|
1536
1555
|
uid: string;
|
|
@@ -1545,6 +1564,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1545
1564
|
url: string;
|
|
1546
1565
|
description?: string | undefined;
|
|
1547
1566
|
} | undefined;
|
|
1567
|
+
'x-internal'?: boolean | undefined;
|
|
1568
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1548
1569
|
security?: Record<string, string[]>[] | undefined;
|
|
1549
1570
|
tags?: string[] | undefined;
|
|
1550
1571
|
deprecated?: boolean | undefined;
|
|
@@ -1566,7 +1587,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1566
1587
|
}[] | undefined;
|
|
1567
1588
|
requestBody?: any;
|
|
1568
1589
|
responses?: Record<string, any> | undefined;
|
|
1569
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "
|
|
1590
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1570
1591
|
path: string;
|
|
1571
1592
|
type: "request";
|
|
1572
1593
|
uid: string;
|
|
@@ -1581,6 +1602,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1581
1602
|
url: string;
|
|
1582
1603
|
description?: string | undefined;
|
|
1583
1604
|
} | undefined;
|
|
1605
|
+
'x-internal'?: boolean | undefined;
|
|
1606
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1584
1607
|
security?: Record<string, string[]>[] | undefined;
|
|
1585
1608
|
tags?: string[] | undefined;
|
|
1586
1609
|
deprecated?: boolean | undefined;
|
|
@@ -1617,6 +1640,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1617
1640
|
url: string;
|
|
1618
1641
|
description?: string | undefined;
|
|
1619
1642
|
} | undefined;
|
|
1643
|
+
'x-internal'?: boolean | undefined;
|
|
1644
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1620
1645
|
security?: Record<string, string[]>[] | undefined;
|
|
1621
1646
|
tags?: string[] | undefined;
|
|
1622
1647
|
deprecated?: boolean | undefined;
|
|
@@ -1649,33 +1674,6 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1649
1674
|
type: "requestExample";
|
|
1650
1675
|
uid: string;
|
|
1651
1676
|
name: string;
|
|
1652
|
-
body: {
|
|
1653
|
-
activeBody: "formData" | "binary" | "raw";
|
|
1654
|
-
formData?: {
|
|
1655
|
-
value: {
|
|
1656
|
-
value: string;
|
|
1657
|
-
key: string;
|
|
1658
|
-
enabled: boolean;
|
|
1659
|
-
minimum?: number | undefined;
|
|
1660
|
-
type?: string | undefined;
|
|
1661
|
-
maximum?: number | undefined;
|
|
1662
|
-
default?: any;
|
|
1663
|
-
required?: boolean | undefined;
|
|
1664
|
-
description?: string | undefined;
|
|
1665
|
-
enum?: string[] | undefined;
|
|
1666
|
-
format?: string | undefined;
|
|
1667
|
-
file?: any;
|
|
1668
|
-
nullable?: boolean | undefined;
|
|
1669
|
-
}[];
|
|
1670
|
-
encoding: "form-data" | "urlencoded";
|
|
1671
|
-
} | undefined;
|
|
1672
|
-
binary?: Blob | undefined;
|
|
1673
|
-
raw?: {
|
|
1674
|
-
value: string;
|
|
1675
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1676
|
-
} | undefined;
|
|
1677
|
-
};
|
|
1678
|
-
requestUid: string;
|
|
1679
1677
|
parameters: {
|
|
1680
1678
|
path: {
|
|
1681
1679
|
value: string;
|
|
@@ -1738,14 +1736,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1738
1736
|
nullable?: boolean | undefined;
|
|
1739
1737
|
}[];
|
|
1740
1738
|
};
|
|
1741
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1742
|
-
}) => void;
|
|
1743
|
-
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
1744
|
-
type: "requestExample";
|
|
1745
|
-
uid: string;
|
|
1746
|
-
name: string;
|
|
1747
1739
|
body: {
|
|
1748
|
-
activeBody: "
|
|
1740
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1741
|
+
binary?: Blob | undefined;
|
|
1749
1742
|
formData?: {
|
|
1750
1743
|
value: {
|
|
1751
1744
|
value: string;
|
|
@@ -1764,13 +1757,18 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1764
1757
|
}[];
|
|
1765
1758
|
encoding: "form-data" | "urlencoded";
|
|
1766
1759
|
} | undefined;
|
|
1767
|
-
binary?: Blob | undefined;
|
|
1768
1760
|
raw?: {
|
|
1769
1761
|
value: string;
|
|
1770
1762
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1771
1763
|
} | undefined;
|
|
1772
1764
|
};
|
|
1773
1765
|
requestUid: string;
|
|
1766
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1767
|
+
}) => void;
|
|
1768
|
+
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
1769
|
+
type: "requestExample";
|
|
1770
|
+
uid: string;
|
|
1771
|
+
name: string;
|
|
1774
1772
|
parameters: {
|
|
1775
1773
|
path: {
|
|
1776
1774
|
value: string;
|
|
@@ -1833,15 +1831,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1833
1831
|
nullable?: boolean | undefined;
|
|
1834
1832
|
}[];
|
|
1835
1833
|
};
|
|
1836
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1837
|
-
};
|
|
1838
|
-
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
1839
|
-
set: (item: {
|
|
1840
|
-
type: "requestExample";
|
|
1841
|
-
uid: string;
|
|
1842
|
-
name: string;
|
|
1843
1834
|
body: {
|
|
1844
|
-
activeBody: "
|
|
1835
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1836
|
+
binary?: Blob | undefined;
|
|
1845
1837
|
formData?: {
|
|
1846
1838
|
value: {
|
|
1847
1839
|
value: string;
|
|
@@ -1860,13 +1852,19 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1860
1852
|
}[];
|
|
1861
1853
|
encoding: "form-data" | "urlencoded";
|
|
1862
1854
|
} | undefined;
|
|
1863
|
-
binary?: Blob | undefined;
|
|
1864
1855
|
raw?: {
|
|
1865
1856
|
value: string;
|
|
1866
1857
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1867
1858
|
} | undefined;
|
|
1868
1859
|
};
|
|
1869
1860
|
requestUid: string;
|
|
1861
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1862
|
+
};
|
|
1863
|
+
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
1864
|
+
set: (item: {
|
|
1865
|
+
type: "requestExample";
|
|
1866
|
+
uid: string;
|
|
1867
|
+
name: string;
|
|
1870
1868
|
parameters: {
|
|
1871
1869
|
path: {
|
|
1872
1870
|
value: string;
|
|
@@ -1929,14 +1927,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1929
1927
|
nullable?: boolean | undefined;
|
|
1930
1928
|
}[];
|
|
1931
1929
|
};
|
|
1932
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1933
|
-
}) => void;
|
|
1934
|
-
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" ? {
|
|
1935
|
-
type: "requestExample";
|
|
1936
|
-
uid: string;
|
|
1937
|
-
name: string;
|
|
1938
1930
|
body: {
|
|
1939
|
-
activeBody: "
|
|
1931
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1932
|
+
binary?: Blob | undefined;
|
|
1940
1933
|
formData?: {
|
|
1941
1934
|
value: {
|
|
1942
1935
|
value: string;
|
|
@@ -1955,13 +1948,18 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
1955
1948
|
}[];
|
|
1956
1949
|
encoding: "form-data" | "urlencoded";
|
|
1957
1950
|
} | undefined;
|
|
1958
|
-
binary?: Blob | undefined;
|
|
1959
1951
|
raw?: {
|
|
1960
1952
|
value: string;
|
|
1961
1953
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1962
1954
|
} | undefined;
|
|
1963
1955
|
};
|
|
1964
1956
|
requestUid: string;
|
|
1957
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1958
|
+
}) => void;
|
|
1959
|
+
edit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
|
|
1960
|
+
type: "requestExample";
|
|
1961
|
+
uid: string;
|
|
1962
|
+
name: string;
|
|
1965
1963
|
parameters: {
|
|
1966
1964
|
path: {
|
|
1967
1965
|
value: string;
|
|
@@ -2024,13 +2022,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2024
2022
|
nullable?: boolean | undefined;
|
|
2025
2023
|
}[];
|
|
2026
2024
|
};
|
|
2027
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2028
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2029
|
-
type: "requestExample";
|
|
2030
|
-
uid: string;
|
|
2031
|
-
name: string;
|
|
2032
2025
|
body: {
|
|
2033
|
-
activeBody: "
|
|
2026
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2027
|
+
binary?: Blob | undefined;
|
|
2034
2028
|
formData?: {
|
|
2035
2029
|
value: {
|
|
2036
2030
|
value: string;
|
|
@@ -2049,13 +2043,17 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2049
2043
|
}[];
|
|
2050
2044
|
encoding: "form-data" | "urlencoded";
|
|
2051
2045
|
} | undefined;
|
|
2052
|
-
binary?: Blob | undefined;
|
|
2053
2046
|
raw?: {
|
|
2054
2047
|
value: string;
|
|
2055
2048
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2056
2049
|
} | undefined;
|
|
2057
2050
|
};
|
|
2058
2051
|
requestUid: string;
|
|
2052
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2053
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2054
|
+
type: "requestExample";
|
|
2055
|
+
uid: string;
|
|
2056
|
+
name: string;
|
|
2059
2057
|
parameters: {
|
|
2060
2058
|
path: {
|
|
2061
2059
|
value: string;
|
|
@@ -2118,13 +2116,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2118
2116
|
nullable?: boolean | undefined;
|
|
2119
2117
|
}[];
|
|
2120
2118
|
};
|
|
2121
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2122
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2123
|
-
type: "requestExample";
|
|
2124
|
-
uid: string;
|
|
2125
|
-
name: string;
|
|
2126
2119
|
body: {
|
|
2127
|
-
activeBody: "
|
|
2120
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2121
|
+
binary?: Blob | undefined;
|
|
2128
2122
|
formData?: {
|
|
2129
2123
|
value: {
|
|
2130
2124
|
value: string;
|
|
@@ -2143,13 +2137,17 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2143
2137
|
}[];
|
|
2144
2138
|
encoding: "form-data" | "urlencoded";
|
|
2145
2139
|
} | undefined;
|
|
2146
|
-
binary?: Blob | undefined;
|
|
2147
2140
|
raw?: {
|
|
2148
2141
|
value: string;
|
|
2149
2142
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2150
2143
|
} | undefined;
|
|
2151
2144
|
};
|
|
2152
2145
|
requestUid: string;
|
|
2146
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2147
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2148
|
+
type: "requestExample";
|
|
2149
|
+
uid: string;
|
|
2150
|
+
name: string;
|
|
2153
2151
|
parameters: {
|
|
2154
2152
|
path: {
|
|
2155
2153
|
value: string;
|
|
@@ -2212,14 +2210,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2212
2210
|
nullable?: boolean | undefined;
|
|
2213
2211
|
}[];
|
|
2214
2212
|
};
|
|
2215
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2216
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2217
|
-
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" ? {
|
|
2218
|
-
type: "requestExample";
|
|
2219
|
-
uid: string;
|
|
2220
|
-
name: string;
|
|
2221
2213
|
body: {
|
|
2222
|
-
activeBody: "
|
|
2214
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2215
|
+
binary?: Blob | undefined;
|
|
2223
2216
|
formData?: {
|
|
2224
2217
|
value: {
|
|
2225
2218
|
value: string;
|
|
@@ -2238,13 +2231,18 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2238
2231
|
}[];
|
|
2239
2232
|
encoding: "form-data" | "urlencoded";
|
|
2240
2233
|
} | undefined;
|
|
2241
|
-
binary?: Blob | undefined;
|
|
2242
2234
|
raw?: {
|
|
2243
2235
|
value: string;
|
|
2244
2236
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2245
2237
|
} | undefined;
|
|
2246
2238
|
};
|
|
2247
2239
|
requestUid: string;
|
|
2240
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2241
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2242
|
+
untrackedEdit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
|
|
2243
|
+
type: "requestExample";
|
|
2244
|
+
uid: string;
|
|
2245
|
+
name: string;
|
|
2248
2246
|
parameters: {
|
|
2249
2247
|
path: {
|
|
2250
2248
|
value: string;
|
|
@@ -2307,13 +2305,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2307
2305
|
nullable?: boolean | undefined;
|
|
2308
2306
|
}[];
|
|
2309
2307
|
};
|
|
2310
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2311
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2312
|
-
type: "requestExample";
|
|
2313
|
-
uid: string;
|
|
2314
|
-
name: string;
|
|
2315
2308
|
body: {
|
|
2316
|
-
activeBody: "
|
|
2309
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2310
|
+
binary?: Blob | undefined;
|
|
2317
2311
|
formData?: {
|
|
2318
2312
|
value: {
|
|
2319
2313
|
value: string;
|
|
@@ -2332,13 +2326,17 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2332
2326
|
}[];
|
|
2333
2327
|
encoding: "form-data" | "urlencoded";
|
|
2334
2328
|
} | undefined;
|
|
2335
|
-
binary?: Blob | undefined;
|
|
2336
2329
|
raw?: {
|
|
2337
2330
|
value: string;
|
|
2338
2331
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2339
2332
|
} | undefined;
|
|
2340
2333
|
};
|
|
2341
2334
|
requestUid: string;
|
|
2335
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2336
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2337
|
+
type: "requestExample";
|
|
2338
|
+
uid: string;
|
|
2339
|
+
name: string;
|
|
2342
2340
|
parameters: {
|
|
2343
2341
|
path: {
|
|
2344
2342
|
value: string;
|
|
@@ -2401,13 +2399,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2401
2399
|
nullable?: boolean | undefined;
|
|
2402
2400
|
}[];
|
|
2403
2401
|
};
|
|
2404
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2405
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2406
|
-
type: "requestExample";
|
|
2407
|
-
uid: string;
|
|
2408
|
-
name: string;
|
|
2409
2402
|
body: {
|
|
2410
|
-
activeBody: "
|
|
2403
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2404
|
+
binary?: Blob | undefined;
|
|
2411
2405
|
formData?: {
|
|
2412
2406
|
value: {
|
|
2413
2407
|
value: string;
|
|
@@ -2426,13 +2420,17 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2426
2420
|
}[];
|
|
2427
2421
|
encoding: "form-data" | "urlencoded";
|
|
2428
2422
|
} | undefined;
|
|
2429
|
-
binary?: Blob | undefined;
|
|
2430
2423
|
raw?: {
|
|
2431
2424
|
value: string;
|
|
2432
2425
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2433
2426
|
} | undefined;
|
|
2434
2427
|
};
|
|
2435
2428
|
requestUid: string;
|
|
2429
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2430
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2431
|
+
type: "requestExample";
|
|
2432
|
+
uid: string;
|
|
2433
|
+
name: string;
|
|
2436
2434
|
parameters: {
|
|
2437
2435
|
path: {
|
|
2438
2436
|
value: string;
|
|
@@ -2495,6 +2493,33 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
2495
2493
|
nullable?: boolean | undefined;
|
|
2496
2494
|
}[];
|
|
2497
2495
|
};
|
|
2496
|
+
body: {
|
|
2497
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2498
|
+
binary?: Blob | undefined;
|
|
2499
|
+
formData?: {
|
|
2500
|
+
value: {
|
|
2501
|
+
value: string;
|
|
2502
|
+
key: string;
|
|
2503
|
+
enabled: boolean;
|
|
2504
|
+
minimum?: number | undefined;
|
|
2505
|
+
type?: string | undefined;
|
|
2506
|
+
maximum?: number | undefined;
|
|
2507
|
+
default?: any;
|
|
2508
|
+
required?: boolean | undefined;
|
|
2509
|
+
description?: string | undefined;
|
|
2510
|
+
enum?: string[] | undefined;
|
|
2511
|
+
format?: string | undefined;
|
|
2512
|
+
file?: any;
|
|
2513
|
+
nullable?: boolean | undefined;
|
|
2514
|
+
}[];
|
|
2515
|
+
encoding: "form-data" | "urlencoded";
|
|
2516
|
+
} | undefined;
|
|
2517
|
+
raw?: {
|
|
2518
|
+
value: string;
|
|
2519
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2520
|
+
} | undefined;
|
|
2521
|
+
};
|
|
2522
|
+
requestUid: string;
|
|
2498
2523
|
serverVariables?: Record<string, string[]> | undefined;
|
|
2499
2524
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2500
2525
|
undo: (uid: string) => void;
|
|
@@ -3285,6 +3310,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
3285
3310
|
'x-scalar-children'?: {
|
|
3286
3311
|
tagName: string;
|
|
3287
3312
|
}[] | undefined;
|
|
3313
|
+
'x-internal'?: boolean | undefined;
|
|
3314
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3288
3315
|
}) => void;
|
|
3289
3316
|
add: (payload: import("@scalar/oas-utils/entities/spec").TagPayload, collectionUid: string) => void | {
|
|
3290
3317
|
type: "tag";
|
|
@@ -3299,6 +3326,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
3299
3326
|
'x-scalar-children'?: {
|
|
3300
3327
|
tagName: string;
|
|
3301
3328
|
}[] | undefined;
|
|
3329
|
+
'x-internal'?: boolean | undefined;
|
|
3330
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3302
3331
|
};
|
|
3303
3332
|
delete: (tag: import("@scalar/oas-utils/entities/spec").Tag, collectionUid: string) => void;
|
|
3304
3333
|
set: (item: {
|
|
@@ -3314,8 +3343,10 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
3314
3343
|
'x-scalar-children'?: {
|
|
3315
3344
|
tagName: string;
|
|
3316
3345
|
}[] | undefined;
|
|
3346
|
+
'x-internal'?: boolean | undefined;
|
|
3347
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3317
3348
|
}) => void;
|
|
3318
|
-
edit: <P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
|
|
3349
|
+
edit: <P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
|
|
3319
3350
|
type: "tag";
|
|
3320
3351
|
uid: string;
|
|
3321
3352
|
name: string;
|
|
@@ -3328,7 +3359,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
3328
3359
|
'x-scalar-children'?: {
|
|
3329
3360
|
tagName: string;
|
|
3330
3361
|
}[] | undefined;
|
|
3331
|
-
|
|
3362
|
+
'x-internal'?: boolean | undefined;
|
|
3363
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3364
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
3332
3365
|
type: "tag";
|
|
3333
3366
|
uid: string;
|
|
3334
3367
|
name: string;
|
|
@@ -3341,6 +3374,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
3341
3374
|
'x-scalar-children'?: {
|
|
3342
3375
|
tagName: string;
|
|
3343
3376
|
}[] | undefined;
|
|
3377
|
+
'x-internal'?: boolean | undefined;
|
|
3378
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3344
3379
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
3345
3380
|
type: "tag";
|
|
3346
3381
|
uid: string;
|
|
@@ -3354,8 +3389,10 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
3354
3389
|
'x-scalar-children'?: {
|
|
3355
3390
|
tagName: string;
|
|
3356
3391
|
}[] | undefined;
|
|
3392
|
+
'x-internal'?: boolean | undefined;
|
|
3393
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3357
3394
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3358
|
-
untrackedEdit: <P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
|
|
3395
|
+
untrackedEdit: <P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
|
|
3359
3396
|
type: "tag";
|
|
3360
3397
|
uid: string;
|
|
3361
3398
|
name: string;
|
|
@@ -3368,7 +3405,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
3368
3405
|
'x-scalar-children'?: {
|
|
3369
3406
|
tagName: string;
|
|
3370
3407
|
}[] | undefined;
|
|
3371
|
-
|
|
3408
|
+
'x-internal'?: boolean | undefined;
|
|
3409
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3410
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
3372
3411
|
type: "tag";
|
|
3373
3412
|
uid: string;
|
|
3374
3413
|
name: string;
|
|
@@ -3381,6 +3420,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
3381
3420
|
'x-scalar-children'?: {
|
|
3382
3421
|
tagName: string;
|
|
3383
3422
|
}[] | undefined;
|
|
3423
|
+
'x-internal'?: boolean | undefined;
|
|
3424
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3384
3425
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
3385
3426
|
type: "tag";
|
|
3386
3427
|
uid: string;
|
|
@@ -3394,6 +3435,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
|
|
|
3394
3435
|
'x-scalar-children'?: {
|
|
3395
3436
|
tagName: string;
|
|
3396
3437
|
}[] | undefined;
|
|
3438
|
+
'x-internal'?: boolean | undefined;
|
|
3439
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3397
3440
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3398
3441
|
undo: (uid: string) => void;
|
|
3399
3442
|
redo: (uid: string) => void;
|