@scalar/api-client 2.2.35 → 2.2.38

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 (164) hide show
  1. package/CHANGELOG.md +61 -0
  2. package/dist/components/AddressBar/AddressBar.vue.d.ts.map +1 -1
  3. package/dist/components/AddressBar/AddressBar.vue.js +1 -1
  4. package/dist/components/AddressBar/AddressBar.vue2.js +107 -116
  5. package/dist/components/AddressBar/AddressBarHistory.vue.d.ts +2 -1
  6. package/dist/components/AddressBar/AddressBarHistory.vue.d.ts.map +1 -1
  7. package/dist/components/AddressBar/AddressBarHistory.vue.js +2 -2
  8. package/dist/components/AddressBar/AddressBarHistory.vue2.js +96 -76
  9. package/dist/components/AddressBar/AddressBarServer.vue.d.ts +5 -1
  10. package/dist/components/AddressBar/AddressBarServer.vue.d.ts.map +1 -1
  11. package/dist/components/AddressBar/AddressBarServer.vue.js +92 -86
  12. package/dist/components/AddressBar/AddressBarServerItem.vue.d.ts +7 -10
  13. package/dist/components/AddressBar/AddressBarServerItem.vue.d.ts.map +1 -1
  14. package/dist/components/AddressBar/AddressBarServerItem.vue.js +5 -52
  15. package/dist/components/AddressBar/AddressBarServerItem.vue2.js +75 -2
  16. package/dist/components/CodeInput/CodeInput.vue.d.ts +5 -0
  17. package/dist/components/CodeInput/CodeInput.vue.d.ts.map +1 -1
  18. package/dist/components/CodeInput/CodeInput.vue.js +1 -1
  19. package/dist/components/CodeInput/CodeInput.vue2.js +126 -112
  20. package/dist/components/CodeInput/codeVariableWidget.d.ts +1 -4
  21. package/dist/components/CodeInput/codeVariableWidget.d.ts.map +1 -1
  22. package/dist/components/CommandPalette/CommandActionInput.vue.d.ts +1 -0
  23. package/dist/components/CommandPalette/CommandActionInput.vue.d.ts.map +1 -1
  24. package/dist/components/CommandPalette/CommandActionInput.vue.js +21 -18
  25. package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts.map +1 -1
  26. package/dist/components/CommandPalette/TheCommandPalette.vue.js +2 -2
  27. package/dist/components/CommandPalette/TheCommandPalette.vue2.js +2 -2
  28. package/dist/components/DataTable/DataTableInput.vue.d.ts.map +1 -1
  29. package/dist/components/DataTable/DataTableInput.vue.js +2 -2
  30. package/dist/components/DataTable/DataTableInputSelect.vue.d.ts +1 -0
  31. package/dist/components/DataTable/DataTableInputSelect.vue.d.ts.map +1 -1
  32. package/dist/components/DataTable/DataTableInputSelect.vue.js +86 -54
  33. package/dist/components/EnvironmentSelector/EnvironmentSelector.vue.d.ts.map +1 -1
  34. package/dist/components/EnvironmentSelector/EnvironmentSelector.vue.js +22 -21
  35. package/dist/components/Form/Form.vue.d.ts.map +1 -1
  36. package/dist/components/Form/Form.vue.js +3 -3
  37. package/dist/components/Server/ServerVariablesForm.vue.d.ts +14 -0
  38. package/dist/components/Server/ServerVariablesForm.vue.d.ts.map +1 -0
  39. package/dist/components/Server/ServerVariablesForm.vue.js +47 -0
  40. package/dist/components/Server/ServerVariablesForm.vue2.js +4 -0
  41. package/dist/components/Server/ServerVariablesSelect.vue.d.ts +12 -0
  42. package/dist/components/Server/ServerVariablesSelect.vue.d.ts.map +1 -0
  43. package/dist/components/Server/ServerVariablesSelect.vue.js +54 -0
  44. package/dist/components/Server/ServerVariablesSelect.vue2.js +4 -0
  45. package/dist/components/Server/ServerVariablesTextbox.vue.d.ts +11 -0
  46. package/dist/components/Server/ServerVariablesTextbox.vue.d.ts.map +1 -0
  47. package/dist/components/Server/ServerVariablesTextbox.vue.js +29 -0
  48. package/dist/components/Server/ServerVariablesTextbox.vue2.js +4 -0
  49. package/dist/components/Server/types.d.ts +9 -0
  50. package/dist/components/Server/types.d.ts.map +1 -0
  51. package/dist/components/SideNav/SideHelp.vue.js +16 -16
  52. package/dist/components/Sidebar/Sidebar.vue.d.ts.map +1 -1
  53. package/dist/components/Sidebar/Sidebar.vue.js +2 -2
  54. package/dist/components/Sidebar/Sidebar.vue2.js +11 -10
  55. package/dist/components/Sidebar/SidebarListElement.vue.d.ts.map +1 -1
  56. package/dist/components/Sidebar/SidebarListElement.vue.js +1 -1
  57. package/dist/components/Sidebar/SidebarListElement.vue2.js +10 -9
  58. package/dist/components/TopNav/TopNav.vue.js +27 -27
  59. package/dist/components/ViewLayout/ViewLayoutCollapse.vue.d.ts +1 -1
  60. package/dist/components/ViewLayout/ViewLayoutCollapse.vue.d.ts.map +1 -1
  61. package/dist/layouts/App/create-api-client-app.d.ts +99 -84
  62. package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
  63. package/dist/layouts/Modal/create-api-client-modal.d.ts +198 -168
  64. package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
  65. package/dist/layouts/Web/create-api-client-web.d.ts +99 -84
  66. package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
  67. package/dist/libs/create-client.d.ts +110 -90
  68. package/dist/libs/create-client.d.ts.map +1 -1
  69. package/dist/libs/create-client.js +86 -81
  70. package/dist/libs/find-request.d.ts.map +1 -1
  71. package/dist/libs/importers/curl.js +4 -4
  72. package/dist/libs/index.js +18 -19
  73. package/dist/libs/send-request/index.js +3 -4
  74. package/dist/libs/send-request/send-request.d.ts +0 -14
  75. package/dist/libs/send-request/send-request.d.ts.map +1 -1
  76. package/dist/libs/send-request/send-request.js +120 -142
  77. package/dist/libs/send-request/set-request-cookies.d.ts +27 -0
  78. package/dist/libs/send-request/set-request-cookies.d.ts.map +1 -0
  79. package/dist/libs/send-request/set-request-cookies.js +54 -0
  80. package/dist/store/active-entities.d.ts +13 -4
  81. package/dist/store/active-entities.d.ts.map +1 -1
  82. package/dist/store/active-entities.js +15 -12
  83. package/dist/store/collections.d.ts.map +1 -1
  84. package/dist/store/cookies.d.ts +4 -58
  85. package/dist/store/cookies.d.ts.map +1 -1
  86. package/dist/store/cookies.js +5 -17
  87. package/dist/store/import-spec.d.ts.map +1 -1
  88. package/dist/store/request-example.d.ts +52 -2
  89. package/dist/store/request-example.d.ts.map +1 -1
  90. package/dist/store/requests.d.ts +2 -2
  91. package/dist/store/requests.d.ts.map +1 -1
  92. package/dist/store/servers.d.ts +40 -20
  93. package/dist/store/servers.d.ts.map +1 -1
  94. package/dist/store/store.d.ts +99 -86
  95. package/dist/store/store.d.ts.map +1 -1
  96. package/dist/store/store.js +51 -53
  97. package/dist/style.css +1 -1
  98. package/dist/views/Cookies/CookieForm.vue.d.ts.map +1 -1
  99. package/dist/views/Cookies/CookieForm.vue.js +24 -37
  100. package/dist/views/Cookies/CookieModal.vue.d.ts +21 -0
  101. package/dist/views/Cookies/CookieModal.vue.d.ts.map +1 -0
  102. package/dist/views/Cookies/CookieModal.vue.js +7 -0
  103. package/dist/views/Cookies/CookieModal.vue2.js +88 -0
  104. package/dist/views/Cookies/Cookies.vue.d.ts.map +1 -1
  105. package/dist/views/Cookies/Cookies.vue2.js +98 -119
  106. package/dist/views/Environment/Environment.vue2.js +1 -1
  107. package/dist/views/Request/Request.vue.d.ts.map +1 -1
  108. package/dist/views/Request/Request.vue.js +2 -2
  109. package/dist/views/Request/Request.vue2.js +88 -89
  110. package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue.d.ts.map +1 -1
  111. package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue.js +1 -1
  112. package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue2.js +87 -88
  113. package/dist/views/Request/RequestSection/RequestAuth/RequestAuthDataTable.vue.d.ts +2 -1
  114. package/dist/views/Request/RequestSection/RequestAuth/RequestAuthDataTable.vue.d.ts.map +1 -1
  115. package/dist/views/Request/RequestSection/RequestAuth/RequestAuthDataTable.vue.js +3 -3
  116. package/dist/views/Request/RequestSection/RequestAuth/RequestAuthDataTable.vue2.js +16 -17
  117. package/dist/views/Request/RequestSection/RequestAuth/RequestExampleAuth.vue.js +2 -2
  118. package/dist/views/Request/RequestSection/RequestAuth/RequestExampleAuth.vue2.js +1 -1
  119. package/dist/views/Request/RequestSection/RequestBody.vue.js +2 -2
  120. package/dist/views/Request/RequestSection/RequestBody.vue2.js +34 -34
  121. package/dist/views/Request/RequestSection/RequestParams.vue.d.ts +7 -0
  122. package/dist/views/Request/RequestSection/RequestParams.vue.d.ts.map +1 -1
  123. package/dist/views/Request/RequestSection/RequestParams.vue.js +79 -66
  124. package/dist/views/Request/RequestSection/RequestPathParams.vue.d.ts.map +1 -1
  125. package/dist/views/Request/RequestSection/RequestPathParams.vue.js +57 -74
  126. package/dist/views/Request/RequestSection/RequestSection.vue.d.ts.map +1 -1
  127. package/dist/views/Request/RequestSection/RequestSection.vue.js +2 -2
  128. package/dist/views/Request/RequestSection/RequestSection.vue2.js +91 -64
  129. package/dist/views/Request/RequestSection/RequestTable.vue.d.ts +9 -2
  130. package/dist/views/Request/RequestSection/RequestTable.vue.d.ts.map +1 -1
  131. package/dist/views/Request/RequestSection/RequestTable.vue.js +2 -2
  132. package/dist/views/Request/RequestSection/RequestTable.vue2.js +168 -129
  133. package/dist/views/Request/RequestSection/RequestTableTooltip.vue.d.ts.map +1 -1
  134. package/dist/views/Request/RequestSection/RequestTableTooltip.vue.js +5 -64
  135. package/dist/views/Request/RequestSection/RequestTableTooltip.vue2.js +46 -2
  136. package/dist/views/Request/RequestSidebar.vue.d.ts.map +1 -1
  137. package/dist/views/Request/RequestSidebar.vue.js +2 -2
  138. package/dist/views/Request/RequestSidebar.vue2.js +143 -143
  139. package/dist/views/Request/RequestSidebarItem.vue.d.ts.map +1 -1
  140. package/dist/views/Request/RequestSidebarItem.vue.js +1 -1
  141. package/dist/views/Request/RequestSidebarItem.vue2.js +71 -71
  142. package/dist/views/Request/RequestSubpageHeader.vue.d.ts.map +1 -1
  143. package/dist/views/Request/RequestSubpageHeader.vue.js +1 -1
  144. package/dist/views/Request/RequestSubpageHeader.vue2.js +37 -37
  145. package/dist/views/Request/ResponseSection/ResponseCookies.vue.js +19 -17
  146. package/dist/views/Request/ResponseSection/ResponseEmpty.vue.d.ts.map +1 -1
  147. package/dist/views/Request/ResponseSection/ResponseEmpty.vue.js +2 -2
  148. package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +27 -27
  149. package/dist/views/Request/ResponseSection/ResponseHeaders.vue.js +31 -31
  150. package/dist/views/Request/handle-drag.d.ts +1 -1
  151. package/dist/views/Request/handle-drag.d.ts.map +1 -1
  152. package/dist/views/Request/handle-drag.js +27 -26
  153. package/dist/views/Request/hooks/useOpenApiWatcher.js +1 -1
  154. package/dist/views/Request/libs/request.d.ts +12 -0
  155. package/dist/views/Request/libs/request.d.ts.map +1 -0
  156. package/dist/views/Request/libs/request.js +4 -0
  157. package/dist/views/Request/libs/{live-sync.d.ts → watch-mode.d.ts} +1 -1
  158. package/dist/views/Request/libs/watch-mode.d.ts.map +1 -0
  159. package/dist/views/Request/libs/{live-sync.js → watch-mode.js} +6 -6
  160. package/dist/views/Servers/Servers.vue2.js +29 -29
  161. package/package.json +10 -12
  162. package/dist/views/Cookies/CookieRaw.vue.js +0 -28
  163. package/dist/views/Cookies/CookieRaw.vue2.js +0 -4
  164. package/dist/views/Request/libs/live-sync.d.ts.map +0 -1
@@ -13,7 +13,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
13
13
  propertyKey: P;
14
14
  value: NonNullable<import("@scalar/object-utils/nested").PathValue<import("@scalar/oas-utils/entities/spec").SecurityScheme, P>>;
15
15
  }) => void;
16
- route: (params: import("../../libs/index.js").OpenClientPayload) => void;
16
+ route: (payload?: import("../../libs/index.js").OpenClientPayload) => void;
17
17
  open: (payload?: import("../../libs/index.js").OpenClientPayload) => void;
18
18
  mount: (mountingEl?: HTMLElement | null) => void;
19
19
  modalState: {
@@ -115,14 +115,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
115
115
  value: string;
116
116
  uid: string;
117
117
  name: string;
118
- sameSite: "Lax" | "Strict" | "None";
119
118
  path?: string | undefined;
120
119
  domain?: string | undefined;
121
- expires?: Date | undefined;
122
- httpOnly?: boolean | undefined;
123
- maxAge?: number | undefined;
124
- partitioned?: boolean | undefined;
125
- secure?: boolean | undefined;
126
120
  }>;
127
121
  environments: Record<string, {
128
122
  value: string;
@@ -147,6 +141,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
147
141
  required?: boolean | undefined;
148
142
  description?: string | undefined;
149
143
  enum?: string[] | undefined;
144
+ examples?: string[] | undefined;
150
145
  format?: string | undefined;
151
146
  file?: any;
152
147
  nullable?: boolean | undefined;
@@ -162,6 +157,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
162
157
  required?: boolean | undefined;
163
158
  description?: string | undefined;
164
159
  enum?: string[] | undefined;
160
+ examples?: string[] | undefined;
165
161
  format?: string | undefined;
166
162
  file?: any;
167
163
  nullable?: boolean | undefined;
@@ -177,6 +173,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
177
173
  required?: boolean | undefined;
178
174
  description?: string | undefined;
179
175
  enum?: string[] | undefined;
176
+ examples?: string[] | undefined;
180
177
  format?: string | undefined;
181
178
  file?: any;
182
179
  nullable?: boolean | undefined;
@@ -192,6 +189,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
192
189
  required?: boolean | undefined;
193
190
  description?: string | undefined;
194
191
  enum?: string[] | undefined;
192
+ examples?: string[] | undefined;
195
193
  format?: string | undefined;
196
194
  file?: any;
197
195
  nullable?: boolean | undefined;
@@ -212,6 +210,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
212
210
  required?: boolean | undefined;
213
211
  description?: string | undefined;
214
212
  enum?: string[] | undefined;
213
+ examples?: string[] | undefined;
215
214
  format?: string | undefined;
216
215
  file?: any;
217
216
  nullable?: boolean | undefined;
@@ -269,8 +268,10 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
269
268
  uid: string;
270
269
  url: string;
271
270
  description?: string | undefined;
272
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
273
- enum?: [string, ...string[]];
271
+ variables?: Record<string, {
272
+ default?: string | undefined;
273
+ description?: string | undefined;
274
+ enum?: string[] | undefined;
274
275
  }> | undefined;
275
276
  }>;
276
277
  securitySchemes: Record<string, {
@@ -367,7 +368,6 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
367
368
  sidebarWidth: import("vue").Ref<string, string>;
368
369
  setSidebarWidth: (width: string) => void;
369
370
  proxyUrl: string | undefined;
370
- isReadOnly: boolean;
371
371
  hideClientButton: boolean | undefined;
372
372
  showSidebar: boolean;
373
373
  integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
@@ -657,102 +657,54 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
657
657
  value: string;
658
658
  uid: string;
659
659
  name: string;
660
- sameSite: "Lax" | "Strict" | "None";
661
660
  path?: string | undefined;
662
661
  domain?: string | undefined;
663
- expires?: Date | undefined;
664
- httpOnly?: boolean | undefined;
665
- maxAge?: number | undefined;
666
- partitioned?: boolean | undefined;
667
- secure?: boolean | undefined;
668
662
  }) => void;
669
663
  delete: (uid: string) => void;
670
664
  set: (item: {
671
665
  value: string;
672
666
  uid: string;
673
667
  name: string;
674
- sameSite: "Lax" | "Strict" | "None";
675
668
  path?: string | undefined;
676
669
  domain?: string | undefined;
677
- expires?: Date | undefined;
678
- httpOnly?: boolean | undefined;
679
- maxAge?: number | undefined;
680
- partitioned?: boolean | undefined;
681
- secure?: boolean | undefined;
682
670
  }) => void;
683
- edit: <P extends "name" | "uid" | "path" | "value" | "domain" | "sameSite" | "expires" | "httpOnly" | "maxAge" | "partitioned" | "secure">(uid: string, path: P, value: P extends "name" | "uid" | "path" | "value" | "domain" | "sameSite" | "expires" | "httpOnly" | "maxAge" | "partitioned" | "secure" ? {
671
+ edit: <P extends "name" | "uid" | "path" | "value" | "domain">(uid: string, path: P, value: P extends "name" | "uid" | "path" | "value" | "domain" ? {
684
672
  value: string;
685
673
  uid: string;
686
674
  name: string;
687
- sameSite: "Lax" | "Strict" | "None";
688
675
  path?: string | undefined;
689
676
  domain?: string | undefined;
690
- expires?: Date | undefined;
691
- httpOnly?: boolean | undefined;
692
- maxAge?: number | undefined;
693
- partitioned?: boolean | undefined;
694
- secure?: boolean | undefined;
695
- }[P] : P extends `${infer K}.${infer R}` ? K extends "name" | "uid" | "path" | "value" | "domain" | "sameSite" | "expires" | "httpOnly" | "maxAge" | "partitioned" | "secure" ? R extends import("@scalar/object-utils/nested").Path<{
677
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "name" | "uid" | "path" | "value" | "domain" ? R extends import("@scalar/object-utils/nested").Path<{
696
678
  value: string;
697
679
  uid: string;
698
680
  name: string;
699
- sameSite: "Lax" | "Strict" | "None";
700
681
  path?: string | undefined;
701
682
  domain?: string | undefined;
702
- expires?: Date | undefined;
703
- httpOnly?: boolean | undefined;
704
- maxAge?: number | undefined;
705
- partitioned?: boolean | undefined;
706
- secure?: boolean | undefined;
707
683
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
708
684
  value: string;
709
685
  uid: string;
710
686
  name: string;
711
- sameSite: "Lax" | "Strict" | "None";
712
687
  path?: string | undefined;
713
688
  domain?: string | undefined;
714
- expires?: Date | undefined;
715
- httpOnly?: boolean | undefined;
716
- maxAge?: number | undefined;
717
- partitioned?: boolean | undefined;
718
- secure?: boolean | undefined;
719
689
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
720
- untrackedEdit: <P extends "name" | "uid" | "path" | "value" | "domain" | "sameSite" | "expires" | "httpOnly" | "maxAge" | "partitioned" | "secure">(uid: string, path: P, value: P extends "name" | "uid" | "path" | "value" | "domain" | "sameSite" | "expires" | "httpOnly" | "maxAge" | "partitioned" | "secure" ? {
690
+ untrackedEdit: <P extends "name" | "uid" | "path" | "value" | "domain">(uid: string, path: P, value: P extends "name" | "uid" | "path" | "value" | "domain" ? {
721
691
  value: string;
722
692
  uid: string;
723
693
  name: string;
724
- sameSite: "Lax" | "Strict" | "None";
725
694
  path?: string | undefined;
726
695
  domain?: string | undefined;
727
- expires?: Date | undefined;
728
- httpOnly?: boolean | undefined;
729
- maxAge?: number | undefined;
730
- partitioned?: boolean | undefined;
731
- secure?: boolean | undefined;
732
- }[P] : P extends `${infer K}.${infer R}` ? K extends "name" | "uid" | "path" | "value" | "domain" | "sameSite" | "expires" | "httpOnly" | "maxAge" | "partitioned" | "secure" ? R extends import("@scalar/object-utils/nested").Path<{
696
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "name" | "uid" | "path" | "value" | "domain" ? R extends import("@scalar/object-utils/nested").Path<{
733
697
  value: string;
734
698
  uid: string;
735
699
  name: string;
736
- sameSite: "Lax" | "Strict" | "None";
737
700
  path?: string | undefined;
738
701
  domain?: string | undefined;
739
- expires?: Date | undefined;
740
- httpOnly?: boolean | undefined;
741
- maxAge?: number | undefined;
742
- partitioned?: boolean | undefined;
743
- secure?: boolean | undefined;
744
702
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
745
703
  value: string;
746
704
  uid: string;
747
705
  name: string;
748
- sameSite: "Lax" | "Strict" | "None";
749
706
  path?: string | undefined;
750
707
  domain?: string | undefined;
751
- expires?: Date | undefined;
752
- httpOnly?: boolean | undefined;
753
- maxAge?: number | undefined;
754
- partitioned?: boolean | undefined;
755
- secure?: boolean | undefined;
756
708
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
757
709
  undo: (uid: string) => void;
758
710
  redo: (uid: string) => void;
@@ -1434,7 +1386,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1434
1386
  requestBody?: any;
1435
1387
  responses?: Record<string, any> | undefined;
1436
1388
  }) => void;
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" ? {
1389
+ 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" | `examples.${number}` | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.examples` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}`>(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" ? {
1438
1390
  path: string;
1439
1391
  type: "request";
1440
1392
  uid: string;
@@ -1549,7 +1501,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1549
1501
  requestBody?: any;
1550
1502
  responses?: Record<string, any> | undefined;
1551
1503
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
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" ? {
1504
+ 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" | `examples.${number}` | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.examples` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}`>(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" ? {
1553
1505
  path: string;
1554
1506
  type: "request";
1555
1507
  uid: string;
@@ -1686,6 +1638,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1686
1638
  required?: boolean | undefined;
1687
1639
  description?: string | undefined;
1688
1640
  enum?: string[] | undefined;
1641
+ examples?: string[] | undefined;
1689
1642
  format?: string | undefined;
1690
1643
  file?: any;
1691
1644
  nullable?: boolean | undefined;
@@ -1701,6 +1654,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1701
1654
  required?: boolean | undefined;
1702
1655
  description?: string | undefined;
1703
1656
  enum?: string[] | undefined;
1657
+ examples?: string[] | undefined;
1704
1658
  format?: string | undefined;
1705
1659
  file?: any;
1706
1660
  nullable?: boolean | undefined;
@@ -1716,6 +1670,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1716
1670
  required?: boolean | undefined;
1717
1671
  description?: string | undefined;
1718
1672
  enum?: string[] | undefined;
1673
+ examples?: string[] | undefined;
1719
1674
  format?: string | undefined;
1720
1675
  file?: any;
1721
1676
  nullable?: boolean | undefined;
@@ -1731,6 +1686,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1731
1686
  required?: boolean | undefined;
1732
1687
  description?: string | undefined;
1733
1688
  enum?: string[] | undefined;
1689
+ examples?: string[] | undefined;
1734
1690
  format?: string | undefined;
1735
1691
  file?: any;
1736
1692
  nullable?: boolean | undefined;
@@ -1751,6 +1707,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1751
1707
  required?: boolean | undefined;
1752
1708
  description?: string | undefined;
1753
1709
  enum?: string[] | undefined;
1710
+ examples?: string[] | undefined;
1754
1711
  format?: string | undefined;
1755
1712
  file?: any;
1756
1713
  nullable?: boolean | undefined;
@@ -1781,6 +1738,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1781
1738
  required?: boolean | undefined;
1782
1739
  description?: string | undefined;
1783
1740
  enum?: string[] | undefined;
1741
+ examples?: string[] | undefined;
1784
1742
  format?: string | undefined;
1785
1743
  file?: any;
1786
1744
  nullable?: boolean | undefined;
@@ -1796,6 +1754,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1796
1754
  required?: boolean | undefined;
1797
1755
  description?: string | undefined;
1798
1756
  enum?: string[] | undefined;
1757
+ examples?: string[] | undefined;
1799
1758
  format?: string | undefined;
1800
1759
  file?: any;
1801
1760
  nullable?: boolean | undefined;
@@ -1811,6 +1770,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1811
1770
  required?: boolean | undefined;
1812
1771
  description?: string | undefined;
1813
1772
  enum?: string[] | undefined;
1773
+ examples?: string[] | undefined;
1814
1774
  format?: string | undefined;
1815
1775
  file?: any;
1816
1776
  nullable?: boolean | undefined;
@@ -1826,6 +1786,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1826
1786
  required?: boolean | undefined;
1827
1787
  description?: string | undefined;
1828
1788
  enum?: string[] | undefined;
1789
+ examples?: string[] | undefined;
1829
1790
  format?: string | undefined;
1830
1791
  file?: any;
1831
1792
  nullable?: boolean | undefined;
@@ -1846,6 +1807,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1846
1807
  required?: boolean | undefined;
1847
1808
  description?: string | undefined;
1848
1809
  enum?: string[] | undefined;
1810
+ examples?: string[] | undefined;
1849
1811
  format?: string | undefined;
1850
1812
  file?: any;
1851
1813
  nullable?: boolean | undefined;
@@ -1877,6 +1839,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1877
1839
  required?: boolean | undefined;
1878
1840
  description?: string | undefined;
1879
1841
  enum?: string[] | undefined;
1842
+ examples?: string[] | undefined;
1880
1843
  format?: string | undefined;
1881
1844
  file?: any;
1882
1845
  nullable?: boolean | undefined;
@@ -1892,6 +1855,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1892
1855
  required?: boolean | undefined;
1893
1856
  description?: string | undefined;
1894
1857
  enum?: string[] | undefined;
1858
+ examples?: string[] | undefined;
1895
1859
  format?: string | undefined;
1896
1860
  file?: any;
1897
1861
  nullable?: boolean | undefined;
@@ -1907,6 +1871,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1907
1871
  required?: boolean | undefined;
1908
1872
  description?: string | undefined;
1909
1873
  enum?: string[] | undefined;
1874
+ examples?: string[] | undefined;
1910
1875
  format?: string | undefined;
1911
1876
  file?: any;
1912
1877
  nullable?: boolean | undefined;
@@ -1922,6 +1887,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1922
1887
  required?: boolean | undefined;
1923
1888
  description?: string | undefined;
1924
1889
  enum?: string[] | undefined;
1890
+ examples?: string[] | undefined;
1925
1891
  format?: string | undefined;
1926
1892
  file?: any;
1927
1893
  nullable?: boolean | undefined;
@@ -1942,6 +1908,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1942
1908
  required?: boolean | undefined;
1943
1909
  description?: string | undefined;
1944
1910
  enum?: string[] | undefined;
1911
+ examples?: string[] | undefined;
1945
1912
  format?: string | undefined;
1946
1913
  file?: any;
1947
1914
  nullable?: boolean | undefined;
@@ -1956,7 +1923,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1956
1923
  requestUid: string;
1957
1924
  serverVariables?: Record<string, string[]> | undefined;
1958
1925
  }) => 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" ? {
1926
+ 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}.examples` | `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}.examples.${number}` | `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}.examples` | `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}.examples.${number}` | `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}.examples` | `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}.examples.${number}` | `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}.examples` | `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}.examples.${number}` | `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}.examples` | `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}.examples.${number}` | `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
1927
  type: "requestExample";
1961
1928
  uid: string;
1962
1929
  name: string;
@@ -1972,6 +1939,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1972
1939
  required?: boolean | undefined;
1973
1940
  description?: string | undefined;
1974
1941
  enum?: string[] | undefined;
1942
+ examples?: string[] | undefined;
1975
1943
  format?: string | undefined;
1976
1944
  file?: any;
1977
1945
  nullable?: boolean | undefined;
@@ -1987,6 +1955,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1987
1955
  required?: boolean | undefined;
1988
1956
  description?: string | undefined;
1989
1957
  enum?: string[] | undefined;
1958
+ examples?: string[] | undefined;
1990
1959
  format?: string | undefined;
1991
1960
  file?: any;
1992
1961
  nullable?: boolean | undefined;
@@ -2002,6 +1971,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2002
1971
  required?: boolean | undefined;
2003
1972
  description?: string | undefined;
2004
1973
  enum?: string[] | undefined;
1974
+ examples?: string[] | undefined;
2005
1975
  format?: string | undefined;
2006
1976
  file?: any;
2007
1977
  nullable?: boolean | undefined;
@@ -2017,6 +1987,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2017
1987
  required?: boolean | undefined;
2018
1988
  description?: string | undefined;
2019
1989
  enum?: string[] | undefined;
1990
+ examples?: string[] | undefined;
2020
1991
  format?: string | undefined;
2021
1992
  file?: any;
2022
1993
  nullable?: boolean | undefined;
@@ -2037,6 +2008,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2037
2008
  required?: boolean | undefined;
2038
2009
  description?: string | undefined;
2039
2010
  enum?: string[] | undefined;
2011
+ examples?: string[] | undefined;
2040
2012
  format?: string | undefined;
2041
2013
  file?: any;
2042
2014
  nullable?: boolean | undefined;
@@ -2066,6 +2038,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2066
2038
  required?: boolean | undefined;
2067
2039
  description?: string | undefined;
2068
2040
  enum?: string[] | undefined;
2041
+ examples?: string[] | undefined;
2069
2042
  format?: string | undefined;
2070
2043
  file?: any;
2071
2044
  nullable?: boolean | undefined;
@@ -2081,6 +2054,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2081
2054
  required?: boolean | undefined;
2082
2055
  description?: string | undefined;
2083
2056
  enum?: string[] | undefined;
2057
+ examples?: string[] | undefined;
2084
2058
  format?: string | undefined;
2085
2059
  file?: any;
2086
2060
  nullable?: boolean | undefined;
@@ -2096,6 +2070,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2096
2070
  required?: boolean | undefined;
2097
2071
  description?: string | undefined;
2098
2072
  enum?: string[] | undefined;
2073
+ examples?: string[] | undefined;
2099
2074
  format?: string | undefined;
2100
2075
  file?: any;
2101
2076
  nullable?: boolean | undefined;
@@ -2111,6 +2086,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2111
2086
  required?: boolean | undefined;
2112
2087
  description?: string | undefined;
2113
2088
  enum?: string[] | undefined;
2089
+ examples?: string[] | undefined;
2114
2090
  format?: string | undefined;
2115
2091
  file?: any;
2116
2092
  nullable?: boolean | undefined;
@@ -2131,6 +2107,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2131
2107
  required?: boolean | undefined;
2132
2108
  description?: string | undefined;
2133
2109
  enum?: string[] | undefined;
2110
+ examples?: string[] | undefined;
2134
2111
  format?: string | undefined;
2135
2112
  file?: any;
2136
2113
  nullable?: boolean | undefined;
@@ -2160,6 +2137,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2160
2137
  required?: boolean | undefined;
2161
2138
  description?: string | undefined;
2162
2139
  enum?: string[] | undefined;
2140
+ examples?: string[] | undefined;
2163
2141
  format?: string | undefined;
2164
2142
  file?: any;
2165
2143
  nullable?: boolean | undefined;
@@ -2175,6 +2153,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2175
2153
  required?: boolean | undefined;
2176
2154
  description?: string | undefined;
2177
2155
  enum?: string[] | undefined;
2156
+ examples?: string[] | undefined;
2178
2157
  format?: string | undefined;
2179
2158
  file?: any;
2180
2159
  nullable?: boolean | undefined;
@@ -2190,6 +2169,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2190
2169
  required?: boolean | undefined;
2191
2170
  description?: string | undefined;
2192
2171
  enum?: string[] | undefined;
2172
+ examples?: string[] | undefined;
2193
2173
  format?: string | undefined;
2194
2174
  file?: any;
2195
2175
  nullable?: boolean | undefined;
@@ -2205,6 +2185,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2205
2185
  required?: boolean | undefined;
2206
2186
  description?: string | undefined;
2207
2187
  enum?: string[] | undefined;
2188
+ examples?: string[] | undefined;
2208
2189
  format?: string | undefined;
2209
2190
  file?: any;
2210
2191
  nullable?: boolean | undefined;
@@ -2225,6 +2206,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2225
2206
  required?: boolean | undefined;
2226
2207
  description?: string | undefined;
2227
2208
  enum?: string[] | undefined;
2209
+ examples?: string[] | undefined;
2228
2210
  format?: string | undefined;
2229
2211
  file?: any;
2230
2212
  nullable?: boolean | undefined;
@@ -2239,7 +2221,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2239
2221
  requestUid: string;
2240
2222
  serverVariables?: Record<string, string[]> | undefined;
2241
2223
  }[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" ? {
2224
+ 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}.examples` | `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}.examples.${number}` | `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}.examples` | `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}.examples.${number}` | `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}.examples` | `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}.examples.${number}` | `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}.examples` | `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}.examples.${number}` | `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}.examples` | `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}.examples.${number}` | `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
2225
  type: "requestExample";
2244
2226
  uid: string;
2245
2227
  name: string;
@@ -2255,6 +2237,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2255
2237
  required?: boolean | undefined;
2256
2238
  description?: string | undefined;
2257
2239
  enum?: string[] | undefined;
2240
+ examples?: string[] | undefined;
2258
2241
  format?: string | undefined;
2259
2242
  file?: any;
2260
2243
  nullable?: boolean | undefined;
@@ -2270,6 +2253,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2270
2253
  required?: boolean | undefined;
2271
2254
  description?: string | undefined;
2272
2255
  enum?: string[] | undefined;
2256
+ examples?: string[] | undefined;
2273
2257
  format?: string | undefined;
2274
2258
  file?: any;
2275
2259
  nullable?: boolean | undefined;
@@ -2285,6 +2269,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2285
2269
  required?: boolean | undefined;
2286
2270
  description?: string | undefined;
2287
2271
  enum?: string[] | undefined;
2272
+ examples?: string[] | undefined;
2288
2273
  format?: string | undefined;
2289
2274
  file?: any;
2290
2275
  nullable?: boolean | undefined;
@@ -2300,6 +2285,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2300
2285
  required?: boolean | undefined;
2301
2286
  description?: string | undefined;
2302
2287
  enum?: string[] | undefined;
2288
+ examples?: string[] | undefined;
2303
2289
  format?: string | undefined;
2304
2290
  file?: any;
2305
2291
  nullable?: boolean | undefined;
@@ -2320,6 +2306,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2320
2306
  required?: boolean | undefined;
2321
2307
  description?: string | undefined;
2322
2308
  enum?: string[] | undefined;
2309
+ examples?: string[] | undefined;
2323
2310
  format?: string | undefined;
2324
2311
  file?: any;
2325
2312
  nullable?: boolean | undefined;
@@ -2349,6 +2336,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2349
2336
  required?: boolean | undefined;
2350
2337
  description?: string | undefined;
2351
2338
  enum?: string[] | undefined;
2339
+ examples?: string[] | undefined;
2352
2340
  format?: string | undefined;
2353
2341
  file?: any;
2354
2342
  nullable?: boolean | undefined;
@@ -2364,6 +2352,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2364
2352
  required?: boolean | undefined;
2365
2353
  description?: string | undefined;
2366
2354
  enum?: string[] | undefined;
2355
+ examples?: string[] | undefined;
2367
2356
  format?: string | undefined;
2368
2357
  file?: any;
2369
2358
  nullable?: boolean | undefined;
@@ -2379,6 +2368,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2379
2368
  required?: boolean | undefined;
2380
2369
  description?: string | undefined;
2381
2370
  enum?: string[] | undefined;
2371
+ examples?: string[] | undefined;
2382
2372
  format?: string | undefined;
2383
2373
  file?: any;
2384
2374
  nullable?: boolean | undefined;
@@ -2394,6 +2384,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2394
2384
  required?: boolean | undefined;
2395
2385
  description?: string | undefined;
2396
2386
  enum?: string[] | undefined;
2387
+ examples?: string[] | undefined;
2397
2388
  format?: string | undefined;
2398
2389
  file?: any;
2399
2390
  nullable?: boolean | undefined;
@@ -2414,6 +2405,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2414
2405
  required?: boolean | undefined;
2415
2406
  description?: string | undefined;
2416
2407
  enum?: string[] | undefined;
2408
+ examples?: string[] | undefined;
2417
2409
  format?: string | undefined;
2418
2410
  file?: any;
2419
2411
  nullable?: boolean | undefined;
@@ -2443,6 +2435,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2443
2435
  required?: boolean | undefined;
2444
2436
  description?: string | undefined;
2445
2437
  enum?: string[] | undefined;
2438
+ examples?: string[] | undefined;
2446
2439
  format?: string | undefined;
2447
2440
  file?: any;
2448
2441
  nullable?: boolean | undefined;
@@ -2458,6 +2451,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2458
2451
  required?: boolean | undefined;
2459
2452
  description?: string | undefined;
2460
2453
  enum?: string[] | undefined;
2454
+ examples?: string[] | undefined;
2461
2455
  format?: string | undefined;
2462
2456
  file?: any;
2463
2457
  nullable?: boolean | undefined;
@@ -2473,6 +2467,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2473
2467
  required?: boolean | undefined;
2474
2468
  description?: string | undefined;
2475
2469
  enum?: string[] | undefined;
2470
+ examples?: string[] | undefined;
2476
2471
  format?: string | undefined;
2477
2472
  file?: any;
2478
2473
  nullable?: boolean | undefined;
@@ -2488,6 +2483,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2488
2483
  required?: boolean | undefined;
2489
2484
  description?: string | undefined;
2490
2485
  enum?: string[] | undefined;
2486
+ examples?: string[] | undefined;
2491
2487
  format?: string | undefined;
2492
2488
  file?: any;
2493
2489
  nullable?: boolean | undefined;
@@ -2508,6 +2504,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2508
2504
  required?: boolean | undefined;
2509
2505
  description?: string | undefined;
2510
2506
  enum?: string[] | undefined;
2507
+ examples?: string[] | undefined;
2511
2508
  format?: string | undefined;
2512
2509
  file?: any;
2513
2510
  nullable?: boolean | undefined;
@@ -3227,16 +3224,20 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
3227
3224
  uid: string;
3228
3225
  url: string;
3229
3226
  description?: string | undefined;
3230
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3231
- enum?: [string, ...string[]];
3227
+ variables?: Record<string, {
3228
+ default?: string | undefined;
3229
+ description?: string | undefined;
3230
+ enum?: string[] | undefined;
3232
3231
  }> | undefined;
3233
3232
  }) => void;
3234
3233
  add: (payload: import("@scalar/oas-utils/entities/spec").ServerPayload, parentUid: string) => {
3235
3234
  uid: string;
3236
3235
  url: string;
3237
3236
  description?: string | undefined;
3238
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3239
- enum?: [string, ...string[]];
3237
+ variables?: Record<string, {
3238
+ default?: string | undefined;
3239
+ description?: string | undefined;
3240
+ enum?: string[] | undefined;
3240
3241
  }> | undefined;
3241
3242
  };
3242
3243
  delete: (serverUid: string, collectionUid: string) => void;
@@ -3244,52 +3245,66 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
3244
3245
  uid: string;
3245
3246
  url: string;
3246
3247
  description?: string | undefined;
3247
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3248
- enum?: [string, ...string[]];
3248
+ variables?: Record<string, {
3249
+ default?: string | undefined;
3250
+ description?: string | undefined;
3251
+ enum?: string[] | undefined;
3249
3252
  }> | undefined;
3250
3253
  }) => void;
3251
3254
  edit: <P extends "description" | "uid" | "url" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "description" | "uid" | "url" | "variables" ? {
3252
3255
  uid: string;
3253
3256
  url: string;
3254
3257
  description?: string | undefined;
3255
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3256
- enum?: [string, ...string[]];
3258
+ variables?: Record<string, {
3259
+ default?: string | undefined;
3260
+ description?: string | undefined;
3261
+ enum?: string[] | undefined;
3257
3262
  }> | undefined;
3258
3263
  }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "uid" | "url" | "variables" ? R extends import("@scalar/object-utils/nested").Path<{
3259
3264
  uid: string;
3260
3265
  url: string;
3261
3266
  description?: string | undefined;
3262
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3263
- enum?: [string, ...string[]];
3267
+ variables?: Record<string, {
3268
+ default?: string | undefined;
3269
+ description?: string | undefined;
3270
+ enum?: string[] | undefined;
3264
3271
  }> | undefined;
3265
3272
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
3266
3273
  uid: string;
3267
3274
  url: string;
3268
3275
  description?: string | undefined;
3269
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3270
- enum?: [string, ...string[]];
3276
+ variables?: Record<string, {
3277
+ default?: string | undefined;
3278
+ description?: string | undefined;
3279
+ enum?: string[] | undefined;
3271
3280
  }> | undefined;
3272
3281
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3273
3282
  untrackedEdit: <P extends "description" | "uid" | "url" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "description" | "uid" | "url" | "variables" ? {
3274
3283
  uid: string;
3275
3284
  url: string;
3276
3285
  description?: string | undefined;
3277
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3278
- enum?: [string, ...string[]];
3286
+ variables?: Record<string, {
3287
+ default?: string | undefined;
3288
+ description?: string | undefined;
3289
+ enum?: string[] | undefined;
3279
3290
  }> | undefined;
3280
3291
  }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "uid" | "url" | "variables" ? R extends import("@scalar/object-utils/nested").Path<{
3281
3292
  uid: string;
3282
3293
  url: string;
3283
3294
  description?: string | undefined;
3284
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3285
- enum?: [string, ...string[]];
3295
+ variables?: Record<string, {
3296
+ default?: string | undefined;
3297
+ description?: string | undefined;
3298
+ enum?: string[] | undefined;
3286
3299
  }> | undefined;
3287
3300
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
3288
3301
  uid: string;
3289
3302
  url: string;
3290
3303
  description?: string | undefined;
3291
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3292
- enum?: [string, ...string[]];
3304
+ variables?: Record<string, {
3305
+ default?: string | undefined;
3306
+ description?: string | undefined;
3307
+ enum?: string[] | undefined;
3293
3308
  }> | undefined;
3294
3309
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3295
3310
  undo: (uid: string) => void;