@scalar/api-reference 1.28.23 → 1.28.25
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 +51 -0
- package/dist/browser/standalone.js +5904 -5810
- package/dist/browser/webpack-stats.json +1 -1
- package/dist/components/Content/ClientLibraries/ClientLibraries.vue.d.ts.map +1 -1
- package/dist/components/Content/ClientLibraries/ClientLibraries.vue.js +2 -2
- package/dist/components/Content/ClientLibraries/ClientLibraries.vue2.js +100 -57
- package/dist/components/Content/Introduction/Introduction.vue.d.ts.map +1 -1
- package/dist/components/Content/Introduction/Introduction.vue.js +1 -1
- package/dist/components/Content/Introduction/Introduction.vue2.js +43 -42
- package/dist/components/Content/Schema/SchemaDiscriminator.vue.js +1 -1
- package/dist/components/SpecificationExtension/SpecificationExtension.vue.d.ts.map +1 -1
- package/dist/components/SpecificationExtension/SpecificationExtension.vue.js +26 -21
- package/dist/features/ApiClientModal/ApiClientModal.vue.d.ts.map +1 -1
- package/dist/features/ApiClientModal/ApiClientModal.vue.js +35 -31
- package/dist/features/ApiClientModal/useApiClient.d.ts +122 -22
- package/dist/features/ApiClientModal/useApiClient.d.ts.map +1 -1
- package/dist/helpers/get-request.d.ts.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/standalone/lib/html-api.d.ts +1 -20
- package/dist/standalone/lib/html-api.d.ts.map +1 -1
- package/dist/standalone/lib/html-api.js +11 -11
- package/dist/standalone/lib/register-globals.d.ts +1 -1
- package/dist/standalone/lib/register-globals.d.ts.map +1 -1
- package/dist/style.css +1 -1
- package/package.json +10 -9
|
@@ -5,7 +5,7 @@ declare const client: import("vue").Ref<{
|
|
|
5
5
|
onUpdateServer: (callback: (url: string) => void) => void;
|
|
6
6
|
updateServer: (serverUrl: string) => void;
|
|
7
7
|
open: (payload?: import("@scalar/api-client/libs").OpenClientPayload) => void;
|
|
8
|
-
updateConfig: (_newConfig: Partial<import("@scalar/types
|
|
8
|
+
updateConfig: (_newConfig: Partial<import("@scalar/types").ApiClientConfiguration>) => Promise<void>;
|
|
9
9
|
updateAuth: <P extends import("@scalar/object-utils/nested").Path<import("@scalar/types/entities").SecurityScheme>>({ nameKey, propertyKey, value, }: {
|
|
10
10
|
nameKey: string;
|
|
11
11
|
propertyKey: P;
|
|
@@ -314,6 +314,11 @@ declare const client: import("vue").Ref<{
|
|
|
314
314
|
identifier?: string | undefined;
|
|
315
315
|
url?: string | undefined;
|
|
316
316
|
} | undefined;
|
|
317
|
+
"x-scalar-sdk-installation"?: {
|
|
318
|
+
lang: string;
|
|
319
|
+
description?: string | undefined;
|
|
320
|
+
source?: string | undefined;
|
|
321
|
+
}[] | undefined;
|
|
317
322
|
};
|
|
318
323
|
security: Record<string, string[]>[];
|
|
319
324
|
"x-scalar-icon": string;
|
|
@@ -1436,10 +1441,10 @@ declare const client: import("vue").Ref<{
|
|
|
1436
1441
|
integration?: string | null | undefined;
|
|
1437
1442
|
useCollectionSecurity?: boolean | undefined;
|
|
1438
1443
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
1439
|
-
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types
|
|
1444
|
+
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
1440
1445
|
useCollectionSecurity?: boolean;
|
|
1441
1446
|
shouldLoad?: boolean;
|
|
1442
|
-
} & Pick<import("@scalar/types
|
|
1447
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">) => Promise<{
|
|
1443
1448
|
error: false;
|
|
1444
1449
|
collection: import("@scalar/oas-utils/entities/spec").Collection;
|
|
1445
1450
|
requests: import("@scalar/oas-utils/entities/spec").Request[];
|
|
@@ -1488,10 +1493,10 @@ declare const client: import("vue").Ref<{
|
|
|
1488
1493
|
integration?: string | null | undefined;
|
|
1489
1494
|
useCollectionSecurity?: boolean | undefined;
|
|
1490
1495
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
1491
|
-
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types
|
|
1496
|
+
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
1492
1497
|
useCollectionSecurity?: boolean;
|
|
1493
1498
|
shouldLoad?: boolean;
|
|
1494
|
-
} & Pick<import("@scalar/types
|
|
1499
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">, "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "proxyUrl">) => Promise<import("@scalar/api-client/libs").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
|
|
1495
1500
|
uid?: string | undefined;
|
|
1496
1501
|
type?: "collection" | undefined;
|
|
1497
1502
|
externalDocs?: {
|
|
@@ -1530,10 +1535,10 @@ declare const client: import("vue").Ref<{
|
|
|
1530
1535
|
integration?: string | null | undefined;
|
|
1531
1536
|
useCollectionSecurity?: boolean | undefined;
|
|
1532
1537
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
1533
|
-
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types
|
|
1538
|
+
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
1534
1539
|
useCollectionSecurity?: boolean;
|
|
1535
1540
|
shouldLoad?: boolean;
|
|
1536
|
-
} & Pick<import("@scalar/types
|
|
1541
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">) => Promise<{
|
|
1537
1542
|
error: false;
|
|
1538
1543
|
collection: import("@scalar/oas-utils/entities/spec").Collection;
|
|
1539
1544
|
requests: import("@scalar/oas-utils/entities/spec").Request[];
|
|
@@ -1623,6 +1628,11 @@ declare const client: import("vue").Ref<{
|
|
|
1623
1628
|
identifier?: string | undefined;
|
|
1624
1629
|
url?: string | undefined;
|
|
1625
1630
|
} | undefined;
|
|
1631
|
+
"x-scalar-sdk-installation"?: {
|
|
1632
|
+
lang: string;
|
|
1633
|
+
description?: string | undefined;
|
|
1634
|
+
source?: string | undefined;
|
|
1635
|
+
}[] | undefined;
|
|
1626
1636
|
};
|
|
1627
1637
|
security: Record<string, string[]>[];
|
|
1628
1638
|
"x-scalar-icon": string;
|
|
@@ -1679,6 +1689,11 @@ declare const client: import("vue").Ref<{
|
|
|
1679
1689
|
identifier?: string | undefined;
|
|
1680
1690
|
url?: string | undefined;
|
|
1681
1691
|
} | undefined;
|
|
1692
|
+
"x-scalar-sdk-installation"?: {
|
|
1693
|
+
lang: string;
|
|
1694
|
+
description?: string | undefined;
|
|
1695
|
+
source?: string | undefined;
|
|
1696
|
+
}[] | undefined;
|
|
1682
1697
|
};
|
|
1683
1698
|
security: Record<string, string[]>[];
|
|
1684
1699
|
"x-scalar-icon": string;
|
|
@@ -1738,6 +1753,11 @@ declare const client: import("vue").Ref<{
|
|
|
1738
1753
|
identifier?: string | undefined;
|
|
1739
1754
|
url?: string | undefined;
|
|
1740
1755
|
} | undefined;
|
|
1756
|
+
"x-scalar-sdk-installation"?: {
|
|
1757
|
+
lang: string;
|
|
1758
|
+
description?: string | undefined;
|
|
1759
|
+
source?: string | undefined;
|
|
1760
|
+
}[] | undefined;
|
|
1741
1761
|
};
|
|
1742
1762
|
security: Record<string, string[]>[];
|
|
1743
1763
|
"x-scalar-icon": string;
|
|
@@ -1773,7 +1793,7 @@ declare const client: import("vue").Ref<{
|
|
|
1773
1793
|
documentUrl?: string | undefined;
|
|
1774
1794
|
integration?: string | null | undefined;
|
|
1775
1795
|
}) => void;
|
|
1776
|
-
edit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.title" | "info.summary" | "info.description" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: (string & import("zod").BRAND<"collection">) | null | undefined, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
|
|
1796
|
+
edit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.title" | "info.summary" | "info.description" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.x-scalar-sdk-installation" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `info.x-scalar-sdk-installation.${number}` | `info.x-scalar-sdk-installation.${number}.description` | `info.x-scalar-sdk-installation.${number}.lang` | `info.x-scalar-sdk-installation.${number}.source` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: (string & import("zod").BRAND<"collection">) | null | undefined, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
|
|
1777
1797
|
uid: string & import("zod").BRAND<"collection">;
|
|
1778
1798
|
type: "collection";
|
|
1779
1799
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -1794,6 +1814,11 @@ declare const client: import("vue").Ref<{
|
|
|
1794
1814
|
identifier?: string | undefined;
|
|
1795
1815
|
url?: string | undefined;
|
|
1796
1816
|
} | undefined;
|
|
1817
|
+
"x-scalar-sdk-installation"?: {
|
|
1818
|
+
lang: string;
|
|
1819
|
+
description?: string | undefined;
|
|
1820
|
+
source?: string | undefined;
|
|
1821
|
+
}[] | undefined;
|
|
1797
1822
|
};
|
|
1798
1823
|
security: Record<string, string[]>[];
|
|
1799
1824
|
"x-scalar-icon": string;
|
|
@@ -1849,6 +1874,11 @@ declare const client: import("vue").Ref<{
|
|
|
1849
1874
|
identifier?: string | undefined;
|
|
1850
1875
|
url?: string | undefined;
|
|
1851
1876
|
} | undefined;
|
|
1877
|
+
"x-scalar-sdk-installation"?: {
|
|
1878
|
+
lang: string;
|
|
1879
|
+
description?: string | undefined;
|
|
1880
|
+
source?: string | undefined;
|
|
1881
|
+
}[] | undefined;
|
|
1852
1882
|
};
|
|
1853
1883
|
security: Record<string, string[]>[];
|
|
1854
1884
|
"x-scalar-icon": string;
|
|
@@ -1904,6 +1934,11 @@ declare const client: import("vue").Ref<{
|
|
|
1904
1934
|
identifier?: string | undefined;
|
|
1905
1935
|
url?: string | undefined;
|
|
1906
1936
|
} | undefined;
|
|
1937
|
+
"x-scalar-sdk-installation"?: {
|
|
1938
|
+
lang: string;
|
|
1939
|
+
description?: string | undefined;
|
|
1940
|
+
source?: string | undefined;
|
|
1941
|
+
}[] | undefined;
|
|
1907
1942
|
};
|
|
1908
1943
|
security: Record<string, string[]>[];
|
|
1909
1944
|
"x-scalar-icon": string;
|
|
@@ -1939,7 +1974,7 @@ declare const client: import("vue").Ref<{
|
|
|
1939
1974
|
documentUrl?: string | undefined;
|
|
1940
1975
|
integration?: string | null | undefined;
|
|
1941
1976
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1942
|
-
untrackedEdit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.title" | "info.summary" | "info.description" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string & import("zod").BRAND<"collection">, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
|
|
1977
|
+
untrackedEdit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.title" | "info.summary" | "info.description" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.x-scalar-sdk-installation" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `info.x-scalar-sdk-installation.${number}` | `info.x-scalar-sdk-installation.${number}.description` | `info.x-scalar-sdk-installation.${number}.lang` | `info.x-scalar-sdk-installation.${number}.source` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string & import("zod").BRAND<"collection">, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
|
|
1943
1978
|
uid: string & import("zod").BRAND<"collection">;
|
|
1944
1979
|
type: "collection";
|
|
1945
1980
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -1960,6 +1995,11 @@ declare const client: import("vue").Ref<{
|
|
|
1960
1995
|
identifier?: string | undefined;
|
|
1961
1996
|
url?: string | undefined;
|
|
1962
1997
|
} | undefined;
|
|
1998
|
+
"x-scalar-sdk-installation"?: {
|
|
1999
|
+
lang: string;
|
|
2000
|
+
description?: string | undefined;
|
|
2001
|
+
source?: string | undefined;
|
|
2002
|
+
}[] | undefined;
|
|
1963
2003
|
};
|
|
1964
2004
|
security: Record<string, string[]>[];
|
|
1965
2005
|
"x-scalar-icon": string;
|
|
@@ -2015,6 +2055,11 @@ declare const client: import("vue").Ref<{
|
|
|
2015
2055
|
identifier?: string | undefined;
|
|
2016
2056
|
url?: string | undefined;
|
|
2017
2057
|
} | undefined;
|
|
2058
|
+
"x-scalar-sdk-installation"?: {
|
|
2059
|
+
lang: string;
|
|
2060
|
+
description?: string | undefined;
|
|
2061
|
+
source?: string | undefined;
|
|
2062
|
+
}[] | undefined;
|
|
2018
2063
|
};
|
|
2019
2064
|
security: Record<string, string[]>[];
|
|
2020
2065
|
"x-scalar-icon": string;
|
|
@@ -2070,6 +2115,11 @@ declare const client: import("vue").Ref<{
|
|
|
2070
2115
|
identifier?: string | undefined;
|
|
2071
2116
|
url?: string | undefined;
|
|
2072
2117
|
} | undefined;
|
|
2118
|
+
"x-scalar-sdk-installation"?: {
|
|
2119
|
+
lang: string;
|
|
2120
|
+
description?: string | undefined;
|
|
2121
|
+
source?: string | undefined;
|
|
2122
|
+
}[] | undefined;
|
|
2073
2123
|
};
|
|
2074
2124
|
security: Record<string, string[]>[];
|
|
2075
2125
|
"x-scalar-icon": string;
|
|
@@ -2334,7 +2384,7 @@ declare const client: import("vue").Ref<{
|
|
|
2334
2384
|
}[] | undefined;
|
|
2335
2385
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
2336
2386
|
}) => void;
|
|
2337
|
-
edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.
|
|
2387
|
+
edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.lang` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.label` | `x-code-samples.${number}` | `x-code-samples.${number}.lang` | `x-code-samples.${number}.source` | `x-code-samples.${number}.label` | `x-custom-examples.${number}` | `x-custom-examples.${number}.lang` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.label`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "examples" ? {
|
|
2338
2388
|
uid: string & import("zod").BRAND<"operation">;
|
|
2339
2389
|
path: string;
|
|
2340
2390
|
type: "request";
|
|
@@ -2497,7 +2547,7 @@ declare const client: import("vue").Ref<{
|
|
|
2497
2547
|
}[] | undefined;
|
|
2498
2548
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
2499
2549
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2500
|
-
untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.
|
|
2550
|
+
untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.lang` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.label` | `x-code-samples.${number}` | `x-code-samples.${number}.lang` | `x-code-samples.${number}.source` | `x-code-samples.${number}.label` | `x-custom-examples.${number}` | `x-custom-examples.${number}.lang` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.label`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "examples" ? {
|
|
2501
2551
|
uid: string & import("zod").BRAND<"operation">;
|
|
2502
2552
|
path: string;
|
|
2503
2553
|
type: "request";
|
|
@@ -3722,7 +3772,7 @@ declare const client: import("vue").Ref<{
|
|
|
3722
3772
|
onUpdateServer: (callback: (url: string) => void) => void;
|
|
3723
3773
|
updateServer: (serverUrl: string) => void;
|
|
3724
3774
|
open: (payload?: import("@scalar/api-client/libs").OpenClientPayload) => void;
|
|
3725
|
-
updateConfig: (_newConfig: Partial<import("@scalar/types
|
|
3775
|
+
updateConfig: (_newConfig: Partial<import("@scalar/types").ApiClientConfiguration>) => Promise<void>;
|
|
3726
3776
|
updateAuth: <P extends import("@scalar/object-utils/nested").Path<import("@scalar/types/entities").SecurityScheme>>({ nameKey, propertyKey, value, }: {
|
|
3727
3777
|
nameKey: string;
|
|
3728
3778
|
propertyKey: P;
|
|
@@ -4031,6 +4081,11 @@ declare const client: import("vue").Ref<{
|
|
|
4031
4081
|
identifier?: string | undefined;
|
|
4032
4082
|
url?: string | undefined;
|
|
4033
4083
|
} | undefined;
|
|
4084
|
+
"x-scalar-sdk-installation"?: {
|
|
4085
|
+
lang: string;
|
|
4086
|
+
description?: string | undefined;
|
|
4087
|
+
source?: string | undefined;
|
|
4088
|
+
}[] | undefined;
|
|
4034
4089
|
};
|
|
4035
4090
|
security: Record<string, string[]>[];
|
|
4036
4091
|
"x-scalar-icon": string;
|
|
@@ -5153,10 +5208,10 @@ declare const client: import("vue").Ref<{
|
|
|
5153
5208
|
integration?: string | null | undefined;
|
|
5154
5209
|
useCollectionSecurity?: boolean | undefined;
|
|
5155
5210
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
5156
|
-
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types
|
|
5211
|
+
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
5157
5212
|
useCollectionSecurity?: boolean;
|
|
5158
5213
|
shouldLoad?: boolean;
|
|
5159
|
-
} & Pick<import("@scalar/types
|
|
5214
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">) => Promise<{
|
|
5160
5215
|
error: false;
|
|
5161
5216
|
collection: import("@scalar/oas-utils/entities/spec").Collection;
|
|
5162
5217
|
requests: import("@scalar/oas-utils/entities/spec").Request[];
|
|
@@ -5205,10 +5260,10 @@ declare const client: import("vue").Ref<{
|
|
|
5205
5260
|
integration?: string | null | undefined;
|
|
5206
5261
|
useCollectionSecurity?: boolean | undefined;
|
|
5207
5262
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
5208
|
-
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types
|
|
5263
|
+
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
5209
5264
|
useCollectionSecurity?: boolean;
|
|
5210
5265
|
shouldLoad?: boolean;
|
|
5211
|
-
} & Pick<import("@scalar/types
|
|
5266
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">, "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "proxyUrl">) => Promise<import("@scalar/api-client/libs").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
|
|
5212
5267
|
uid?: string | undefined;
|
|
5213
5268
|
type?: "collection" | undefined;
|
|
5214
5269
|
externalDocs?: {
|
|
@@ -5247,10 +5302,10 @@ declare const client: import("vue").Ref<{
|
|
|
5247
5302
|
integration?: string | null | undefined;
|
|
5248
5303
|
useCollectionSecurity?: boolean | undefined;
|
|
5249
5304
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
5250
|
-
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types
|
|
5305
|
+
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
5251
5306
|
useCollectionSecurity?: boolean;
|
|
5252
5307
|
shouldLoad?: boolean;
|
|
5253
|
-
} & Pick<import("@scalar/types
|
|
5308
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">) => Promise<{
|
|
5254
5309
|
error: false;
|
|
5255
5310
|
collection: import("@scalar/oas-utils/entities/spec").Collection;
|
|
5256
5311
|
requests: import("@scalar/oas-utils/entities/spec").Request[];
|
|
@@ -5340,6 +5395,11 @@ declare const client: import("vue").Ref<{
|
|
|
5340
5395
|
identifier?: string | undefined;
|
|
5341
5396
|
url?: string | undefined;
|
|
5342
5397
|
} | undefined;
|
|
5398
|
+
"x-scalar-sdk-installation"?: {
|
|
5399
|
+
lang: string;
|
|
5400
|
+
description?: string | undefined;
|
|
5401
|
+
source?: string | undefined;
|
|
5402
|
+
}[] | undefined;
|
|
5343
5403
|
};
|
|
5344
5404
|
security: Record<string, string[]>[];
|
|
5345
5405
|
"x-scalar-icon": string;
|
|
@@ -5396,6 +5456,11 @@ declare const client: import("vue").Ref<{
|
|
|
5396
5456
|
identifier?: string | undefined;
|
|
5397
5457
|
url?: string | undefined;
|
|
5398
5458
|
} | undefined;
|
|
5459
|
+
"x-scalar-sdk-installation"?: {
|
|
5460
|
+
lang: string;
|
|
5461
|
+
description?: string | undefined;
|
|
5462
|
+
source?: string | undefined;
|
|
5463
|
+
}[] | undefined;
|
|
5399
5464
|
};
|
|
5400
5465
|
security: Record<string, string[]>[];
|
|
5401
5466
|
"x-scalar-icon": string;
|
|
@@ -5455,6 +5520,11 @@ declare const client: import("vue").Ref<{
|
|
|
5455
5520
|
identifier?: string | undefined;
|
|
5456
5521
|
url?: string | undefined;
|
|
5457
5522
|
} | undefined;
|
|
5523
|
+
"x-scalar-sdk-installation"?: {
|
|
5524
|
+
lang: string;
|
|
5525
|
+
description?: string | undefined;
|
|
5526
|
+
source?: string | undefined;
|
|
5527
|
+
}[] | undefined;
|
|
5458
5528
|
};
|
|
5459
5529
|
security: Record<string, string[]>[];
|
|
5460
5530
|
"x-scalar-icon": string;
|
|
@@ -5490,7 +5560,7 @@ declare const client: import("vue").Ref<{
|
|
|
5490
5560
|
documentUrl?: string | undefined;
|
|
5491
5561
|
integration?: string | null | undefined;
|
|
5492
5562
|
}) => void;
|
|
5493
|
-
edit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.title" | "info.summary" | "info.description" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: (string & import("zod").BRAND<"collection">) | null | undefined, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
|
|
5563
|
+
edit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.title" | "info.summary" | "info.description" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.x-scalar-sdk-installation" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `info.x-scalar-sdk-installation.${number}` | `info.x-scalar-sdk-installation.${number}.description` | `info.x-scalar-sdk-installation.${number}.lang` | `info.x-scalar-sdk-installation.${number}.source` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: (string & import("zod").BRAND<"collection">) | null | undefined, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
|
|
5494
5564
|
uid: string & import("zod").BRAND<"collection">;
|
|
5495
5565
|
type: "collection";
|
|
5496
5566
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -5511,6 +5581,11 @@ declare const client: import("vue").Ref<{
|
|
|
5511
5581
|
identifier?: string | undefined;
|
|
5512
5582
|
url?: string | undefined;
|
|
5513
5583
|
} | undefined;
|
|
5584
|
+
"x-scalar-sdk-installation"?: {
|
|
5585
|
+
lang: string;
|
|
5586
|
+
description?: string | undefined;
|
|
5587
|
+
source?: string | undefined;
|
|
5588
|
+
}[] | undefined;
|
|
5514
5589
|
};
|
|
5515
5590
|
security: Record<string, string[]>[];
|
|
5516
5591
|
"x-scalar-icon": string;
|
|
@@ -5566,6 +5641,11 @@ declare const client: import("vue").Ref<{
|
|
|
5566
5641
|
identifier?: string | undefined;
|
|
5567
5642
|
url?: string | undefined;
|
|
5568
5643
|
} | undefined;
|
|
5644
|
+
"x-scalar-sdk-installation"?: {
|
|
5645
|
+
lang: string;
|
|
5646
|
+
description?: string | undefined;
|
|
5647
|
+
source?: string | undefined;
|
|
5648
|
+
}[] | undefined;
|
|
5569
5649
|
};
|
|
5570
5650
|
security: Record<string, string[]>[];
|
|
5571
5651
|
"x-scalar-icon": string;
|
|
@@ -5621,6 +5701,11 @@ declare const client: import("vue").Ref<{
|
|
|
5621
5701
|
identifier?: string | undefined;
|
|
5622
5702
|
url?: string | undefined;
|
|
5623
5703
|
} | undefined;
|
|
5704
|
+
"x-scalar-sdk-installation"?: {
|
|
5705
|
+
lang: string;
|
|
5706
|
+
description?: string | undefined;
|
|
5707
|
+
source?: string | undefined;
|
|
5708
|
+
}[] | undefined;
|
|
5624
5709
|
};
|
|
5625
5710
|
security: Record<string, string[]>[];
|
|
5626
5711
|
"x-scalar-icon": string;
|
|
@@ -5656,7 +5741,7 @@ declare const client: import("vue").Ref<{
|
|
|
5656
5741
|
documentUrl?: string | undefined;
|
|
5657
5742
|
integration?: string | null | undefined;
|
|
5658
5743
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
5659
|
-
untrackedEdit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.title" | "info.summary" | "info.description" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string & import("zod").BRAND<"collection">, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
|
|
5744
|
+
untrackedEdit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.title" | "info.summary" | "info.description" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.x-scalar-sdk-installation" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `info.x-scalar-sdk-installation.${number}` | `info.x-scalar-sdk-installation.${number}.description` | `info.x-scalar-sdk-installation.${number}.lang` | `info.x-scalar-sdk-installation.${number}.source` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string & import("zod").BRAND<"collection">, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
|
|
5660
5745
|
uid: string & import("zod").BRAND<"collection">;
|
|
5661
5746
|
type: "collection";
|
|
5662
5747
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -5677,6 +5762,11 @@ declare const client: import("vue").Ref<{
|
|
|
5677
5762
|
identifier?: string | undefined;
|
|
5678
5763
|
url?: string | undefined;
|
|
5679
5764
|
} | undefined;
|
|
5765
|
+
"x-scalar-sdk-installation"?: {
|
|
5766
|
+
lang: string;
|
|
5767
|
+
description?: string | undefined;
|
|
5768
|
+
source?: string | undefined;
|
|
5769
|
+
}[] | undefined;
|
|
5680
5770
|
};
|
|
5681
5771
|
security: Record<string, string[]>[];
|
|
5682
5772
|
"x-scalar-icon": string;
|
|
@@ -5732,6 +5822,11 @@ declare const client: import("vue").Ref<{
|
|
|
5732
5822
|
identifier?: string | undefined;
|
|
5733
5823
|
url?: string | undefined;
|
|
5734
5824
|
} | undefined;
|
|
5825
|
+
"x-scalar-sdk-installation"?: {
|
|
5826
|
+
lang: string;
|
|
5827
|
+
description?: string | undefined;
|
|
5828
|
+
source?: string | undefined;
|
|
5829
|
+
}[] | undefined;
|
|
5735
5830
|
};
|
|
5736
5831
|
security: Record<string, string[]>[];
|
|
5737
5832
|
"x-scalar-icon": string;
|
|
@@ -5787,6 +5882,11 @@ declare const client: import("vue").Ref<{
|
|
|
5787
5882
|
identifier?: string | undefined;
|
|
5788
5883
|
url?: string | undefined;
|
|
5789
5884
|
} | undefined;
|
|
5885
|
+
"x-scalar-sdk-installation"?: {
|
|
5886
|
+
lang: string;
|
|
5887
|
+
description?: string | undefined;
|
|
5888
|
+
source?: string | undefined;
|
|
5889
|
+
}[] | undefined;
|
|
5790
5890
|
};
|
|
5791
5891
|
security: Record<string, string[]>[];
|
|
5792
5892
|
"x-scalar-icon": string;
|
|
@@ -6051,7 +6151,7 @@ declare const client: import("vue").Ref<{
|
|
|
6051
6151
|
}[] | undefined;
|
|
6052
6152
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
6053
6153
|
}) => void;
|
|
6054
|
-
edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.
|
|
6154
|
+
edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.lang` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.label` | `x-code-samples.${number}` | `x-code-samples.${number}.lang` | `x-code-samples.${number}.source` | `x-code-samples.${number}.label` | `x-custom-examples.${number}` | `x-custom-examples.${number}.lang` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.label`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "examples" ? {
|
|
6055
6155
|
uid: string & import("zod").BRAND<"operation">;
|
|
6056
6156
|
path: string;
|
|
6057
6157
|
type: "request";
|
|
@@ -6214,7 +6314,7 @@ declare const client: import("vue").Ref<{
|
|
|
6214
6314
|
}[] | undefined;
|
|
6215
6315
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
6216
6316
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
6217
|
-
untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.
|
|
6317
|
+
untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.lang` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.label` | `x-code-samples.${number}` | `x-code-samples.${number}.lang` | `x-code-samples.${number}.source` | `x-code-samples.${number}.label` | `x-custom-examples.${number}` | `x-custom-examples.${number}.lang` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.label`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "examples" ? {
|
|
6218
6318
|
uid: string & import("zod").BRAND<"operation">;
|
|
6219
6319
|
path: string;
|
|
6220
6320
|
type: "request";
|