@scalar/api-client 2.2.31 → 2.2.33

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/CHANGELOG.md +36 -0
  2. package/dist/components/CommandPalette/CommandPaletteServer.vue.d.ts +9 -3
  3. package/dist/components/CommandPalette/CommandPaletteServer.vue.d.ts.map +1 -1
  4. package/dist/components/CommandPalette/CommandPaletteServer.vue.js +62 -54
  5. package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts +13 -3
  6. package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts.map +1 -1
  7. package/dist/components/DataTable/DataTable.vue.js +7 -7
  8. package/dist/components/DataTable/DataTableCell.vue.js +6 -6
  9. package/dist/components/Form/Form.vue.d.ts.map +1 -1
  10. package/dist/components/Form/Form.vue.js +5 -5
  11. package/dist/components/ImportCollection/ImportCollectionModal.vue.d.ts.map +1 -1
  12. package/dist/components/ImportCollection/ImportCollectionModal.vue.js +72 -71
  13. package/dist/components/ImportCollection/WorkspaceSelector.vue.d.ts.map +1 -1
  14. package/dist/components/ImportCollection/WorkspaceSelector.vue.js +23 -22
  15. package/dist/components/Search/useSearch.d.ts.map +1 -1
  16. package/dist/components/Search/useSearch.js +61 -48
  17. package/dist/components/SideNav/SideNavLink.vue.js +2 -2
  18. package/dist/components/Sidebar/Sidebar.vue.js +2 -2
  19. package/dist/components/Sidebar/Sidebar.vue2.js +5 -5
  20. package/dist/components/Sidebar/SidebarList.vue.js +1 -1
  21. package/dist/components/Sidebar/SidebarListElement.vue.d.ts +1 -1
  22. package/dist/components/Sidebar/SidebarListElement.vue.d.ts.map +1 -1
  23. package/dist/components/Sidebar/SidebarListElement.vue.js +2 -2
  24. package/dist/components/Sidebar/SidebarListElement.vue2.js +12 -12
  25. package/dist/components/ViewLayout/ViewLayoutCollapse.vue.d.ts.map +1 -1
  26. package/dist/components/ViewLayout/ViewLayoutCollapse.vue.js +1 -1
  27. package/dist/components/ViewLayout/ViewLayoutSection.vue.d.ts.map +1 -1
  28. package/dist/components/ViewLayout/ViewLayoutSection.vue.js +1 -1
  29. package/dist/constants.d.ts +4 -0
  30. package/dist/constants.d.ts.map +1 -1
  31. package/dist/constants.js +2 -2
  32. package/dist/layouts/App/create-api-client-app.d.ts +168 -127
  33. package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
  34. package/dist/layouts/Modal/create-api-client-modal.d.ts +336 -254
  35. package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
  36. package/dist/layouts/Web/create-api-client-web.d.ts +168 -127
  37. package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
  38. package/dist/libs/create-client.d.ts +169 -128
  39. package/dist/libs/create-client.d.ts.map +1 -1
  40. package/dist/libs/create-client.js +8 -7
  41. package/dist/libs/find-request.d.ts +2 -0
  42. package/dist/libs/find-request.d.ts.map +1 -1
  43. package/dist/libs/send-request/send-request.d.ts.map +1 -1
  44. package/dist/libs/send-request/send-request.js +114 -116
  45. package/dist/routes.d.ts +1 -0
  46. package/dist/routes.d.ts.map +1 -1
  47. package/dist/routes.js +12 -7
  48. package/dist/store/active-entities.d.ts +29 -27
  49. package/dist/store/active-entities.d.ts.map +1 -1
  50. package/dist/store/collections.d.ts +4 -4
  51. package/dist/store/request-example.d.ts +134 -134
  52. package/dist/store/request-example.d.ts.map +1 -1
  53. package/dist/store/requests.d.ts +26 -4
  54. package/dist/store/requests.d.ts.map +1 -1
  55. package/dist/store/store.d.ts +171 -128
  56. package/dist/store/store.d.ts.map +1 -1
  57. package/dist/store/store.js +48 -46
  58. package/dist/store/tags.d.ts +24 -4
  59. package/dist/store/tags.d.ts.map +1 -1
  60. package/dist/style.css +1 -1
  61. package/dist/views/Cookies/CookieForm.vue.d.ts.map +1 -1
  62. package/dist/views/Cookies/CookieForm.vue.js +12 -12
  63. package/dist/views/Cookies/Cookies.vue2.js +12 -12
  64. package/dist/views/Environment/Environment.vue.d.ts.map +1 -1
  65. package/dist/views/Environment/Environment.vue2.js +98 -97
  66. package/dist/views/Environment/EnvironmentModal.vue.js +1 -1
  67. package/dist/views/Environment/EnvironmentVariableDropdown.vue.js +6 -6
  68. package/dist/views/Request/RequestSidebar.vue.d.ts.map +1 -1
  69. package/dist/views/Request/RequestSidebar.vue.js +3 -3
  70. package/dist/views/Request/RequestSidebar.vue2.js +14 -14
  71. package/dist/views/Request/RequestSidebarItem.vue.d.ts +2 -2
  72. package/dist/views/Request/RequestSidebarItem.vue.d.ts.map +1 -1
  73. package/dist/views/Request/RequestSidebarItem.vue.js +2 -2
  74. package/dist/views/Request/RequestSidebarItem.vue2.js +132 -125
  75. package/dist/views/Request/RequestSubpageHeader.vue.d.ts.map +1 -1
  76. package/dist/views/Request/RequestSubpageHeader.vue.js +1 -1
  77. package/dist/views/Request/RequestSubpageHeader.vue2.js +21 -21
  78. package/dist/views/Request/ResponseSection/ResponseEmpty.vue.d.ts.map +1 -1
  79. package/dist/views/Request/ResponseSection/ResponseEmpty.vue.js +1 -1
  80. package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +12 -12
  81. package/dist/views/Servers/ServerForm.vue.d.ts +8 -1
  82. package/dist/views/Servers/ServerForm.vue.d.ts.map +1 -1
  83. package/dist/views/Servers/ServerForm.vue.js +28 -59
  84. package/dist/views/Servers/Servers.vue.d.ts.map +1 -1
  85. package/dist/views/Servers/Servers.vue2.js +141 -53
  86. package/package.json +12 -12
@@ -10,7 +10,7 @@ import type { Router } from 'vue-router';
10
10
  export type ClientConfiguration = {
11
11
  proxyUrl?: ReferenceConfiguration['proxyUrl'];
12
12
  themeId?: ReferenceConfiguration['theme'];
13
- } & Pick<ReferenceConfiguration, 'spec' | 'showSidebar' | 'servers' | 'searchHotKey' | 'authentication' | 'baseServerURL' | 'hideClientButton'>;
13
+ } & Pick<ReferenceConfiguration, 'spec' | 'showSidebar' | 'servers' | 'searchHotKey' | 'authentication' | 'baseServerURL' | 'hideClientButton' | '_integration'>;
14
14
  export type OpenClientPayload = {
15
15
  path: string;
16
16
  method: LiteralUnion<RequestMethod | Lowercase<RequestMethod>, string>;
@@ -185,6 +185,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
185
185
  'x-scalar-children'?: {
186
186
  tagName: string;
187
187
  }[] | undefined;
188
+ 'x-internal'?: boolean | undefined;
189
+ 'x-scalar-ignore'?: boolean | undefined;
188
190
  }>;
189
191
  cookies: Record<string, {
190
192
  value: string;
@@ -210,33 +212,6 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
210
212
  type: "requestExample";
211
213
  uid: string;
212
214
  name: string;
213
- body: {
214
- activeBody: "formData" | "binary" | "raw";
215
- formData?: {
216
- value: {
217
- value: string;
218
- key: string;
219
- enabled: boolean;
220
- minimum?: number | undefined;
221
- type?: string | undefined;
222
- maximum?: number | undefined;
223
- default?: any;
224
- required?: boolean | undefined;
225
- description?: string | undefined;
226
- enum?: string[] | undefined;
227
- format?: string | undefined;
228
- file?: any;
229
- nullable?: boolean | undefined;
230
- }[];
231
- encoding: "form-data" | "urlencoded";
232
- } | undefined;
233
- binary?: Blob | undefined;
234
- raw?: {
235
- value: string;
236
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
237
- } | undefined;
238
- };
239
- requestUid: string;
240
215
  parameters: {
241
216
  path: {
242
217
  value: string;
@@ -299,6 +274,33 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
299
274
  nullable?: boolean | undefined;
300
275
  }[];
301
276
  };
277
+ body: {
278
+ activeBody: "binary" | "formData" | "raw";
279
+ binary?: Blob | undefined;
280
+ formData?: {
281
+ value: {
282
+ value: string;
283
+ key: string;
284
+ enabled: boolean;
285
+ minimum?: number | undefined;
286
+ type?: string | undefined;
287
+ maximum?: number | undefined;
288
+ default?: any;
289
+ required?: boolean | undefined;
290
+ description?: string | undefined;
291
+ enum?: string[] | undefined;
292
+ format?: string | undefined;
293
+ file?: any;
294
+ nullable?: boolean | undefined;
295
+ }[];
296
+ encoding: "form-data" | "urlencoded";
297
+ } | undefined;
298
+ raw?: {
299
+ value: string;
300
+ encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
301
+ } | undefined;
302
+ };
303
+ requestUid: string;
302
304
  serverVariables?: Record<string, string[]> | undefined;
303
305
  }>;
304
306
  requests: Record<string, {
@@ -316,6 +318,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
316
318
  url: string;
317
319
  description?: string | undefined;
318
320
  } | undefined;
321
+ 'x-internal'?: boolean | undefined;
322
+ 'x-scalar-ignore'?: boolean | undefined;
319
323
  security?: Record<string, string[]>[] | undefined;
320
324
  tags?: string[] | undefined;
321
325
  deprecated?: boolean | undefined;
@@ -441,6 +445,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
441
445
  isReadOnly: boolean;
442
446
  hideClientButton: boolean | undefined;
443
447
  showSidebar: boolean;
448
+ integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
444
449
  importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
445
450
  type?: "collection" | undefined;
446
451
  uid?: string | undefined;
@@ -997,7 +1002,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
997
1002
  documentUrl?: string | undefined;
998
1003
  integration?: string | null | undefined;
999
1004
  }) => void;
1000
- edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `servers.${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 "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? {
1005
+ 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" ? {
1001
1006
  type: "collection";
1002
1007
  uid: string;
1003
1008
  children: string[];
@@ -1051,7 +1056,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1051
1056
  }> | undefined;
1052
1057
  documentUrl?: string | undefined;
1053
1058
  integration?: string | null | undefined;
1054
- }[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" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends Path<{
1059
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends Path<{
1055
1060
  type: "collection";
1056
1061
  uid: string;
1057
1062
  children: string[];
@@ -1160,7 +1165,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1160
1165
  documentUrl?: string | undefined;
1161
1166
  integration?: string | null | undefined;
1162
1167
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1163
- untrackedEdit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `servers.${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 "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? {
1168
+ 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" ? {
1164
1169
  type: "collection";
1165
1170
  uid: string;
1166
1171
  children: string[];
@@ -1214,7 +1219,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1214
1219
  }> | undefined;
1215
1220
  documentUrl?: string | undefined;
1216
1221
  integration?: string | null | undefined;
1217
- }[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" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends Path<{
1222
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends Path<{
1218
1223
  type: "collection";
1219
1224
  uid: string;
1220
1225
  children: string[];
@@ -1401,6 +1406,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1401
1406
  url: string;
1402
1407
  description?: string | undefined;
1403
1408
  } | undefined;
1409
+ 'x-internal'?: boolean | undefined;
1410
+ 'x-scalar-ignore'?: boolean | undefined;
1404
1411
  security?: Record<string, string[]>[] | undefined;
1405
1412
  tags?: string[] | undefined;
1406
1413
  deprecated?: boolean | undefined;
@@ -1438,6 +1445,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1438
1445
  url: string;
1439
1446
  description?: string | undefined;
1440
1447
  } | undefined;
1448
+ 'x-internal'?: boolean | undefined;
1449
+ 'x-scalar-ignore'?: boolean | undefined;
1441
1450
  security?: Record<string, string[]>[] | undefined;
1442
1451
  tags?: string[] | undefined;
1443
1452
  deprecated?: boolean | undefined;
@@ -1476,6 +1485,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1476
1485
  url: string;
1477
1486
  description?: string | undefined;
1478
1487
  } | undefined;
1488
+ 'x-internal'?: boolean | undefined;
1489
+ 'x-scalar-ignore'?: boolean | undefined;
1479
1490
  security?: Record<string, string[]>[] | undefined;
1480
1491
  tags?: string[] | undefined;
1481
1492
  deprecated?: boolean | undefined;
@@ -1498,7 +1509,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1498
1509
  requestBody?: any;
1499
1510
  responses?: Record<string, any> | undefined;
1500
1511
  }) => void;
1501
- edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `servers.${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 "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "method" | "path" | "examples" ? {
1512
+ 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" ? {
1502
1513
  path: string;
1503
1514
  type: "request";
1504
1515
  uid: string;
@@ -1513,6 +1524,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1513
1524
  url: string;
1514
1525
  description?: string | undefined;
1515
1526
  } | undefined;
1527
+ 'x-internal'?: boolean | undefined;
1528
+ 'x-scalar-ignore'?: boolean | undefined;
1516
1529
  security?: Record<string, string[]>[] | undefined;
1517
1530
  tags?: string[] | undefined;
1518
1531
  deprecated?: boolean | undefined;
@@ -1534,7 +1547,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1534
1547
  }[] | undefined;
1535
1548
  requestBody?: any;
1536
1549
  responses?: Record<string, any> | undefined;
1537
- }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "method" | "path" | "examples" ? R extends Path<{
1550
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? R extends Path<{
1538
1551
  path: string;
1539
1552
  type: "request";
1540
1553
  uid: string;
@@ -1549,6 +1562,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1549
1562
  url: string;
1550
1563
  description?: string | undefined;
1551
1564
  } | undefined;
1565
+ 'x-internal'?: boolean | undefined;
1566
+ 'x-scalar-ignore'?: boolean | undefined;
1552
1567
  security?: Record<string, string[]>[] | undefined;
1553
1568
  tags?: string[] | undefined;
1554
1569
  deprecated?: boolean | undefined;
@@ -1585,6 +1600,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1585
1600
  url: string;
1586
1601
  description?: string | undefined;
1587
1602
  } | undefined;
1603
+ 'x-internal'?: boolean | undefined;
1604
+ 'x-scalar-ignore'?: boolean | undefined;
1588
1605
  security?: Record<string, string[]>[] | undefined;
1589
1606
  tags?: string[] | undefined;
1590
1607
  deprecated?: boolean | undefined;
@@ -1607,7 +1624,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1607
1624
  requestBody?: any;
1608
1625
  responses?: Record<string, any> | undefined;
1609
1626
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1610
- untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `servers.${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 "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "method" | "path" | "examples" ? {
1627
+ 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" ? {
1611
1628
  path: string;
1612
1629
  type: "request";
1613
1630
  uid: string;
@@ -1622,6 +1639,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1622
1639
  url: string;
1623
1640
  description?: string | undefined;
1624
1641
  } | undefined;
1642
+ 'x-internal'?: boolean | undefined;
1643
+ 'x-scalar-ignore'?: boolean | undefined;
1625
1644
  security?: Record<string, string[]>[] | undefined;
1626
1645
  tags?: string[] | undefined;
1627
1646
  deprecated?: boolean | undefined;
@@ -1643,7 +1662,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1643
1662
  }[] | undefined;
1644
1663
  requestBody?: any;
1645
1664
  responses?: Record<string, any> | undefined;
1646
- }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "method" | "path" | "examples" ? R extends Path<{
1665
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? R extends Path<{
1647
1666
  path: string;
1648
1667
  type: "request";
1649
1668
  uid: string;
@@ -1658,6 +1677,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1658
1677
  url: string;
1659
1678
  description?: string | undefined;
1660
1679
  } | undefined;
1680
+ 'x-internal'?: boolean | undefined;
1681
+ 'x-scalar-ignore'?: boolean | undefined;
1661
1682
  security?: Record<string, string[]>[] | undefined;
1662
1683
  tags?: string[] | undefined;
1663
1684
  deprecated?: boolean | undefined;
@@ -1694,6 +1715,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1694
1715
  url: string;
1695
1716
  description?: string | undefined;
1696
1717
  } | undefined;
1718
+ 'x-internal'?: boolean | undefined;
1719
+ 'x-scalar-ignore'?: boolean | undefined;
1697
1720
  security?: Record<string, string[]>[] | undefined;
1698
1721
  tags?: string[] | undefined;
1699
1722
  deprecated?: boolean | undefined;
@@ -1726,33 +1749,6 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1726
1749
  type: "requestExample";
1727
1750
  uid: string;
1728
1751
  name: string;
1729
- body: {
1730
- activeBody: "formData" | "binary" | "raw";
1731
- formData?: {
1732
- value: {
1733
- value: string;
1734
- key: string;
1735
- enabled: boolean;
1736
- minimum?: number | undefined;
1737
- type?: string | undefined;
1738
- maximum?: number | undefined;
1739
- default?: any;
1740
- required?: boolean | undefined;
1741
- description?: string | undefined;
1742
- enum?: string[] | undefined;
1743
- format?: string | undefined;
1744
- file?: any;
1745
- nullable?: boolean | undefined;
1746
- }[];
1747
- encoding: "form-data" | "urlencoded";
1748
- } | undefined;
1749
- binary?: Blob | undefined;
1750
- raw?: {
1751
- value: string;
1752
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
1753
- } | undefined;
1754
- };
1755
- requestUid: string;
1756
1752
  parameters: {
1757
1753
  path: {
1758
1754
  value: string;
@@ -1815,14 +1811,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1815
1811
  nullable?: boolean | undefined;
1816
1812
  }[];
1817
1813
  };
1818
- serverVariables?: Record<string, string[]> | undefined;
1819
- }) => void;
1820
- add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
1821
- type: "requestExample";
1822
- uid: string;
1823
- name: string;
1824
1814
  body: {
1825
- activeBody: "formData" | "binary" | "raw";
1815
+ activeBody: "binary" | "formData" | "raw";
1816
+ binary?: Blob | undefined;
1826
1817
  formData?: {
1827
1818
  value: {
1828
1819
  value: string;
@@ -1841,13 +1832,18 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1841
1832
  }[];
1842
1833
  encoding: "form-data" | "urlencoded";
1843
1834
  } | undefined;
1844
- binary?: Blob | undefined;
1845
1835
  raw?: {
1846
1836
  value: string;
1847
1837
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
1848
1838
  } | undefined;
1849
1839
  };
1850
1840
  requestUid: string;
1841
+ serverVariables?: Record<string, string[]> | undefined;
1842
+ }) => void;
1843
+ add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
1844
+ type: "requestExample";
1845
+ uid: string;
1846
+ name: string;
1851
1847
  parameters: {
1852
1848
  path: {
1853
1849
  value: string;
@@ -1910,15 +1906,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1910
1906
  nullable?: boolean | undefined;
1911
1907
  }[];
1912
1908
  };
1913
- serverVariables?: Record<string, string[]> | undefined;
1914
- };
1915
- delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
1916
- set: (item: {
1917
- type: "requestExample";
1918
- uid: string;
1919
- name: string;
1920
1909
  body: {
1921
- activeBody: "formData" | "binary" | "raw";
1910
+ activeBody: "binary" | "formData" | "raw";
1911
+ binary?: Blob | undefined;
1922
1912
  formData?: {
1923
1913
  value: {
1924
1914
  value: string;
@@ -1937,13 +1927,19 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1937
1927
  }[];
1938
1928
  encoding: "form-data" | "urlencoded";
1939
1929
  } | undefined;
1940
- binary?: Blob | undefined;
1941
1930
  raw?: {
1942
1931
  value: string;
1943
1932
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
1944
1933
  } | undefined;
1945
1934
  };
1946
1935
  requestUid: string;
1936
+ serverVariables?: Record<string, string[]> | undefined;
1937
+ };
1938
+ delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
1939
+ set: (item: {
1940
+ type: "requestExample";
1941
+ uid: string;
1942
+ name: string;
1947
1943
  parameters: {
1948
1944
  path: {
1949
1945
  value: string;
@@ -2006,14 +2002,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2006
2002
  nullable?: boolean | undefined;
2007
2003
  }[];
2008
2004
  };
2009
- serverVariables?: Record<string, string[]> | undefined;
2010
- }) => void;
2011
- 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" ? {
2012
- type: "requestExample";
2013
- uid: string;
2014
- name: string;
2015
2005
  body: {
2016
- activeBody: "formData" | "binary" | "raw";
2006
+ activeBody: "binary" | "formData" | "raw";
2007
+ binary?: Blob | undefined;
2017
2008
  formData?: {
2018
2009
  value: {
2019
2010
  value: string;
@@ -2032,13 +2023,18 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2032
2023
  }[];
2033
2024
  encoding: "form-data" | "urlencoded";
2034
2025
  } | undefined;
2035
- binary?: Blob | undefined;
2036
2026
  raw?: {
2037
2027
  value: string;
2038
2028
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2039
2029
  } | undefined;
2040
2030
  };
2041
2031
  requestUid: string;
2032
+ serverVariables?: Record<string, string[]> | undefined;
2033
+ }) => void;
2034
+ 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" ? {
2035
+ type: "requestExample";
2036
+ uid: string;
2037
+ name: string;
2042
2038
  parameters: {
2043
2039
  path: {
2044
2040
  value: string;
@@ -2101,13 +2097,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2101
2097
  nullable?: boolean | undefined;
2102
2098
  }[];
2103
2099
  };
2104
- serverVariables?: Record<string, string[]> | undefined;
2105
- }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path<{
2106
- type: "requestExample";
2107
- uid: string;
2108
- name: string;
2109
2100
  body: {
2110
- activeBody: "formData" | "binary" | "raw";
2101
+ activeBody: "binary" | "formData" | "raw";
2102
+ binary?: Blob | undefined;
2111
2103
  formData?: {
2112
2104
  value: {
2113
2105
  value: string;
@@ -2126,13 +2118,17 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2126
2118
  }[];
2127
2119
  encoding: "form-data" | "urlencoded";
2128
2120
  } | undefined;
2129
- binary?: Blob | undefined;
2130
2121
  raw?: {
2131
2122
  value: string;
2132
2123
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2133
2124
  } | undefined;
2134
2125
  };
2135
2126
  requestUid: string;
2127
+ serverVariables?: Record<string, string[]> | undefined;
2128
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path<{
2129
+ type: "requestExample";
2130
+ uid: string;
2131
+ name: string;
2136
2132
  parameters: {
2137
2133
  path: {
2138
2134
  value: string;
@@ -2195,13 +2191,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2195
2191
  nullable?: boolean | undefined;
2196
2192
  }[];
2197
2193
  };
2198
- serverVariables?: Record<string, string[]> | undefined;
2199
- }[K]> ? PathValue<{
2200
- type: "requestExample";
2201
- uid: string;
2202
- name: string;
2203
2194
  body: {
2204
- activeBody: "formData" | "binary" | "raw";
2195
+ activeBody: "binary" | "formData" | "raw";
2196
+ binary?: Blob | undefined;
2205
2197
  formData?: {
2206
2198
  value: {
2207
2199
  value: string;
@@ -2220,13 +2212,17 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2220
2212
  }[];
2221
2213
  encoding: "form-data" | "urlencoded";
2222
2214
  } | undefined;
2223
- binary?: Blob | undefined;
2224
2215
  raw?: {
2225
2216
  value: string;
2226
2217
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2227
2218
  } | undefined;
2228
2219
  };
2229
2220
  requestUid: string;
2221
+ serverVariables?: Record<string, string[]> | undefined;
2222
+ }[K]> ? PathValue<{
2223
+ type: "requestExample";
2224
+ uid: string;
2225
+ name: string;
2230
2226
  parameters: {
2231
2227
  path: {
2232
2228
  value: string;
@@ -2289,14 +2285,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2289
2285
  nullable?: boolean | undefined;
2290
2286
  }[];
2291
2287
  };
2292
- serverVariables?: Record<string, string[]> | undefined;
2293
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
2294
- 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" ? {
2295
- type: "requestExample";
2296
- uid: string;
2297
- name: string;
2298
2288
  body: {
2299
- activeBody: "formData" | "binary" | "raw";
2289
+ activeBody: "binary" | "formData" | "raw";
2290
+ binary?: Blob | undefined;
2300
2291
  formData?: {
2301
2292
  value: {
2302
2293
  value: string;
@@ -2315,13 +2306,18 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2315
2306
  }[];
2316
2307
  encoding: "form-data" | "urlencoded";
2317
2308
  } | undefined;
2318
- binary?: Blob | undefined;
2319
2309
  raw?: {
2320
2310
  value: string;
2321
2311
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2322
2312
  } | undefined;
2323
2313
  };
2324
2314
  requestUid: string;
2315
+ serverVariables?: Record<string, string[]> | undefined;
2316
+ }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
2317
+ 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" ? {
2318
+ type: "requestExample";
2319
+ uid: string;
2320
+ name: string;
2325
2321
  parameters: {
2326
2322
  path: {
2327
2323
  value: string;
@@ -2384,13 +2380,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2384
2380
  nullable?: boolean | undefined;
2385
2381
  }[];
2386
2382
  };
2387
- serverVariables?: Record<string, string[]> | undefined;
2388
- }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path<{
2389
- type: "requestExample";
2390
- uid: string;
2391
- name: string;
2392
2383
  body: {
2393
- activeBody: "formData" | "binary" | "raw";
2384
+ activeBody: "binary" | "formData" | "raw";
2385
+ binary?: Blob | undefined;
2394
2386
  formData?: {
2395
2387
  value: {
2396
2388
  value: string;
@@ -2409,13 +2401,17 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2409
2401
  }[];
2410
2402
  encoding: "form-data" | "urlencoded";
2411
2403
  } | undefined;
2412
- binary?: Blob | undefined;
2413
2404
  raw?: {
2414
2405
  value: string;
2415
2406
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2416
2407
  } | undefined;
2417
2408
  };
2418
2409
  requestUid: string;
2410
+ serverVariables?: Record<string, string[]> | undefined;
2411
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path<{
2412
+ type: "requestExample";
2413
+ uid: string;
2414
+ name: string;
2419
2415
  parameters: {
2420
2416
  path: {
2421
2417
  value: string;
@@ -2478,13 +2474,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2478
2474
  nullable?: boolean | undefined;
2479
2475
  }[];
2480
2476
  };
2481
- serverVariables?: Record<string, string[]> | undefined;
2482
- }[K]> ? PathValue<{
2483
- type: "requestExample";
2484
- uid: string;
2485
- name: string;
2486
2477
  body: {
2487
- activeBody: "formData" | "binary" | "raw";
2478
+ activeBody: "binary" | "formData" | "raw";
2479
+ binary?: Blob | undefined;
2488
2480
  formData?: {
2489
2481
  value: {
2490
2482
  value: string;
@@ -2503,13 +2495,17 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2503
2495
  }[];
2504
2496
  encoding: "form-data" | "urlencoded";
2505
2497
  } | undefined;
2506
- binary?: Blob | undefined;
2507
2498
  raw?: {
2508
2499
  value: string;
2509
2500
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2510
2501
  } | undefined;
2511
2502
  };
2512
2503
  requestUid: string;
2504
+ serverVariables?: Record<string, string[]> | undefined;
2505
+ }[K]> ? PathValue<{
2506
+ type: "requestExample";
2507
+ uid: string;
2508
+ name: string;
2513
2509
  parameters: {
2514
2510
  path: {
2515
2511
  value: string;
@@ -2572,6 +2568,33 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2572
2568
  nullable?: boolean | undefined;
2573
2569
  }[];
2574
2570
  };
2571
+ body: {
2572
+ activeBody: "binary" | "formData" | "raw";
2573
+ binary?: Blob | undefined;
2574
+ formData?: {
2575
+ value: {
2576
+ value: string;
2577
+ key: string;
2578
+ enabled: boolean;
2579
+ minimum?: number | undefined;
2580
+ type?: string | undefined;
2581
+ maximum?: number | undefined;
2582
+ default?: any;
2583
+ required?: boolean | undefined;
2584
+ description?: string | undefined;
2585
+ enum?: string[] | undefined;
2586
+ format?: string | undefined;
2587
+ file?: any;
2588
+ nullable?: boolean | undefined;
2589
+ }[];
2590
+ encoding: "form-data" | "urlencoded";
2591
+ } | undefined;
2592
+ raw?: {
2593
+ value: string;
2594
+ encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2595
+ } | undefined;
2596
+ };
2597
+ requestUid: string;
2575
2598
  serverVariables?: Record<string, string[]> | undefined;
2576
2599
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
2577
2600
  undo: (uid: string) => void;
@@ -3362,6 +3385,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3362
3385
  'x-scalar-children'?: {
3363
3386
  tagName: string;
3364
3387
  }[] | undefined;
3388
+ 'x-internal'?: boolean | undefined;
3389
+ 'x-scalar-ignore'?: boolean | undefined;
3365
3390
  }) => void;
3366
3391
  add: (payload: import("@scalar/oas-utils/entities/spec").TagPayload, collectionUid: string) => void | {
3367
3392
  type: "tag";
@@ -3376,6 +3401,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3376
3401
  'x-scalar-children'?: {
3377
3402
  tagName: string;
3378
3403
  }[] | undefined;
3404
+ 'x-internal'?: boolean | undefined;
3405
+ 'x-scalar-ignore'?: boolean | undefined;
3379
3406
  };
3380
3407
  delete: (tag: import("@scalar/oas-utils/entities/spec").Tag, collectionUid: string) => void;
3381
3408
  set: (item: {
@@ -3391,8 +3418,10 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3391
3418
  'x-scalar-children'?: {
3392
3419
  tagName: string;
3393
3420
  }[] | undefined;
3421
+ 'x-internal'?: boolean | undefined;
3422
+ 'x-scalar-ignore'?: boolean | undefined;
3394
3423
  }) => void;
3395
- 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" ? {
3424
+ 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" ? {
3396
3425
  type: "tag";
3397
3426
  uid: string;
3398
3427
  name: string;
@@ -3405,7 +3434,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3405
3434
  'x-scalar-children'?: {
3406
3435
  tagName: string;
3407
3436
  }[] | undefined;
3408
- }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends Path<{
3437
+ 'x-internal'?: boolean | undefined;
3438
+ 'x-scalar-ignore'?: boolean | undefined;
3439
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends Path<{
3409
3440
  type: "tag";
3410
3441
  uid: string;
3411
3442
  name: string;
@@ -3418,6 +3449,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3418
3449
  'x-scalar-children'?: {
3419
3450
  tagName: string;
3420
3451
  }[] | undefined;
3452
+ 'x-internal'?: boolean | undefined;
3453
+ 'x-scalar-ignore'?: boolean | undefined;
3421
3454
  }[K]> ? PathValue<{
3422
3455
  type: "tag";
3423
3456
  uid: string;
@@ -3431,8 +3464,10 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3431
3464
  'x-scalar-children'?: {
3432
3465
  tagName: string;
3433
3466
  }[] | undefined;
3467
+ 'x-internal'?: boolean | undefined;
3468
+ 'x-scalar-ignore'?: boolean | undefined;
3434
3469
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3435
- 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" ? {
3470
+ 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" ? {
3436
3471
  type: "tag";
3437
3472
  uid: string;
3438
3473
  name: string;
@@ -3445,7 +3480,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3445
3480
  'x-scalar-children'?: {
3446
3481
  tagName: string;
3447
3482
  }[] | undefined;
3448
- }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends Path<{
3483
+ 'x-internal'?: boolean | undefined;
3484
+ 'x-scalar-ignore'?: boolean | undefined;
3485
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends Path<{
3449
3486
  type: "tag";
3450
3487
  uid: string;
3451
3488
  name: string;
@@ -3458,6 +3495,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3458
3495
  'x-scalar-children'?: {
3459
3496
  tagName: string;
3460
3497
  }[] | undefined;
3498
+ 'x-internal'?: boolean | undefined;
3499
+ 'x-scalar-ignore'?: boolean | undefined;
3461
3500
  }[K]> ? PathValue<{
3462
3501
  type: "tag";
3463
3502
  uid: string;
@@ -3471,6 +3510,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3471
3510
  'x-scalar-children'?: {
3472
3511
  tagName: string;
3473
3512
  }[] | undefined;
3513
+ 'x-internal'?: boolean | undefined;
3514
+ 'x-scalar-ignore'?: boolean | undefined;
3474
3515
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3475
3516
  undo: (uid: string) => void;
3476
3517
  redo: (uid: string) => void;