@scalar/api-client-react 1.1.15 → 1.1.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +35 -0
- package/dist/index.d.ts +99 -85
- package/dist/style.css +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -6,7 +6,6 @@ import { CommandPaletteEvent } from 'node_modules/@scalar/api-client/dist/compon
|
|
|
6
6
|
import { default as default_2 } from 'react';
|
|
7
7
|
import { ErrorResponse } from '@scalar/api-client/libs';
|
|
8
8
|
import { EventBus } from '@scalar/api-client/libs';
|
|
9
|
-
import { OpenAPIV3_1 } from '@scalar/openapi-types';
|
|
10
9
|
import { OpenClientPayload } from '@scalar/api-client/libs';
|
|
11
10
|
import { Path } from '@scalar/object-utils/nested';
|
|
12
11
|
import { PathValue } from '@scalar/object-utils/nested';
|
|
@@ -54,7 +53,7 @@ export declare const useApiClientModal: () => {
|
|
|
54
53
|
propertyKey: P;
|
|
55
54
|
value: NonNullable<PathValue<SecurityScheme, P>>;
|
|
56
55
|
}) => void;
|
|
57
|
-
route: (
|
|
56
|
+
route: (payload?: OpenClientPayload) => void;
|
|
58
57
|
open: (payload?: OpenClientPayload) => void;
|
|
59
58
|
mount: (mountingEl?: HTMLElement | null) => void;
|
|
60
59
|
modalState: {
|
|
@@ -156,14 +155,8 @@ export declare const useApiClientModal: () => {
|
|
|
156
155
|
value: string;
|
|
157
156
|
uid: string;
|
|
158
157
|
name: string;
|
|
159
|
-
sameSite: "Lax" | "Strict" | "None";
|
|
160
158
|
path?: string | undefined;
|
|
161
159
|
domain?: string | undefined;
|
|
162
|
-
expires?: Date | undefined;
|
|
163
|
-
httpOnly?: boolean | undefined;
|
|
164
|
-
maxAge?: number | undefined;
|
|
165
|
-
partitioned?: boolean | undefined;
|
|
166
|
-
secure?: boolean | undefined;
|
|
167
160
|
}>;
|
|
168
161
|
environments: Record<string, {
|
|
169
162
|
value: string;
|
|
@@ -188,6 +181,7 @@ export declare const useApiClientModal: () => {
|
|
|
188
181
|
required?: boolean | undefined;
|
|
189
182
|
description?: string | undefined;
|
|
190
183
|
enum?: string[] | undefined;
|
|
184
|
+
examples?: string[] | undefined;
|
|
191
185
|
format?: string | undefined;
|
|
192
186
|
file?: any;
|
|
193
187
|
nullable?: boolean | undefined;
|
|
@@ -203,6 +197,7 @@ export declare const useApiClientModal: () => {
|
|
|
203
197
|
required?: boolean | undefined;
|
|
204
198
|
description?: string | undefined;
|
|
205
199
|
enum?: string[] | undefined;
|
|
200
|
+
examples?: string[] | undefined;
|
|
206
201
|
format?: string | undefined;
|
|
207
202
|
file?: any;
|
|
208
203
|
nullable?: boolean | undefined;
|
|
@@ -218,6 +213,7 @@ export declare const useApiClientModal: () => {
|
|
|
218
213
|
required?: boolean | undefined;
|
|
219
214
|
description?: string | undefined;
|
|
220
215
|
enum?: string[] | undefined;
|
|
216
|
+
examples?: string[] | undefined;
|
|
221
217
|
format?: string | undefined;
|
|
222
218
|
file?: any;
|
|
223
219
|
nullable?: boolean | undefined;
|
|
@@ -233,6 +229,7 @@ export declare const useApiClientModal: () => {
|
|
|
233
229
|
required?: boolean | undefined;
|
|
234
230
|
description?: string | undefined;
|
|
235
231
|
enum?: string[] | undefined;
|
|
232
|
+
examples?: string[] | undefined;
|
|
236
233
|
format?: string | undefined;
|
|
237
234
|
file?: any;
|
|
238
235
|
nullable?: boolean | undefined;
|
|
@@ -253,6 +250,7 @@ export declare const useApiClientModal: () => {
|
|
|
253
250
|
required?: boolean | undefined;
|
|
254
251
|
description?: string | undefined;
|
|
255
252
|
enum?: string[] | undefined;
|
|
253
|
+
examples?: string[] | undefined;
|
|
256
254
|
format?: string | undefined;
|
|
257
255
|
file?: any;
|
|
258
256
|
nullable?: boolean | undefined;
|
|
@@ -310,8 +308,10 @@ export declare const useApiClientModal: () => {
|
|
|
310
308
|
uid: string;
|
|
311
309
|
url: string;
|
|
312
310
|
description?: string | undefined;
|
|
313
|
-
variables?: Record<string,
|
|
314
|
-
|
|
311
|
+
variables?: Record<string, {
|
|
312
|
+
default?: string | undefined;
|
|
313
|
+
description?: string | undefined;
|
|
314
|
+
enum?: string[] | undefined;
|
|
315
315
|
}> | undefined;
|
|
316
316
|
}>;
|
|
317
317
|
securitySchemes: Record<string, {
|
|
@@ -408,7 +408,6 @@ export declare const useApiClientModal: () => {
|
|
|
408
408
|
sidebarWidth: Ref<string, string>;
|
|
409
409
|
setSidebarWidth: (width: string) => void;
|
|
410
410
|
proxyUrl: string | undefined;
|
|
411
|
-
isReadOnly: boolean;
|
|
412
411
|
hideClientButton: boolean | undefined;
|
|
413
412
|
showSidebar: boolean;
|
|
414
413
|
integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
|
|
@@ -698,102 +697,54 @@ export declare const useApiClientModal: () => {
|
|
|
698
697
|
value: string;
|
|
699
698
|
uid: string;
|
|
700
699
|
name: string;
|
|
701
|
-
sameSite: "Lax" | "Strict" | "None";
|
|
702
700
|
path?: string | undefined;
|
|
703
701
|
domain?: string | undefined;
|
|
704
|
-
expires?: Date | undefined;
|
|
705
|
-
httpOnly?: boolean | undefined;
|
|
706
|
-
maxAge?: number | undefined;
|
|
707
|
-
partitioned?: boolean | undefined;
|
|
708
|
-
secure?: boolean | undefined;
|
|
709
702
|
}) => void;
|
|
710
703
|
delete: (uid: string) => void;
|
|
711
704
|
set: (item: {
|
|
712
705
|
value: string;
|
|
713
706
|
uid: string;
|
|
714
707
|
name: string;
|
|
715
|
-
sameSite: "Lax" | "Strict" | "None";
|
|
716
708
|
path?: string | undefined;
|
|
717
709
|
domain?: string | undefined;
|
|
718
|
-
expires?: Date | undefined;
|
|
719
|
-
httpOnly?: boolean | undefined;
|
|
720
|
-
maxAge?: number | undefined;
|
|
721
|
-
partitioned?: boolean | undefined;
|
|
722
|
-
secure?: boolean | undefined;
|
|
723
710
|
}) => void;
|
|
724
|
-
edit: <P extends "name" | "uid" | "path" | "value" | "domain"
|
|
711
|
+
edit: <P extends "name" | "uid" | "path" | "value" | "domain">(uid: string, path: P, value: P extends "name" | "uid" | "path" | "value" | "domain" ? {
|
|
725
712
|
value: string;
|
|
726
713
|
uid: string;
|
|
727
714
|
name: string;
|
|
728
|
-
sameSite: "Lax" | "Strict" | "None";
|
|
729
715
|
path?: string | undefined;
|
|
730
716
|
domain?: string | undefined;
|
|
731
|
-
|
|
732
|
-
httpOnly?: boolean | undefined;
|
|
733
|
-
maxAge?: number | undefined;
|
|
734
|
-
partitioned?: boolean | undefined;
|
|
735
|
-
secure?: boolean | undefined;
|
|
736
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "name" | "uid" | "path" | "value" | "domain" | "sameSite" | "expires" | "httpOnly" | "maxAge" | "partitioned" | "secure" ? R extends Path< {
|
|
717
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "name" | "uid" | "path" | "value" | "domain" ? R extends Path< {
|
|
737
718
|
value: string;
|
|
738
719
|
uid: string;
|
|
739
720
|
name: string;
|
|
740
|
-
sameSite: "Lax" | "Strict" | "None";
|
|
741
721
|
path?: string | undefined;
|
|
742
722
|
domain?: string | undefined;
|
|
743
|
-
expires?: Date | undefined;
|
|
744
|
-
httpOnly?: boolean | undefined;
|
|
745
|
-
maxAge?: number | undefined;
|
|
746
|
-
partitioned?: boolean | undefined;
|
|
747
|
-
secure?: boolean | undefined;
|
|
748
723
|
}[K]> ? PathValue< {
|
|
749
724
|
value: string;
|
|
750
725
|
uid: string;
|
|
751
726
|
name: string;
|
|
752
|
-
sameSite: "Lax" | "Strict" | "None";
|
|
753
727
|
path?: string | undefined;
|
|
754
728
|
domain?: string | undefined;
|
|
755
|
-
expires?: Date | undefined;
|
|
756
|
-
httpOnly?: boolean | undefined;
|
|
757
|
-
maxAge?: number | undefined;
|
|
758
|
-
partitioned?: boolean | undefined;
|
|
759
|
-
secure?: boolean | undefined;
|
|
760
729
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
761
|
-
untrackedEdit: <P extends "name" | "uid" | "path" | "value" | "domain"
|
|
730
|
+
untrackedEdit: <P extends "name" | "uid" | "path" | "value" | "domain">(uid: string, path: P, value: P extends "name" | "uid" | "path" | "value" | "domain" ? {
|
|
762
731
|
value: string;
|
|
763
732
|
uid: string;
|
|
764
733
|
name: string;
|
|
765
|
-
sameSite: "Lax" | "Strict" | "None";
|
|
766
734
|
path?: string | undefined;
|
|
767
735
|
domain?: string | undefined;
|
|
768
|
-
|
|
769
|
-
httpOnly?: boolean | undefined;
|
|
770
|
-
maxAge?: number | undefined;
|
|
771
|
-
partitioned?: boolean | undefined;
|
|
772
|
-
secure?: boolean | undefined;
|
|
773
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "name" | "uid" | "path" | "value" | "domain" | "sameSite" | "expires" | "httpOnly" | "maxAge" | "partitioned" | "secure" ? R extends Path< {
|
|
736
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "name" | "uid" | "path" | "value" | "domain" ? R extends Path< {
|
|
774
737
|
value: string;
|
|
775
738
|
uid: string;
|
|
776
739
|
name: string;
|
|
777
|
-
sameSite: "Lax" | "Strict" | "None";
|
|
778
740
|
path?: string | undefined;
|
|
779
741
|
domain?: string | undefined;
|
|
780
|
-
expires?: Date | undefined;
|
|
781
|
-
httpOnly?: boolean | undefined;
|
|
782
|
-
maxAge?: number | undefined;
|
|
783
|
-
partitioned?: boolean | undefined;
|
|
784
|
-
secure?: boolean | undefined;
|
|
785
742
|
}[K]> ? PathValue< {
|
|
786
743
|
value: string;
|
|
787
744
|
uid: string;
|
|
788
745
|
name: string;
|
|
789
|
-
sameSite: "Lax" | "Strict" | "None";
|
|
790
746
|
path?: string | undefined;
|
|
791
747
|
domain?: string | undefined;
|
|
792
|
-
expires?: Date | undefined;
|
|
793
|
-
httpOnly?: boolean | undefined;
|
|
794
|
-
maxAge?: number | undefined;
|
|
795
|
-
partitioned?: boolean | undefined;
|
|
796
|
-
secure?: boolean | undefined;
|
|
797
748
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
798
749
|
undo: (uid: string) => void;
|
|
799
750
|
redo: (uid: string) => void;
|
|
@@ -1475,7 +1426,7 @@ export declare const useApiClientModal: () => {
|
|
|
1475
1426
|
requestBody?: any;
|
|
1476
1427
|
responses?: Record<string, any> | undefined;
|
|
1477
1428
|
}) => void;
|
|
1478
|
-
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}.
|
|
1429
|
+
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" ? {
|
|
1479
1430
|
path: string;
|
|
1480
1431
|
type: "request";
|
|
1481
1432
|
uid: string;
|
|
@@ -1590,7 +1541,7 @@ export declare const useApiClientModal: () => {
|
|
|
1590
1541
|
requestBody?: any;
|
|
1591
1542
|
responses?: Record<string, any> | undefined;
|
|
1592
1543
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1593
|
-
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}.
|
|
1544
|
+
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" ? {
|
|
1594
1545
|
path: string;
|
|
1595
1546
|
type: "request";
|
|
1596
1547
|
uid: string;
|
|
@@ -1727,6 +1678,7 @@ export declare const useApiClientModal: () => {
|
|
|
1727
1678
|
required?: boolean | undefined;
|
|
1728
1679
|
description?: string | undefined;
|
|
1729
1680
|
enum?: string[] | undefined;
|
|
1681
|
+
examples?: string[] | undefined;
|
|
1730
1682
|
format?: string | undefined;
|
|
1731
1683
|
file?: any;
|
|
1732
1684
|
nullable?: boolean | undefined;
|
|
@@ -1742,6 +1694,7 @@ export declare const useApiClientModal: () => {
|
|
|
1742
1694
|
required?: boolean | undefined;
|
|
1743
1695
|
description?: string | undefined;
|
|
1744
1696
|
enum?: string[] | undefined;
|
|
1697
|
+
examples?: string[] | undefined;
|
|
1745
1698
|
format?: string | undefined;
|
|
1746
1699
|
file?: any;
|
|
1747
1700
|
nullable?: boolean | undefined;
|
|
@@ -1757,6 +1710,7 @@ export declare const useApiClientModal: () => {
|
|
|
1757
1710
|
required?: boolean | undefined;
|
|
1758
1711
|
description?: string | undefined;
|
|
1759
1712
|
enum?: string[] | undefined;
|
|
1713
|
+
examples?: string[] | undefined;
|
|
1760
1714
|
format?: string | undefined;
|
|
1761
1715
|
file?: any;
|
|
1762
1716
|
nullable?: boolean | undefined;
|
|
@@ -1772,6 +1726,7 @@ export declare const useApiClientModal: () => {
|
|
|
1772
1726
|
required?: boolean | undefined;
|
|
1773
1727
|
description?: string | undefined;
|
|
1774
1728
|
enum?: string[] | undefined;
|
|
1729
|
+
examples?: string[] | undefined;
|
|
1775
1730
|
format?: string | undefined;
|
|
1776
1731
|
file?: any;
|
|
1777
1732
|
nullable?: boolean | undefined;
|
|
@@ -1792,6 +1747,7 @@ export declare const useApiClientModal: () => {
|
|
|
1792
1747
|
required?: boolean | undefined;
|
|
1793
1748
|
description?: string | undefined;
|
|
1794
1749
|
enum?: string[] | undefined;
|
|
1750
|
+
examples?: string[] | undefined;
|
|
1795
1751
|
format?: string | undefined;
|
|
1796
1752
|
file?: any;
|
|
1797
1753
|
nullable?: boolean | undefined;
|
|
@@ -1822,6 +1778,7 @@ export declare const useApiClientModal: () => {
|
|
|
1822
1778
|
required?: boolean | undefined;
|
|
1823
1779
|
description?: string | undefined;
|
|
1824
1780
|
enum?: string[] | undefined;
|
|
1781
|
+
examples?: string[] | undefined;
|
|
1825
1782
|
format?: string | undefined;
|
|
1826
1783
|
file?: any;
|
|
1827
1784
|
nullable?: boolean | undefined;
|
|
@@ -1837,6 +1794,7 @@ export declare const useApiClientModal: () => {
|
|
|
1837
1794
|
required?: boolean | undefined;
|
|
1838
1795
|
description?: string | undefined;
|
|
1839
1796
|
enum?: string[] | undefined;
|
|
1797
|
+
examples?: string[] | undefined;
|
|
1840
1798
|
format?: string | undefined;
|
|
1841
1799
|
file?: any;
|
|
1842
1800
|
nullable?: boolean | undefined;
|
|
@@ -1852,6 +1810,7 @@ export declare const useApiClientModal: () => {
|
|
|
1852
1810
|
required?: boolean | undefined;
|
|
1853
1811
|
description?: string | undefined;
|
|
1854
1812
|
enum?: string[] | undefined;
|
|
1813
|
+
examples?: string[] | undefined;
|
|
1855
1814
|
format?: string | undefined;
|
|
1856
1815
|
file?: any;
|
|
1857
1816
|
nullable?: boolean | undefined;
|
|
@@ -1867,6 +1826,7 @@ export declare const useApiClientModal: () => {
|
|
|
1867
1826
|
required?: boolean | undefined;
|
|
1868
1827
|
description?: string | undefined;
|
|
1869
1828
|
enum?: string[] | undefined;
|
|
1829
|
+
examples?: string[] | undefined;
|
|
1870
1830
|
format?: string | undefined;
|
|
1871
1831
|
file?: any;
|
|
1872
1832
|
nullable?: boolean | undefined;
|
|
@@ -1887,6 +1847,7 @@ export declare const useApiClientModal: () => {
|
|
|
1887
1847
|
required?: boolean | undefined;
|
|
1888
1848
|
description?: string | undefined;
|
|
1889
1849
|
enum?: string[] | undefined;
|
|
1850
|
+
examples?: string[] | undefined;
|
|
1890
1851
|
format?: string | undefined;
|
|
1891
1852
|
file?: any;
|
|
1892
1853
|
nullable?: boolean | undefined;
|
|
@@ -1918,6 +1879,7 @@ export declare const useApiClientModal: () => {
|
|
|
1918
1879
|
required?: boolean | undefined;
|
|
1919
1880
|
description?: string | undefined;
|
|
1920
1881
|
enum?: string[] | undefined;
|
|
1882
|
+
examples?: string[] | undefined;
|
|
1921
1883
|
format?: string | undefined;
|
|
1922
1884
|
file?: any;
|
|
1923
1885
|
nullable?: boolean | undefined;
|
|
@@ -1933,6 +1895,7 @@ export declare const useApiClientModal: () => {
|
|
|
1933
1895
|
required?: boolean | undefined;
|
|
1934
1896
|
description?: string | undefined;
|
|
1935
1897
|
enum?: string[] | undefined;
|
|
1898
|
+
examples?: string[] | undefined;
|
|
1936
1899
|
format?: string | undefined;
|
|
1937
1900
|
file?: any;
|
|
1938
1901
|
nullable?: boolean | undefined;
|
|
@@ -1948,6 +1911,7 @@ export declare const useApiClientModal: () => {
|
|
|
1948
1911
|
required?: boolean | undefined;
|
|
1949
1912
|
description?: string | undefined;
|
|
1950
1913
|
enum?: string[] | undefined;
|
|
1914
|
+
examples?: string[] | undefined;
|
|
1951
1915
|
format?: string | undefined;
|
|
1952
1916
|
file?: any;
|
|
1953
1917
|
nullable?: boolean | undefined;
|
|
@@ -1963,6 +1927,7 @@ export declare const useApiClientModal: () => {
|
|
|
1963
1927
|
required?: boolean | undefined;
|
|
1964
1928
|
description?: string | undefined;
|
|
1965
1929
|
enum?: string[] | undefined;
|
|
1930
|
+
examples?: string[] | undefined;
|
|
1966
1931
|
format?: string | undefined;
|
|
1967
1932
|
file?: any;
|
|
1968
1933
|
nullable?: boolean | undefined;
|
|
@@ -1983,6 +1948,7 @@ export declare const useApiClientModal: () => {
|
|
|
1983
1948
|
required?: boolean | undefined;
|
|
1984
1949
|
description?: string | undefined;
|
|
1985
1950
|
enum?: string[] | undefined;
|
|
1951
|
+
examples?: string[] | undefined;
|
|
1986
1952
|
format?: string | undefined;
|
|
1987
1953
|
file?: any;
|
|
1988
1954
|
nullable?: boolean | undefined;
|
|
@@ -1997,7 +1963,7 @@ export declare const useApiClientModal: () => {
|
|
|
1997
1963
|
requestUid: string;
|
|
1998
1964
|
serverVariables?: Record<string, string[]> | undefined;
|
|
1999
1965
|
}) => void;
|
|
2000
|
-
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" ? {
|
|
1966
|
+
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" ? {
|
|
2001
1967
|
type: "requestExample";
|
|
2002
1968
|
uid: string;
|
|
2003
1969
|
name: string;
|
|
@@ -2013,6 +1979,7 @@ export declare const useApiClientModal: () => {
|
|
|
2013
1979
|
required?: boolean | undefined;
|
|
2014
1980
|
description?: string | undefined;
|
|
2015
1981
|
enum?: string[] | undefined;
|
|
1982
|
+
examples?: string[] | undefined;
|
|
2016
1983
|
format?: string | undefined;
|
|
2017
1984
|
file?: any;
|
|
2018
1985
|
nullable?: boolean | undefined;
|
|
@@ -2028,6 +1995,7 @@ export declare const useApiClientModal: () => {
|
|
|
2028
1995
|
required?: boolean | undefined;
|
|
2029
1996
|
description?: string | undefined;
|
|
2030
1997
|
enum?: string[] | undefined;
|
|
1998
|
+
examples?: string[] | undefined;
|
|
2031
1999
|
format?: string | undefined;
|
|
2032
2000
|
file?: any;
|
|
2033
2001
|
nullable?: boolean | undefined;
|
|
@@ -2043,6 +2011,7 @@ export declare const useApiClientModal: () => {
|
|
|
2043
2011
|
required?: boolean | undefined;
|
|
2044
2012
|
description?: string | undefined;
|
|
2045
2013
|
enum?: string[] | undefined;
|
|
2014
|
+
examples?: string[] | undefined;
|
|
2046
2015
|
format?: string | undefined;
|
|
2047
2016
|
file?: any;
|
|
2048
2017
|
nullable?: boolean | undefined;
|
|
@@ -2058,6 +2027,7 @@ export declare const useApiClientModal: () => {
|
|
|
2058
2027
|
required?: boolean | undefined;
|
|
2059
2028
|
description?: string | undefined;
|
|
2060
2029
|
enum?: string[] | undefined;
|
|
2030
|
+
examples?: string[] | undefined;
|
|
2061
2031
|
format?: string | undefined;
|
|
2062
2032
|
file?: any;
|
|
2063
2033
|
nullable?: boolean | undefined;
|
|
@@ -2078,6 +2048,7 @@ export declare const useApiClientModal: () => {
|
|
|
2078
2048
|
required?: boolean | undefined;
|
|
2079
2049
|
description?: string | undefined;
|
|
2080
2050
|
enum?: string[] | undefined;
|
|
2051
|
+
examples?: string[] | undefined;
|
|
2081
2052
|
format?: string | undefined;
|
|
2082
2053
|
file?: any;
|
|
2083
2054
|
nullable?: boolean | undefined;
|
|
@@ -2107,6 +2078,7 @@ export declare const useApiClientModal: () => {
|
|
|
2107
2078
|
required?: boolean | undefined;
|
|
2108
2079
|
description?: string | undefined;
|
|
2109
2080
|
enum?: string[] | undefined;
|
|
2081
|
+
examples?: string[] | undefined;
|
|
2110
2082
|
format?: string | undefined;
|
|
2111
2083
|
file?: any;
|
|
2112
2084
|
nullable?: boolean | undefined;
|
|
@@ -2122,6 +2094,7 @@ export declare const useApiClientModal: () => {
|
|
|
2122
2094
|
required?: boolean | undefined;
|
|
2123
2095
|
description?: string | undefined;
|
|
2124
2096
|
enum?: string[] | undefined;
|
|
2097
|
+
examples?: string[] | undefined;
|
|
2125
2098
|
format?: string | undefined;
|
|
2126
2099
|
file?: any;
|
|
2127
2100
|
nullable?: boolean | undefined;
|
|
@@ -2137,6 +2110,7 @@ export declare const useApiClientModal: () => {
|
|
|
2137
2110
|
required?: boolean | undefined;
|
|
2138
2111
|
description?: string | undefined;
|
|
2139
2112
|
enum?: string[] | undefined;
|
|
2113
|
+
examples?: string[] | undefined;
|
|
2140
2114
|
format?: string | undefined;
|
|
2141
2115
|
file?: any;
|
|
2142
2116
|
nullable?: boolean | undefined;
|
|
@@ -2152,6 +2126,7 @@ export declare const useApiClientModal: () => {
|
|
|
2152
2126
|
required?: boolean | undefined;
|
|
2153
2127
|
description?: string | undefined;
|
|
2154
2128
|
enum?: string[] | undefined;
|
|
2129
|
+
examples?: string[] | undefined;
|
|
2155
2130
|
format?: string | undefined;
|
|
2156
2131
|
file?: any;
|
|
2157
2132
|
nullable?: boolean | undefined;
|
|
@@ -2172,6 +2147,7 @@ export declare const useApiClientModal: () => {
|
|
|
2172
2147
|
required?: boolean | undefined;
|
|
2173
2148
|
description?: string | undefined;
|
|
2174
2149
|
enum?: string[] | undefined;
|
|
2150
|
+
examples?: string[] | undefined;
|
|
2175
2151
|
format?: string | undefined;
|
|
2176
2152
|
file?: any;
|
|
2177
2153
|
nullable?: boolean | undefined;
|
|
@@ -2201,6 +2177,7 @@ export declare const useApiClientModal: () => {
|
|
|
2201
2177
|
required?: boolean | undefined;
|
|
2202
2178
|
description?: string | undefined;
|
|
2203
2179
|
enum?: string[] | undefined;
|
|
2180
|
+
examples?: string[] | undefined;
|
|
2204
2181
|
format?: string | undefined;
|
|
2205
2182
|
file?: any;
|
|
2206
2183
|
nullable?: boolean | undefined;
|
|
@@ -2216,6 +2193,7 @@ export declare const useApiClientModal: () => {
|
|
|
2216
2193
|
required?: boolean | undefined;
|
|
2217
2194
|
description?: string | undefined;
|
|
2218
2195
|
enum?: string[] | undefined;
|
|
2196
|
+
examples?: string[] | undefined;
|
|
2219
2197
|
format?: string | undefined;
|
|
2220
2198
|
file?: any;
|
|
2221
2199
|
nullable?: boolean | undefined;
|
|
@@ -2231,6 +2209,7 @@ export declare const useApiClientModal: () => {
|
|
|
2231
2209
|
required?: boolean | undefined;
|
|
2232
2210
|
description?: string | undefined;
|
|
2233
2211
|
enum?: string[] | undefined;
|
|
2212
|
+
examples?: string[] | undefined;
|
|
2234
2213
|
format?: string | undefined;
|
|
2235
2214
|
file?: any;
|
|
2236
2215
|
nullable?: boolean | undefined;
|
|
@@ -2246,6 +2225,7 @@ export declare const useApiClientModal: () => {
|
|
|
2246
2225
|
required?: boolean | undefined;
|
|
2247
2226
|
description?: string | undefined;
|
|
2248
2227
|
enum?: string[] | undefined;
|
|
2228
|
+
examples?: string[] | undefined;
|
|
2249
2229
|
format?: string | undefined;
|
|
2250
2230
|
file?: any;
|
|
2251
2231
|
nullable?: boolean | undefined;
|
|
@@ -2266,6 +2246,7 @@ export declare const useApiClientModal: () => {
|
|
|
2266
2246
|
required?: boolean | undefined;
|
|
2267
2247
|
description?: string | undefined;
|
|
2268
2248
|
enum?: string[] | undefined;
|
|
2249
|
+
examples?: string[] | undefined;
|
|
2269
2250
|
format?: string | undefined;
|
|
2270
2251
|
file?: any;
|
|
2271
2252
|
nullable?: boolean | undefined;
|
|
@@ -2280,7 +2261,7 @@ export declare const useApiClientModal: () => {
|
|
|
2280
2261
|
requestUid: string;
|
|
2281
2262
|
serverVariables?: Record<string, string[]> | undefined;
|
|
2282
2263
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2283
|
-
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" ? {
|
|
2264
|
+
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" ? {
|
|
2284
2265
|
type: "requestExample";
|
|
2285
2266
|
uid: string;
|
|
2286
2267
|
name: string;
|
|
@@ -2296,6 +2277,7 @@ export declare const useApiClientModal: () => {
|
|
|
2296
2277
|
required?: boolean | undefined;
|
|
2297
2278
|
description?: string | undefined;
|
|
2298
2279
|
enum?: string[] | undefined;
|
|
2280
|
+
examples?: string[] | undefined;
|
|
2299
2281
|
format?: string | undefined;
|
|
2300
2282
|
file?: any;
|
|
2301
2283
|
nullable?: boolean | undefined;
|
|
@@ -2311,6 +2293,7 @@ export declare const useApiClientModal: () => {
|
|
|
2311
2293
|
required?: boolean | undefined;
|
|
2312
2294
|
description?: string | undefined;
|
|
2313
2295
|
enum?: string[] | undefined;
|
|
2296
|
+
examples?: string[] | undefined;
|
|
2314
2297
|
format?: string | undefined;
|
|
2315
2298
|
file?: any;
|
|
2316
2299
|
nullable?: boolean | undefined;
|
|
@@ -2326,6 +2309,7 @@ export declare const useApiClientModal: () => {
|
|
|
2326
2309
|
required?: boolean | undefined;
|
|
2327
2310
|
description?: string | undefined;
|
|
2328
2311
|
enum?: string[] | undefined;
|
|
2312
|
+
examples?: string[] | undefined;
|
|
2329
2313
|
format?: string | undefined;
|
|
2330
2314
|
file?: any;
|
|
2331
2315
|
nullable?: boolean | undefined;
|
|
@@ -2341,6 +2325,7 @@ export declare const useApiClientModal: () => {
|
|
|
2341
2325
|
required?: boolean | undefined;
|
|
2342
2326
|
description?: string | undefined;
|
|
2343
2327
|
enum?: string[] | undefined;
|
|
2328
|
+
examples?: string[] | undefined;
|
|
2344
2329
|
format?: string | undefined;
|
|
2345
2330
|
file?: any;
|
|
2346
2331
|
nullable?: boolean | undefined;
|
|
@@ -2361,6 +2346,7 @@ export declare const useApiClientModal: () => {
|
|
|
2361
2346
|
required?: boolean | undefined;
|
|
2362
2347
|
description?: string | undefined;
|
|
2363
2348
|
enum?: string[] | undefined;
|
|
2349
|
+
examples?: string[] | undefined;
|
|
2364
2350
|
format?: string | undefined;
|
|
2365
2351
|
file?: any;
|
|
2366
2352
|
nullable?: boolean | undefined;
|
|
@@ -2390,6 +2376,7 @@ export declare const useApiClientModal: () => {
|
|
|
2390
2376
|
required?: boolean | undefined;
|
|
2391
2377
|
description?: string | undefined;
|
|
2392
2378
|
enum?: string[] | undefined;
|
|
2379
|
+
examples?: string[] | undefined;
|
|
2393
2380
|
format?: string | undefined;
|
|
2394
2381
|
file?: any;
|
|
2395
2382
|
nullable?: boolean | undefined;
|
|
@@ -2405,6 +2392,7 @@ export declare const useApiClientModal: () => {
|
|
|
2405
2392
|
required?: boolean | undefined;
|
|
2406
2393
|
description?: string | undefined;
|
|
2407
2394
|
enum?: string[] | undefined;
|
|
2395
|
+
examples?: string[] | undefined;
|
|
2408
2396
|
format?: string | undefined;
|
|
2409
2397
|
file?: any;
|
|
2410
2398
|
nullable?: boolean | undefined;
|
|
@@ -2420,6 +2408,7 @@ export declare const useApiClientModal: () => {
|
|
|
2420
2408
|
required?: boolean | undefined;
|
|
2421
2409
|
description?: string | undefined;
|
|
2422
2410
|
enum?: string[] | undefined;
|
|
2411
|
+
examples?: string[] | undefined;
|
|
2423
2412
|
format?: string | undefined;
|
|
2424
2413
|
file?: any;
|
|
2425
2414
|
nullable?: boolean | undefined;
|
|
@@ -2435,6 +2424,7 @@ export declare const useApiClientModal: () => {
|
|
|
2435
2424
|
required?: boolean | undefined;
|
|
2436
2425
|
description?: string | undefined;
|
|
2437
2426
|
enum?: string[] | undefined;
|
|
2427
|
+
examples?: string[] | undefined;
|
|
2438
2428
|
format?: string | undefined;
|
|
2439
2429
|
file?: any;
|
|
2440
2430
|
nullable?: boolean | undefined;
|
|
@@ -2455,6 +2445,7 @@ export declare const useApiClientModal: () => {
|
|
|
2455
2445
|
required?: boolean | undefined;
|
|
2456
2446
|
description?: string | undefined;
|
|
2457
2447
|
enum?: string[] | undefined;
|
|
2448
|
+
examples?: string[] | undefined;
|
|
2458
2449
|
format?: string | undefined;
|
|
2459
2450
|
file?: any;
|
|
2460
2451
|
nullable?: boolean | undefined;
|
|
@@ -2484,6 +2475,7 @@ export declare const useApiClientModal: () => {
|
|
|
2484
2475
|
required?: boolean | undefined;
|
|
2485
2476
|
description?: string | undefined;
|
|
2486
2477
|
enum?: string[] | undefined;
|
|
2478
|
+
examples?: string[] | undefined;
|
|
2487
2479
|
format?: string | undefined;
|
|
2488
2480
|
file?: any;
|
|
2489
2481
|
nullable?: boolean | undefined;
|
|
@@ -2499,6 +2491,7 @@ export declare const useApiClientModal: () => {
|
|
|
2499
2491
|
required?: boolean | undefined;
|
|
2500
2492
|
description?: string | undefined;
|
|
2501
2493
|
enum?: string[] | undefined;
|
|
2494
|
+
examples?: string[] | undefined;
|
|
2502
2495
|
format?: string | undefined;
|
|
2503
2496
|
file?: any;
|
|
2504
2497
|
nullable?: boolean | undefined;
|
|
@@ -2514,6 +2507,7 @@ export declare const useApiClientModal: () => {
|
|
|
2514
2507
|
required?: boolean | undefined;
|
|
2515
2508
|
description?: string | undefined;
|
|
2516
2509
|
enum?: string[] | undefined;
|
|
2510
|
+
examples?: string[] | undefined;
|
|
2517
2511
|
format?: string | undefined;
|
|
2518
2512
|
file?: any;
|
|
2519
2513
|
nullable?: boolean | undefined;
|
|
@@ -2529,6 +2523,7 @@ export declare const useApiClientModal: () => {
|
|
|
2529
2523
|
required?: boolean | undefined;
|
|
2530
2524
|
description?: string | undefined;
|
|
2531
2525
|
enum?: string[] | undefined;
|
|
2526
|
+
examples?: string[] | undefined;
|
|
2532
2527
|
format?: string | undefined;
|
|
2533
2528
|
file?: any;
|
|
2534
2529
|
nullable?: boolean | undefined;
|
|
@@ -2549,6 +2544,7 @@ export declare const useApiClientModal: () => {
|
|
|
2549
2544
|
required?: boolean | undefined;
|
|
2550
2545
|
description?: string | undefined;
|
|
2551
2546
|
enum?: string[] | undefined;
|
|
2547
|
+
examples?: string[] | undefined;
|
|
2552
2548
|
format?: string | undefined;
|
|
2553
2549
|
file?: any;
|
|
2554
2550
|
nullable?: boolean | undefined;
|
|
@@ -3268,16 +3264,20 @@ export declare const useApiClientModal: () => {
|
|
|
3268
3264
|
uid: string;
|
|
3269
3265
|
url: string;
|
|
3270
3266
|
description?: string | undefined;
|
|
3271
|
-
variables?: Record<string,
|
|
3272
|
-
|
|
3267
|
+
variables?: Record<string, {
|
|
3268
|
+
default?: string | undefined;
|
|
3269
|
+
description?: string | undefined;
|
|
3270
|
+
enum?: string[] | undefined;
|
|
3273
3271
|
}> | undefined;
|
|
3274
3272
|
}) => void;
|
|
3275
3273
|
add: (payload: ServerPayload, parentUid: string) => {
|
|
3276
3274
|
uid: string;
|
|
3277
3275
|
url: string;
|
|
3278
3276
|
description?: string | undefined;
|
|
3279
|
-
variables?: Record<string,
|
|
3280
|
-
|
|
3277
|
+
variables?: Record<string, {
|
|
3278
|
+
default?: string | undefined;
|
|
3279
|
+
description?: string | undefined;
|
|
3280
|
+
enum?: string[] | undefined;
|
|
3281
3281
|
}> | undefined;
|
|
3282
3282
|
};
|
|
3283
3283
|
delete: (serverUid: string, collectionUid: string) => void;
|
|
@@ -3285,52 +3285,66 @@ export declare const useApiClientModal: () => {
|
|
|
3285
3285
|
uid: string;
|
|
3286
3286
|
url: string;
|
|
3287
3287
|
description?: string | undefined;
|
|
3288
|
-
variables?: Record<string,
|
|
3289
|
-
|
|
3288
|
+
variables?: Record<string, {
|
|
3289
|
+
default?: string | undefined;
|
|
3290
|
+
description?: string | undefined;
|
|
3291
|
+
enum?: string[] | undefined;
|
|
3290
3292
|
}> | undefined;
|
|
3291
3293
|
}) => void;
|
|
3292
3294
|
edit: <P extends "description" | "uid" | "url" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "description" | "uid" | "url" | "variables" ? {
|
|
3293
3295
|
uid: string;
|
|
3294
3296
|
url: string;
|
|
3295
3297
|
description?: string | undefined;
|
|
3296
|
-
variables?: Record<string,
|
|
3297
|
-
|
|
3298
|
+
variables?: Record<string, {
|
|
3299
|
+
default?: string | undefined;
|
|
3300
|
+
description?: string | undefined;
|
|
3301
|
+
enum?: string[] | undefined;
|
|
3298
3302
|
}> | undefined;
|
|
3299
3303
|
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "uid" | "url" | "variables" ? R extends Path< {
|
|
3300
3304
|
uid: string;
|
|
3301
3305
|
url: string;
|
|
3302
3306
|
description?: string | undefined;
|
|
3303
|
-
variables?: Record<string,
|
|
3304
|
-
|
|
3307
|
+
variables?: Record<string, {
|
|
3308
|
+
default?: string | undefined;
|
|
3309
|
+
description?: string | undefined;
|
|
3310
|
+
enum?: string[] | undefined;
|
|
3305
3311
|
}> | undefined;
|
|
3306
3312
|
}[K]> ? PathValue< {
|
|
3307
3313
|
uid: string;
|
|
3308
3314
|
url: string;
|
|
3309
3315
|
description?: string | undefined;
|
|
3310
|
-
variables?: Record<string,
|
|
3311
|
-
|
|
3316
|
+
variables?: Record<string, {
|
|
3317
|
+
default?: string | undefined;
|
|
3318
|
+
description?: string | undefined;
|
|
3319
|
+
enum?: string[] | undefined;
|
|
3312
3320
|
}> | undefined;
|
|
3313
3321
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3314
3322
|
untrackedEdit: <P extends "description" | "uid" | "url" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "description" | "uid" | "url" | "variables" ? {
|
|
3315
3323
|
uid: string;
|
|
3316
3324
|
url: string;
|
|
3317
3325
|
description?: string | undefined;
|
|
3318
|
-
variables?: Record<string,
|
|
3319
|
-
|
|
3326
|
+
variables?: Record<string, {
|
|
3327
|
+
default?: string | undefined;
|
|
3328
|
+
description?: string | undefined;
|
|
3329
|
+
enum?: string[] | undefined;
|
|
3320
3330
|
}> | undefined;
|
|
3321
3331
|
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "uid" | "url" | "variables" ? R extends Path< {
|
|
3322
3332
|
uid: string;
|
|
3323
3333
|
url: string;
|
|
3324
3334
|
description?: string | undefined;
|
|
3325
|
-
variables?: Record<string,
|
|
3326
|
-
|
|
3335
|
+
variables?: Record<string, {
|
|
3336
|
+
default?: string | undefined;
|
|
3337
|
+
description?: string | undefined;
|
|
3338
|
+
enum?: string[] | undefined;
|
|
3327
3339
|
}> | undefined;
|
|
3328
3340
|
}[K]> ? PathValue< {
|
|
3329
3341
|
uid: string;
|
|
3330
3342
|
url: string;
|
|
3331
3343
|
description?: string | undefined;
|
|
3332
|
-
variables?: Record<string,
|
|
3333
|
-
|
|
3344
|
+
variables?: Record<string, {
|
|
3345
|
+
default?: string | undefined;
|
|
3346
|
+
description?: string | undefined;
|
|
3347
|
+
enum?: string[] | undefined;
|
|
3334
3348
|
}> | undefined;
|
|
3335
3349
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3336
3350
|
undo: (uid: string) => void;
|