@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
@@ -15,8 +15,6 @@ type CreateWorkspaceStoreOptions = {
15
15
  * @default true
16
16
  */
17
17
  useLocalStorage: boolean;
18
- /** Puts the client into read only mode, usually reservered for the modal */
19
- isReadOnly: boolean;
20
18
  /** Should be renamed to theme to match the references config */
21
19
  themeId: ReferenceConfiguration['theme'];
22
20
  /** Specifies the integration being used. This is primarily for internal purposes and should not be manually set. */
@@ -29,7 +27,7 @@ type CreateWorkspaceStoreOptions = {
29
27
  * This store manages all data and state for the application.
30
28
  * It should be instantiated once and injected into the app’s root component.
31
29
  */
32
- export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showSidebar, proxyUrl, themeId, hideClientButton, integration, }: CreateWorkspaceStoreOptions) => {
30
+ export declare const createWorkspaceStore: ({ useLocalStorage, showSidebar, proxyUrl, themeId, hideClientButton, integration, }: CreateWorkspaceStoreOptions) => {
33
31
  workspaces: Record<string, {
34
32
  uid: string;
35
33
  name: string;
@@ -123,14 +121,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
123
121
  value: string;
124
122
  uid: string;
125
123
  name: string;
126
- sameSite: "Lax" | "Strict" | "None";
127
124
  path?: string | undefined;
128
125
  domain?: string | undefined;
129
- expires?: Date | undefined;
130
- httpOnly?: boolean | undefined;
131
- maxAge?: number | undefined;
132
- partitioned?: boolean | undefined;
133
- secure?: boolean | undefined;
134
126
  }>;
135
127
  environments: Record<string, {
136
128
  value: string;
@@ -155,6 +147,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
155
147
  required?: boolean | undefined;
156
148
  description?: string | undefined;
157
149
  enum?: string[] | undefined;
150
+ examples?: string[] | undefined;
158
151
  format?: string | undefined;
159
152
  file?: any;
160
153
  nullable?: boolean | undefined;
@@ -170,6 +163,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
170
163
  required?: boolean | undefined;
171
164
  description?: string | undefined;
172
165
  enum?: string[] | undefined;
166
+ examples?: string[] | undefined;
173
167
  format?: string | undefined;
174
168
  file?: any;
175
169
  nullable?: boolean | undefined;
@@ -185,6 +179,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
185
179
  required?: boolean | undefined;
186
180
  description?: string | undefined;
187
181
  enum?: string[] | undefined;
182
+ examples?: string[] | undefined;
188
183
  format?: string | undefined;
189
184
  file?: any;
190
185
  nullable?: boolean | undefined;
@@ -200,6 +195,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
200
195
  required?: boolean | undefined;
201
196
  description?: string | undefined;
202
197
  enum?: string[] | undefined;
198
+ examples?: string[] | undefined;
203
199
  format?: string | undefined;
204
200
  file?: any;
205
201
  nullable?: boolean | undefined;
@@ -220,6 +216,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
220
216
  required?: boolean | undefined;
221
217
  description?: string | undefined;
222
218
  enum?: string[] | undefined;
219
+ examples?: string[] | undefined;
223
220
  format?: string | undefined;
224
221
  file?: any;
225
222
  nullable?: boolean | undefined;
@@ -277,8 +274,10 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
277
274
  uid: string;
278
275
  url: string;
279
276
  description?: string | undefined;
280
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
281
- enum?: [string, ...string[]];
277
+ variables?: Record<string, {
278
+ default?: string | undefined;
279
+ description?: string | undefined;
280
+ enum?: string[] | undefined;
282
281
  }> | undefined;
283
282
  }>;
284
283
  securitySchemes: Record<string, {
@@ -375,7 +374,6 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
375
374
  sidebarWidth: import("vue").Ref<string, string>;
376
375
  setSidebarWidth: (width: string) => void;
377
376
  proxyUrl: string | undefined;
378
- isReadOnly: boolean;
379
377
  hideClientButton: boolean | undefined;
380
378
  showSidebar: boolean;
381
379
  integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
@@ -665,102 +663,54 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
665
663
  value: string;
666
664
  uid: string;
667
665
  name: string;
668
- sameSite: "Lax" | "Strict" | "None";
669
666
  path?: string | undefined;
670
667
  domain?: string | undefined;
671
- expires?: Date | undefined;
672
- httpOnly?: boolean | undefined;
673
- maxAge?: number | undefined;
674
- partitioned?: boolean | undefined;
675
- secure?: boolean | undefined;
676
668
  }) => void;
677
669
  delete: (uid: string) => void;
678
670
  set: (item: {
679
671
  value: string;
680
672
  uid: string;
681
673
  name: string;
682
- sameSite: "Lax" | "Strict" | "None";
683
674
  path?: string | undefined;
684
675
  domain?: string | undefined;
685
- expires?: Date | undefined;
686
- httpOnly?: boolean | undefined;
687
- maxAge?: number | undefined;
688
- partitioned?: boolean | undefined;
689
- secure?: boolean | undefined;
690
676
  }) => void;
691
- 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" ? {
677
+ edit: <P extends "name" | "uid" | "path" | "value" | "domain">(uid: string, path: P, value: P extends "name" | "uid" | "path" | "value" | "domain" ? {
692
678
  value: string;
693
679
  uid: string;
694
680
  name: string;
695
- sameSite: "Lax" | "Strict" | "None";
696
681
  path?: string | undefined;
697
682
  domain?: string | undefined;
698
- expires?: Date | undefined;
699
- httpOnly?: boolean | undefined;
700
- maxAge?: number | undefined;
701
- partitioned?: boolean | undefined;
702
- secure?: boolean | undefined;
703
- }[P] : P extends `${infer K}.${infer R}` ? K extends "name" | "uid" | "path" | "value" | "domain" | "sameSite" | "expires" | "httpOnly" | "maxAge" | "partitioned" | "secure" ? R extends Path<{
683
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "name" | "uid" | "path" | "value" | "domain" ? R extends Path<{
704
684
  value: string;
705
685
  uid: string;
706
686
  name: string;
707
- sameSite: "Lax" | "Strict" | "None";
708
687
  path?: string | undefined;
709
688
  domain?: string | undefined;
710
- expires?: Date | undefined;
711
- httpOnly?: boolean | undefined;
712
- maxAge?: number | undefined;
713
- partitioned?: boolean | undefined;
714
- secure?: boolean | undefined;
715
689
  }[K]> ? PathValue<{
716
690
  value: string;
717
691
  uid: string;
718
692
  name: string;
719
- sameSite: "Lax" | "Strict" | "None";
720
693
  path?: string | undefined;
721
694
  domain?: string | undefined;
722
- expires?: Date | undefined;
723
- httpOnly?: boolean | undefined;
724
- maxAge?: number | undefined;
725
- partitioned?: boolean | undefined;
726
- secure?: boolean | undefined;
727
695
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
728
- 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" ? {
696
+ untrackedEdit: <P extends "name" | "uid" | "path" | "value" | "domain">(uid: string, path: P, value: P extends "name" | "uid" | "path" | "value" | "domain" ? {
729
697
  value: string;
730
698
  uid: string;
731
699
  name: string;
732
- sameSite: "Lax" | "Strict" | "None";
733
700
  path?: string | undefined;
734
701
  domain?: string | undefined;
735
- expires?: Date | undefined;
736
- httpOnly?: boolean | undefined;
737
- maxAge?: number | undefined;
738
- partitioned?: boolean | undefined;
739
- secure?: boolean | undefined;
740
- }[P] : P extends `${infer K}.${infer R}` ? K extends "name" | "uid" | "path" | "value" | "domain" | "sameSite" | "expires" | "httpOnly" | "maxAge" | "partitioned" | "secure" ? R extends Path<{
702
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "name" | "uid" | "path" | "value" | "domain" ? R extends Path<{
741
703
  value: string;
742
704
  uid: string;
743
705
  name: string;
744
- sameSite: "Lax" | "Strict" | "None";
745
706
  path?: string | undefined;
746
707
  domain?: string | undefined;
747
- expires?: Date | undefined;
748
- httpOnly?: boolean | undefined;
749
- maxAge?: number | undefined;
750
- partitioned?: boolean | undefined;
751
- secure?: boolean | undefined;
752
708
  }[K]> ? PathValue<{
753
709
  value: string;
754
710
  uid: string;
755
711
  name: string;
756
- sameSite: "Lax" | "Strict" | "None";
757
712
  path?: string | undefined;
758
713
  domain?: string | undefined;
759
- expires?: Date | undefined;
760
- httpOnly?: boolean | undefined;
761
- maxAge?: number | undefined;
762
- partitioned?: boolean | undefined;
763
- secure?: boolean | undefined;
764
714
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
765
715
  undo: (uid: string) => void;
766
716
  redo: (uid: string) => void;
@@ -1442,7 +1392,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1442
1392
  requestBody?: any;
1443
1393
  responses?: Record<string, any> | undefined;
1444
1394
  }) => void;
1445
- 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" ? {
1395
+ 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" ? {
1446
1396
  path: string;
1447
1397
  type: "request";
1448
1398
  uid: string;
@@ -1557,7 +1507,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1557
1507
  requestBody?: any;
1558
1508
  responses?: Record<string, any> | undefined;
1559
1509
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1560
- 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" ? {
1510
+ 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" ? {
1561
1511
  path: string;
1562
1512
  type: "request";
1563
1513
  uid: string;
@@ -1694,6 +1644,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1694
1644
  required?: boolean | undefined;
1695
1645
  description?: string | undefined;
1696
1646
  enum?: string[] | undefined;
1647
+ examples?: string[] | undefined;
1697
1648
  format?: string | undefined;
1698
1649
  file?: any;
1699
1650
  nullable?: boolean | undefined;
@@ -1709,6 +1660,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1709
1660
  required?: boolean | undefined;
1710
1661
  description?: string | undefined;
1711
1662
  enum?: string[] | undefined;
1663
+ examples?: string[] | undefined;
1712
1664
  format?: string | undefined;
1713
1665
  file?: any;
1714
1666
  nullable?: boolean | undefined;
@@ -1724,6 +1676,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1724
1676
  required?: boolean | undefined;
1725
1677
  description?: string | undefined;
1726
1678
  enum?: string[] | undefined;
1679
+ examples?: string[] | undefined;
1727
1680
  format?: string | undefined;
1728
1681
  file?: any;
1729
1682
  nullable?: boolean | undefined;
@@ -1739,6 +1692,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1739
1692
  required?: boolean | undefined;
1740
1693
  description?: string | undefined;
1741
1694
  enum?: string[] | undefined;
1695
+ examples?: string[] | undefined;
1742
1696
  format?: string | undefined;
1743
1697
  file?: any;
1744
1698
  nullable?: boolean | undefined;
@@ -1759,6 +1713,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1759
1713
  required?: boolean | undefined;
1760
1714
  description?: string | undefined;
1761
1715
  enum?: string[] | undefined;
1716
+ examples?: string[] | undefined;
1762
1717
  format?: string | undefined;
1763
1718
  file?: any;
1764
1719
  nullable?: boolean | undefined;
@@ -1789,6 +1744,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1789
1744
  required?: boolean | undefined;
1790
1745
  description?: string | undefined;
1791
1746
  enum?: string[] | undefined;
1747
+ examples?: string[] | undefined;
1792
1748
  format?: string | undefined;
1793
1749
  file?: any;
1794
1750
  nullable?: boolean | undefined;
@@ -1804,6 +1760,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1804
1760
  required?: boolean | undefined;
1805
1761
  description?: string | undefined;
1806
1762
  enum?: string[] | undefined;
1763
+ examples?: string[] | undefined;
1807
1764
  format?: string | undefined;
1808
1765
  file?: any;
1809
1766
  nullable?: boolean | undefined;
@@ -1819,6 +1776,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1819
1776
  required?: boolean | undefined;
1820
1777
  description?: string | undefined;
1821
1778
  enum?: string[] | undefined;
1779
+ examples?: string[] | undefined;
1822
1780
  format?: string | undefined;
1823
1781
  file?: any;
1824
1782
  nullable?: boolean | undefined;
@@ -1834,6 +1792,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1834
1792
  required?: boolean | undefined;
1835
1793
  description?: string | undefined;
1836
1794
  enum?: string[] | undefined;
1795
+ examples?: string[] | undefined;
1837
1796
  format?: string | undefined;
1838
1797
  file?: any;
1839
1798
  nullable?: boolean | undefined;
@@ -1854,6 +1813,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1854
1813
  required?: boolean | undefined;
1855
1814
  description?: string | undefined;
1856
1815
  enum?: string[] | undefined;
1816
+ examples?: string[] | undefined;
1857
1817
  format?: string | undefined;
1858
1818
  file?: any;
1859
1819
  nullable?: boolean | undefined;
@@ -1885,6 +1845,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1885
1845
  required?: boolean | undefined;
1886
1846
  description?: string | undefined;
1887
1847
  enum?: string[] | undefined;
1848
+ examples?: string[] | undefined;
1888
1849
  format?: string | undefined;
1889
1850
  file?: any;
1890
1851
  nullable?: boolean | undefined;
@@ -1900,6 +1861,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1900
1861
  required?: boolean | undefined;
1901
1862
  description?: string | undefined;
1902
1863
  enum?: string[] | undefined;
1864
+ examples?: string[] | undefined;
1903
1865
  format?: string | undefined;
1904
1866
  file?: any;
1905
1867
  nullable?: boolean | undefined;
@@ -1915,6 +1877,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1915
1877
  required?: boolean | undefined;
1916
1878
  description?: string | undefined;
1917
1879
  enum?: string[] | undefined;
1880
+ examples?: string[] | undefined;
1918
1881
  format?: string | undefined;
1919
1882
  file?: any;
1920
1883
  nullable?: boolean | undefined;
@@ -1930,6 +1893,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1930
1893
  required?: boolean | undefined;
1931
1894
  description?: string | undefined;
1932
1895
  enum?: string[] | undefined;
1896
+ examples?: string[] | undefined;
1933
1897
  format?: string | undefined;
1934
1898
  file?: any;
1935
1899
  nullable?: boolean | undefined;
@@ -1950,6 +1914,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1950
1914
  required?: boolean | undefined;
1951
1915
  description?: string | undefined;
1952
1916
  enum?: string[] | undefined;
1917
+ examples?: string[] | undefined;
1953
1918
  format?: string | undefined;
1954
1919
  file?: any;
1955
1920
  nullable?: boolean | undefined;
@@ -1964,7 +1929,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1964
1929
  requestUid: string;
1965
1930
  serverVariables?: Record<string, string[]> | undefined;
1966
1931
  }) => void;
1967
- 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" ? {
1932
+ 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" ? {
1968
1933
  type: "requestExample";
1969
1934
  uid: string;
1970
1935
  name: string;
@@ -1980,6 +1945,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1980
1945
  required?: boolean | undefined;
1981
1946
  description?: string | undefined;
1982
1947
  enum?: string[] | undefined;
1948
+ examples?: string[] | undefined;
1983
1949
  format?: string | undefined;
1984
1950
  file?: any;
1985
1951
  nullable?: boolean | undefined;
@@ -1995,6 +1961,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
1995
1961
  required?: boolean | undefined;
1996
1962
  description?: string | undefined;
1997
1963
  enum?: string[] | undefined;
1964
+ examples?: string[] | undefined;
1998
1965
  format?: string | undefined;
1999
1966
  file?: any;
2000
1967
  nullable?: boolean | undefined;
@@ -2010,6 +1977,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2010
1977
  required?: boolean | undefined;
2011
1978
  description?: string | undefined;
2012
1979
  enum?: string[] | undefined;
1980
+ examples?: string[] | undefined;
2013
1981
  format?: string | undefined;
2014
1982
  file?: any;
2015
1983
  nullable?: boolean | undefined;
@@ -2025,6 +1993,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2025
1993
  required?: boolean | undefined;
2026
1994
  description?: string | undefined;
2027
1995
  enum?: string[] | undefined;
1996
+ examples?: string[] | undefined;
2028
1997
  format?: string | undefined;
2029
1998
  file?: any;
2030
1999
  nullable?: boolean | undefined;
@@ -2045,6 +2014,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2045
2014
  required?: boolean | undefined;
2046
2015
  description?: string | undefined;
2047
2016
  enum?: string[] | undefined;
2017
+ examples?: string[] | undefined;
2048
2018
  format?: string | undefined;
2049
2019
  file?: any;
2050
2020
  nullable?: boolean | undefined;
@@ -2074,6 +2044,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2074
2044
  required?: boolean | undefined;
2075
2045
  description?: string | undefined;
2076
2046
  enum?: string[] | undefined;
2047
+ examples?: string[] | undefined;
2077
2048
  format?: string | undefined;
2078
2049
  file?: any;
2079
2050
  nullable?: boolean | undefined;
@@ -2089,6 +2060,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2089
2060
  required?: boolean | undefined;
2090
2061
  description?: string | undefined;
2091
2062
  enum?: string[] | undefined;
2063
+ examples?: string[] | undefined;
2092
2064
  format?: string | undefined;
2093
2065
  file?: any;
2094
2066
  nullable?: boolean | undefined;
@@ -2104,6 +2076,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2104
2076
  required?: boolean | undefined;
2105
2077
  description?: string | undefined;
2106
2078
  enum?: string[] | undefined;
2079
+ examples?: string[] | undefined;
2107
2080
  format?: string | undefined;
2108
2081
  file?: any;
2109
2082
  nullable?: boolean | undefined;
@@ -2119,6 +2092,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2119
2092
  required?: boolean | undefined;
2120
2093
  description?: string | undefined;
2121
2094
  enum?: string[] | undefined;
2095
+ examples?: string[] | undefined;
2122
2096
  format?: string | undefined;
2123
2097
  file?: any;
2124
2098
  nullable?: boolean | undefined;
@@ -2139,6 +2113,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2139
2113
  required?: boolean | undefined;
2140
2114
  description?: string | undefined;
2141
2115
  enum?: string[] | undefined;
2116
+ examples?: string[] | undefined;
2142
2117
  format?: string | undefined;
2143
2118
  file?: any;
2144
2119
  nullable?: boolean | undefined;
@@ -2168,6 +2143,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2168
2143
  required?: boolean | undefined;
2169
2144
  description?: string | undefined;
2170
2145
  enum?: string[] | undefined;
2146
+ examples?: string[] | undefined;
2171
2147
  format?: string | undefined;
2172
2148
  file?: any;
2173
2149
  nullable?: boolean | undefined;
@@ -2183,6 +2159,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2183
2159
  required?: boolean | undefined;
2184
2160
  description?: string | undefined;
2185
2161
  enum?: string[] | undefined;
2162
+ examples?: string[] | undefined;
2186
2163
  format?: string | undefined;
2187
2164
  file?: any;
2188
2165
  nullable?: boolean | undefined;
@@ -2198,6 +2175,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2198
2175
  required?: boolean | undefined;
2199
2176
  description?: string | undefined;
2200
2177
  enum?: string[] | undefined;
2178
+ examples?: string[] | undefined;
2201
2179
  format?: string | undefined;
2202
2180
  file?: any;
2203
2181
  nullable?: boolean | undefined;
@@ -2213,6 +2191,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2213
2191
  required?: boolean | undefined;
2214
2192
  description?: string | undefined;
2215
2193
  enum?: string[] | undefined;
2194
+ examples?: string[] | undefined;
2216
2195
  format?: string | undefined;
2217
2196
  file?: any;
2218
2197
  nullable?: boolean | undefined;
@@ -2233,6 +2212,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2233
2212
  required?: boolean | undefined;
2234
2213
  description?: string | undefined;
2235
2214
  enum?: string[] | undefined;
2215
+ examples?: string[] | undefined;
2236
2216
  format?: string | undefined;
2237
2217
  file?: any;
2238
2218
  nullable?: boolean | undefined;
@@ -2247,7 +2227,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2247
2227
  requestUid: string;
2248
2228
  serverVariables?: Record<string, string[]> | undefined;
2249
2229
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
2250
- 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" ? {
2230
+ 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" ? {
2251
2231
  type: "requestExample";
2252
2232
  uid: string;
2253
2233
  name: string;
@@ -2263,6 +2243,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2263
2243
  required?: boolean | undefined;
2264
2244
  description?: string | undefined;
2265
2245
  enum?: string[] | undefined;
2246
+ examples?: string[] | undefined;
2266
2247
  format?: string | undefined;
2267
2248
  file?: any;
2268
2249
  nullable?: boolean | undefined;
@@ -2278,6 +2259,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2278
2259
  required?: boolean | undefined;
2279
2260
  description?: string | undefined;
2280
2261
  enum?: string[] | undefined;
2262
+ examples?: string[] | undefined;
2281
2263
  format?: string | undefined;
2282
2264
  file?: any;
2283
2265
  nullable?: boolean | undefined;
@@ -2293,6 +2275,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2293
2275
  required?: boolean | undefined;
2294
2276
  description?: string | undefined;
2295
2277
  enum?: string[] | undefined;
2278
+ examples?: string[] | undefined;
2296
2279
  format?: string | undefined;
2297
2280
  file?: any;
2298
2281
  nullable?: boolean | undefined;
@@ -2308,6 +2291,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2308
2291
  required?: boolean | undefined;
2309
2292
  description?: string | undefined;
2310
2293
  enum?: string[] | undefined;
2294
+ examples?: string[] | undefined;
2311
2295
  format?: string | undefined;
2312
2296
  file?: any;
2313
2297
  nullable?: boolean | undefined;
@@ -2328,6 +2312,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2328
2312
  required?: boolean | undefined;
2329
2313
  description?: string | undefined;
2330
2314
  enum?: string[] | undefined;
2315
+ examples?: string[] | undefined;
2331
2316
  format?: string | undefined;
2332
2317
  file?: any;
2333
2318
  nullable?: boolean | undefined;
@@ -2357,6 +2342,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2357
2342
  required?: boolean | undefined;
2358
2343
  description?: string | undefined;
2359
2344
  enum?: string[] | undefined;
2345
+ examples?: string[] | undefined;
2360
2346
  format?: string | undefined;
2361
2347
  file?: any;
2362
2348
  nullable?: boolean | undefined;
@@ -2372,6 +2358,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2372
2358
  required?: boolean | undefined;
2373
2359
  description?: string | undefined;
2374
2360
  enum?: string[] | undefined;
2361
+ examples?: string[] | undefined;
2375
2362
  format?: string | undefined;
2376
2363
  file?: any;
2377
2364
  nullable?: boolean | undefined;
@@ -2387,6 +2374,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2387
2374
  required?: boolean | undefined;
2388
2375
  description?: string | undefined;
2389
2376
  enum?: string[] | undefined;
2377
+ examples?: string[] | undefined;
2390
2378
  format?: string | undefined;
2391
2379
  file?: any;
2392
2380
  nullable?: boolean | undefined;
@@ -2402,6 +2390,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2402
2390
  required?: boolean | undefined;
2403
2391
  description?: string | undefined;
2404
2392
  enum?: string[] | undefined;
2393
+ examples?: string[] | undefined;
2405
2394
  format?: string | undefined;
2406
2395
  file?: any;
2407
2396
  nullable?: boolean | undefined;
@@ -2422,6 +2411,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2422
2411
  required?: boolean | undefined;
2423
2412
  description?: string | undefined;
2424
2413
  enum?: string[] | undefined;
2414
+ examples?: string[] | undefined;
2425
2415
  format?: string | undefined;
2426
2416
  file?: any;
2427
2417
  nullable?: boolean | undefined;
@@ -2451,6 +2441,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2451
2441
  required?: boolean | undefined;
2452
2442
  description?: string | undefined;
2453
2443
  enum?: string[] | undefined;
2444
+ examples?: string[] | undefined;
2454
2445
  format?: string | undefined;
2455
2446
  file?: any;
2456
2447
  nullable?: boolean | undefined;
@@ -2466,6 +2457,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2466
2457
  required?: boolean | undefined;
2467
2458
  description?: string | undefined;
2468
2459
  enum?: string[] | undefined;
2460
+ examples?: string[] | undefined;
2469
2461
  format?: string | undefined;
2470
2462
  file?: any;
2471
2463
  nullable?: boolean | undefined;
@@ -2481,6 +2473,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2481
2473
  required?: boolean | undefined;
2482
2474
  description?: string | undefined;
2483
2475
  enum?: string[] | undefined;
2476
+ examples?: string[] | undefined;
2484
2477
  format?: string | undefined;
2485
2478
  file?: any;
2486
2479
  nullable?: boolean | undefined;
@@ -2496,6 +2489,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2496
2489
  required?: boolean | undefined;
2497
2490
  description?: string | undefined;
2498
2491
  enum?: string[] | undefined;
2492
+ examples?: string[] | undefined;
2499
2493
  format?: string | undefined;
2500
2494
  file?: any;
2501
2495
  nullable?: boolean | undefined;
@@ -2516,6 +2510,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
2516
2510
  required?: boolean | undefined;
2517
2511
  description?: string | undefined;
2518
2512
  enum?: string[] | undefined;
2513
+ examples?: string[] | undefined;
2519
2514
  format?: string | undefined;
2520
2515
  file?: any;
2521
2516
  nullable?: boolean | undefined;
@@ -3235,16 +3230,20 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
3235
3230
  uid: string;
3236
3231
  url: string;
3237
3232
  description?: string | undefined;
3238
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3239
- enum?: [string, ...string[]];
3233
+ variables?: Record<string, {
3234
+ default?: string | undefined;
3235
+ description?: string | undefined;
3236
+ enum?: string[] | undefined;
3240
3237
  }> | undefined;
3241
3238
  }) => void;
3242
3239
  add: (payload: import("@scalar/oas-utils/entities/spec").ServerPayload, parentUid: string) => {
3243
3240
  uid: string;
3244
3241
  url: string;
3245
3242
  description?: string | undefined;
3246
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3247
- enum?: [string, ...string[]];
3243
+ variables?: Record<string, {
3244
+ default?: string | undefined;
3245
+ description?: string | undefined;
3246
+ enum?: string[] | undefined;
3248
3247
  }> | undefined;
3249
3248
  };
3250
3249
  delete: (serverUid: string, collectionUid: string) => void;
@@ -3252,52 +3251,66 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
3252
3251
  uid: string;
3253
3252
  url: string;
3254
3253
  description?: string | undefined;
3255
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3256
- enum?: [string, ...string[]];
3254
+ variables?: Record<string, {
3255
+ default?: string | undefined;
3256
+ description?: string | undefined;
3257
+ enum?: string[] | undefined;
3257
3258
  }> | undefined;
3258
3259
  }) => void;
3259
3260
  edit: <P extends "description" | "uid" | "url" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "description" | "uid" | "url" | "variables" ? {
3260
3261
  uid: string;
3261
3262
  url: string;
3262
3263
  description?: string | undefined;
3263
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3264
- enum?: [string, ...string[]];
3264
+ variables?: Record<string, {
3265
+ default?: string | undefined;
3266
+ description?: string | undefined;
3267
+ enum?: string[] | undefined;
3265
3268
  }> | undefined;
3266
3269
  }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "uid" | "url" | "variables" ? R extends Path<{
3267
3270
  uid: string;
3268
3271
  url: string;
3269
3272
  description?: string | undefined;
3270
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3271
- enum?: [string, ...string[]];
3273
+ variables?: Record<string, {
3274
+ default?: string | undefined;
3275
+ description?: string | undefined;
3276
+ enum?: string[] | undefined;
3272
3277
  }> | undefined;
3273
3278
  }[K]> ? PathValue<{
3274
3279
  uid: string;
3275
3280
  url: string;
3276
3281
  description?: string | undefined;
3277
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3278
- enum?: [string, ...string[]];
3282
+ variables?: Record<string, {
3283
+ default?: string | undefined;
3284
+ description?: string | undefined;
3285
+ enum?: string[] | undefined;
3279
3286
  }> | undefined;
3280
3287
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3281
3288
  untrackedEdit: <P extends "description" | "uid" | "url" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "description" | "uid" | "url" | "variables" ? {
3282
3289
  uid: string;
3283
3290
  url: string;
3284
3291
  description?: string | undefined;
3285
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3286
- enum?: [string, ...string[]];
3292
+ variables?: Record<string, {
3293
+ default?: string | undefined;
3294
+ description?: string | undefined;
3295
+ enum?: string[] | undefined;
3287
3296
  }> | undefined;
3288
3297
  }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "uid" | "url" | "variables" ? R extends Path<{
3289
3298
  uid: string;
3290
3299
  url: string;
3291
3300
  description?: string | undefined;
3292
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3293
- enum?: [string, ...string[]];
3301
+ variables?: Record<string, {
3302
+ default?: string | undefined;
3303
+ description?: string | undefined;
3304
+ enum?: string[] | undefined;
3294
3305
  }> | undefined;
3295
3306
  }[K]> ? PathValue<{
3296
3307
  uid: string;
3297
3308
  url: string;
3298
3309
  description?: string | undefined;
3299
- variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
3300
- enum?: [string, ...string[]];
3310
+ variables?: Record<string, {
3311
+ default?: string | undefined;
3312
+ description?: string | undefined;
3313
+ enum?: string[] | undefined;
3301
3314
  }> | undefined;
3302
3315
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3303
3316
  undo: (uid: string) => void;