@scalar/api-client 2.3.23 → 2.3.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 +47 -0
- package/dist/components/CodeInput/CodeInput.vue.d.ts +3 -0
- package/dist/components/CodeInput/CodeInput.vue.d.ts.map +1 -1
- package/dist/components/CodeInput/CodeInput.vue.js +2 -2
- package/dist/components/CodeInput/CodeInput.vue2.js +73 -66
- package/dist/components/CommandPalette/CommandPaletteImport.vue.d.ts.map +1 -1
- package/dist/components/CommandPalette/CommandPaletteImport.vue.js +20 -20
- package/dist/components/DataTable/DataTableInput.vue.d.ts +6 -1
- package/dist/components/DataTable/DataTableInput.vue.d.ts.map +1 -1
- package/dist/layouts/App/create-api-client-app.d.ts +60 -10
- package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
- package/dist/layouts/Modal/create-api-client-modal.d.ts +122 -22
- package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
- package/dist/layouts/Web/ApiClientWeb.vue.d.ts.map +1 -1
- package/dist/layouts/Web/create-api-client-web.d.ts +60 -10
- package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
- package/dist/libs/create-client.d.ts +60 -10
- package/dist/libs/create-client.d.ts.map +1 -1
- package/dist/store/active-entities.d.ts +10 -0
- package/dist/store/active-entities.d.ts.map +1 -1
- package/dist/store/collections.d.ts +52 -2
- package/dist/store/collections.d.ts.map +1 -1
- package/dist/store/requests.d.ts +2 -2
- package/dist/store/security-schemes.d.ts.map +1 -1
- package/dist/store/store.d.ts +54 -4
- package/dist/store/store.d.ts.map +1 -1
- package/dist/store/tags.d.ts.map +1 -1
- package/dist/style.css +1 -1
- package/dist/views/Request/RequestSection/RequestParams.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestParams.vue.js +66 -55
- package/dist/views/Request/RequestSection/RequestPathParams.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestPathParams.vue.js +34 -23
- package/dist/views/Request/RequestSection/RequestTable.vue.d.ts +2 -2
- package/dist/views/Request/RequestSection/RequestTable.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestTable.vue.js +2 -2
- package/dist/views/Request/RequestSection/RequestTable.vue2.js +90 -73
- package/dist/views/Request/RequestSection/RequestTableTooltip.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestTableTooltip.vue.js +1 -1
- package/dist/views/Request/RequestSection/RequestTableTooltip.vue2.js +36 -36
- package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +1 -1
- package/dist/views/Request/libs/index.d.ts +1 -0
- package/dist/views/Request/libs/index.d.ts.map +1 -1
- package/dist/views/Request/libs/index.js +17 -6
- package/dist/views/Request/libs/watch-mode.js +1 -1
- package/package.json +15 -15
|
@@ -6,7 +6,7 @@ import { type CreateApiClientParams } from '../../libs';
|
|
|
6
6
|
*/
|
|
7
7
|
export declare const createApiClientModal: ({ el, configuration, mountOnInitialize, store, }: Partial<Pick<CreateApiClientParams, "el" | "configuration" | "mountOnInitialize" | "store">>) => Promise<{
|
|
8
8
|
app: import("vue").App<Element>;
|
|
9
|
-
updateConfig: (_newConfig: Partial<import("@scalar/types
|
|
9
|
+
updateConfig: (_newConfig: Partial<import("@scalar/types").ApiClientConfiguration>) => Promise<void>;
|
|
10
10
|
updateServer: (serverUrl: string) => void;
|
|
11
11
|
onUpdateServer: (callback: (url: string) => void) => void;
|
|
12
12
|
updateAuth: <P extends import("@scalar/object-utils/nested").Path<import("@scalar/types/entities").SecurityScheme>>({ nameKey, propertyKey, value, }: {
|
|
@@ -66,6 +66,11 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
66
66
|
identifier?: string | undefined;
|
|
67
67
|
url?: string | undefined;
|
|
68
68
|
} | undefined;
|
|
69
|
+
"x-scalar-sdk-installation"?: {
|
|
70
|
+
lang: string;
|
|
71
|
+
description?: string | undefined;
|
|
72
|
+
source?: string | undefined;
|
|
73
|
+
}[] | undefined;
|
|
69
74
|
};
|
|
70
75
|
security: Record<string, string[]>[];
|
|
71
76
|
'x-scalar-icon': string;
|
|
@@ -436,10 +441,10 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
436
441
|
integration?: string | null | undefined;
|
|
437
442
|
useCollectionSecurity?: boolean | undefined;
|
|
438
443
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
439
|
-
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types
|
|
444
|
+
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
440
445
|
useCollectionSecurity?: boolean;
|
|
441
446
|
shouldLoad?: boolean;
|
|
442
|
-
} & Pick<import("@scalar/types
|
|
447
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">) => Promise<{
|
|
443
448
|
error: false;
|
|
444
449
|
collection: import("@scalar/oas-utils/entities/spec").Collection;
|
|
445
450
|
requests: import("@scalar/oas-utils/entities/spec").Request[];
|
|
@@ -488,10 +493,10 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
488
493
|
integration?: string | null | undefined;
|
|
489
494
|
useCollectionSecurity?: boolean | undefined;
|
|
490
495
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
491
|
-
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types
|
|
496
|
+
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
492
497
|
useCollectionSecurity?: boolean;
|
|
493
498
|
shouldLoad?: boolean;
|
|
494
|
-
} & Pick<import("@scalar/types
|
|
499
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">, "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "proxyUrl">) => Promise<import("../../libs").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
|
|
495
500
|
uid?: string | undefined;
|
|
496
501
|
type?: "collection" | undefined;
|
|
497
502
|
externalDocs?: {
|
|
@@ -530,10 +535,10 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
530
535
|
integration?: string | null | undefined;
|
|
531
536
|
useCollectionSecurity?: boolean | undefined;
|
|
532
537
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
533
|
-
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types
|
|
538
|
+
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
534
539
|
useCollectionSecurity?: boolean;
|
|
535
540
|
shouldLoad?: boolean;
|
|
536
|
-
} & Pick<import("@scalar/types
|
|
541
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">) => Promise<{
|
|
537
542
|
error: false;
|
|
538
543
|
collection: import("@scalar/oas-utils/entities/spec").Collection;
|
|
539
544
|
requests: import("@scalar/oas-utils/entities/spec").Request[];
|
|
@@ -623,6 +628,11 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
623
628
|
identifier?: string | undefined;
|
|
624
629
|
url?: string | undefined;
|
|
625
630
|
} | undefined;
|
|
631
|
+
"x-scalar-sdk-installation"?: {
|
|
632
|
+
lang: string;
|
|
633
|
+
description?: string | undefined;
|
|
634
|
+
source?: string | undefined;
|
|
635
|
+
}[] | undefined;
|
|
626
636
|
};
|
|
627
637
|
security: Record<string, string[]>[];
|
|
628
638
|
'x-scalar-icon': string;
|
|
@@ -679,6 +689,11 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
679
689
|
identifier?: string | undefined;
|
|
680
690
|
url?: string | undefined;
|
|
681
691
|
} | undefined;
|
|
692
|
+
"x-scalar-sdk-installation"?: {
|
|
693
|
+
lang: string;
|
|
694
|
+
description?: string | undefined;
|
|
695
|
+
source?: string | undefined;
|
|
696
|
+
}[] | undefined;
|
|
682
697
|
};
|
|
683
698
|
security: Record<string, string[]>[];
|
|
684
699
|
'x-scalar-icon': string;
|
|
@@ -738,6 +753,11 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
738
753
|
identifier?: string | undefined;
|
|
739
754
|
url?: string | undefined;
|
|
740
755
|
} | undefined;
|
|
756
|
+
"x-scalar-sdk-installation"?: {
|
|
757
|
+
lang: string;
|
|
758
|
+
description?: string | undefined;
|
|
759
|
+
source?: string | undefined;
|
|
760
|
+
}[] | undefined;
|
|
741
761
|
};
|
|
742
762
|
security: Record<string, string[]>[];
|
|
743
763
|
'x-scalar-icon': string;
|
|
@@ -773,7 +793,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
773
793
|
documentUrl?: string | undefined;
|
|
774
794
|
integration?: string | null | undefined;
|
|
775
795
|
}) => void;
|
|
776
|
-
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" ? {
|
|
796
|
+
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" ? {
|
|
777
797
|
uid: string & import("zod").BRAND<"collection">;
|
|
778
798
|
type: "collection";
|
|
779
799
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -794,6 +814,11 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
794
814
|
identifier?: string | undefined;
|
|
795
815
|
url?: string | undefined;
|
|
796
816
|
} | undefined;
|
|
817
|
+
"x-scalar-sdk-installation"?: {
|
|
818
|
+
lang: string;
|
|
819
|
+
description?: string | undefined;
|
|
820
|
+
source?: string | undefined;
|
|
821
|
+
}[] | undefined;
|
|
797
822
|
};
|
|
798
823
|
security: Record<string, string[]>[];
|
|
799
824
|
'x-scalar-icon': string;
|
|
@@ -849,6 +874,11 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
849
874
|
identifier?: string | undefined;
|
|
850
875
|
url?: string | undefined;
|
|
851
876
|
} | undefined;
|
|
877
|
+
"x-scalar-sdk-installation"?: {
|
|
878
|
+
lang: string;
|
|
879
|
+
description?: string | undefined;
|
|
880
|
+
source?: string | undefined;
|
|
881
|
+
}[] | undefined;
|
|
852
882
|
};
|
|
853
883
|
security: Record<string, string[]>[];
|
|
854
884
|
'x-scalar-icon': string;
|
|
@@ -904,6 +934,11 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
904
934
|
identifier?: string | undefined;
|
|
905
935
|
url?: string | undefined;
|
|
906
936
|
} | undefined;
|
|
937
|
+
"x-scalar-sdk-installation"?: {
|
|
938
|
+
lang: string;
|
|
939
|
+
description?: string | undefined;
|
|
940
|
+
source?: string | undefined;
|
|
941
|
+
}[] | undefined;
|
|
907
942
|
};
|
|
908
943
|
security: Record<string, string[]>[];
|
|
909
944
|
'x-scalar-icon': string;
|
|
@@ -939,7 +974,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
939
974
|
documentUrl?: string | undefined;
|
|
940
975
|
integration?: string | null | undefined;
|
|
941
976
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
942
|
-
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" ? {
|
|
977
|
+
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" ? {
|
|
943
978
|
uid: string & import("zod").BRAND<"collection">;
|
|
944
979
|
type: "collection";
|
|
945
980
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -960,6 +995,11 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
960
995
|
identifier?: string | undefined;
|
|
961
996
|
url?: string | undefined;
|
|
962
997
|
} | undefined;
|
|
998
|
+
"x-scalar-sdk-installation"?: {
|
|
999
|
+
lang: string;
|
|
1000
|
+
description?: string | undefined;
|
|
1001
|
+
source?: string | undefined;
|
|
1002
|
+
}[] | undefined;
|
|
963
1003
|
};
|
|
964
1004
|
security: Record<string, string[]>[];
|
|
965
1005
|
'x-scalar-icon': string;
|
|
@@ -1015,6 +1055,11 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1015
1055
|
identifier?: string | undefined;
|
|
1016
1056
|
url?: string | undefined;
|
|
1017
1057
|
} | undefined;
|
|
1058
|
+
"x-scalar-sdk-installation"?: {
|
|
1059
|
+
lang: string;
|
|
1060
|
+
description?: string | undefined;
|
|
1061
|
+
source?: string | undefined;
|
|
1062
|
+
}[] | undefined;
|
|
1018
1063
|
};
|
|
1019
1064
|
security: Record<string, string[]>[];
|
|
1020
1065
|
'x-scalar-icon': string;
|
|
@@ -1070,6 +1115,11 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1070
1115
|
identifier?: string | undefined;
|
|
1071
1116
|
url?: string | undefined;
|
|
1072
1117
|
} | undefined;
|
|
1118
|
+
"x-scalar-sdk-installation"?: {
|
|
1119
|
+
lang: string;
|
|
1120
|
+
description?: string | undefined;
|
|
1121
|
+
source?: string | undefined;
|
|
1122
|
+
}[] | undefined;
|
|
1073
1123
|
};
|
|
1074
1124
|
security: Record<string, string[]>[];
|
|
1075
1125
|
'x-scalar-icon': string;
|
|
@@ -1334,7 +1384,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1334
1384
|
}[] | undefined;
|
|
1335
1385
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1336
1386
|
}) => void;
|
|
1337
|
-
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}.
|
|
1387
|
+
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" ? {
|
|
1338
1388
|
uid: string & import("zod").BRAND<"operation">;
|
|
1339
1389
|
path: string;
|
|
1340
1390
|
type: "request";
|
|
@@ -1497,7 +1547,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
1497
1547
|
}[] | undefined;
|
|
1498
1548
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1499
1549
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1500
|
-
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}.
|
|
1550
|
+
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" ? {
|
|
1501
1551
|
uid: string & import("zod").BRAND<"operation">;
|
|
1502
1552
|
path: string;
|
|
1503
1553
|
type: "request";
|
|
@@ -3740,7 +3790,7 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
|
|
|
3740
3790
|
*/
|
|
3741
3791
|
export declare const createApiClientModalSync: ({ el, configuration, mountOnInitialize, store, }: Partial<Pick<CreateApiClientParams, "el" | "configuration" | "mountOnInitialize" | "store">>) => {
|
|
3742
3792
|
app: import("vue").App<Element>;
|
|
3743
|
-
updateConfig: (_newConfig: Partial<import("@scalar/types
|
|
3793
|
+
updateConfig: (_newConfig: Partial<import("@scalar/types").ApiClientConfiguration>) => Promise<void>;
|
|
3744
3794
|
updateServer: (serverUrl: string) => void;
|
|
3745
3795
|
onUpdateServer: (callback: (url: string) => void) => void;
|
|
3746
3796
|
updateAuth: <P extends import("@scalar/object-utils/nested").Path<import("@scalar/types/entities").SecurityScheme>>({ nameKey, propertyKey, value, }: {
|
|
@@ -3800,6 +3850,11 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
3800
3850
|
identifier?: string | undefined;
|
|
3801
3851
|
url?: string | undefined;
|
|
3802
3852
|
} | undefined;
|
|
3853
|
+
"x-scalar-sdk-installation"?: {
|
|
3854
|
+
lang: string;
|
|
3855
|
+
description?: string | undefined;
|
|
3856
|
+
source?: string | undefined;
|
|
3857
|
+
}[] | undefined;
|
|
3803
3858
|
};
|
|
3804
3859
|
security: Record<string, string[]>[];
|
|
3805
3860
|
'x-scalar-icon': string;
|
|
@@ -4170,10 +4225,10 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4170
4225
|
integration?: string | null | undefined;
|
|
4171
4226
|
useCollectionSecurity?: boolean | undefined;
|
|
4172
4227
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
4173
|
-
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types
|
|
4228
|
+
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
4174
4229
|
useCollectionSecurity?: boolean;
|
|
4175
4230
|
shouldLoad?: boolean;
|
|
4176
|
-
} & Pick<import("@scalar/types
|
|
4231
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">) => Promise<{
|
|
4177
4232
|
error: false;
|
|
4178
4233
|
collection: import("@scalar/oas-utils/entities/spec").Collection;
|
|
4179
4234
|
requests: import("@scalar/oas-utils/entities/spec").Request[];
|
|
@@ -4222,10 +4277,10 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4222
4277
|
integration?: string | null | undefined;
|
|
4223
4278
|
useCollectionSecurity?: boolean | undefined;
|
|
4224
4279
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
4225
|
-
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types
|
|
4280
|
+
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
4226
4281
|
useCollectionSecurity?: boolean;
|
|
4227
4282
|
shouldLoad?: boolean;
|
|
4228
|
-
} & Pick<import("@scalar/types
|
|
4283
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">, "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "proxyUrl">) => Promise<import("../../libs").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
|
|
4229
4284
|
uid?: string | undefined;
|
|
4230
4285
|
type?: "collection" | undefined;
|
|
4231
4286
|
externalDocs?: {
|
|
@@ -4264,10 +4319,10 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4264
4319
|
integration?: string | null | undefined;
|
|
4265
4320
|
useCollectionSecurity?: boolean | undefined;
|
|
4266
4321
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
4267
|
-
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types
|
|
4322
|
+
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
4268
4323
|
useCollectionSecurity?: boolean;
|
|
4269
4324
|
shouldLoad?: boolean;
|
|
4270
|
-
} & Pick<import("@scalar/types
|
|
4325
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">) => Promise<{
|
|
4271
4326
|
error: false;
|
|
4272
4327
|
collection: import("@scalar/oas-utils/entities/spec").Collection;
|
|
4273
4328
|
requests: import("@scalar/oas-utils/entities/spec").Request[];
|
|
@@ -4357,6 +4412,11 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4357
4412
|
identifier?: string | undefined;
|
|
4358
4413
|
url?: string | undefined;
|
|
4359
4414
|
} | undefined;
|
|
4415
|
+
"x-scalar-sdk-installation"?: {
|
|
4416
|
+
lang: string;
|
|
4417
|
+
description?: string | undefined;
|
|
4418
|
+
source?: string | undefined;
|
|
4419
|
+
}[] | undefined;
|
|
4360
4420
|
};
|
|
4361
4421
|
security: Record<string, string[]>[];
|
|
4362
4422
|
'x-scalar-icon': string;
|
|
@@ -4413,6 +4473,11 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4413
4473
|
identifier?: string | undefined;
|
|
4414
4474
|
url?: string | undefined;
|
|
4415
4475
|
} | undefined;
|
|
4476
|
+
"x-scalar-sdk-installation"?: {
|
|
4477
|
+
lang: string;
|
|
4478
|
+
description?: string | undefined;
|
|
4479
|
+
source?: string | undefined;
|
|
4480
|
+
}[] | undefined;
|
|
4416
4481
|
};
|
|
4417
4482
|
security: Record<string, string[]>[];
|
|
4418
4483
|
'x-scalar-icon': string;
|
|
@@ -4472,6 +4537,11 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4472
4537
|
identifier?: string | undefined;
|
|
4473
4538
|
url?: string | undefined;
|
|
4474
4539
|
} | undefined;
|
|
4540
|
+
"x-scalar-sdk-installation"?: {
|
|
4541
|
+
lang: string;
|
|
4542
|
+
description?: string | undefined;
|
|
4543
|
+
source?: string | undefined;
|
|
4544
|
+
}[] | undefined;
|
|
4475
4545
|
};
|
|
4476
4546
|
security: Record<string, string[]>[];
|
|
4477
4547
|
'x-scalar-icon': string;
|
|
@@ -4507,7 +4577,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4507
4577
|
documentUrl?: string | undefined;
|
|
4508
4578
|
integration?: string | null | undefined;
|
|
4509
4579
|
}) => void;
|
|
4510
|
-
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" ? {
|
|
4580
|
+
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" ? {
|
|
4511
4581
|
uid: string & import("zod").BRAND<"collection">;
|
|
4512
4582
|
type: "collection";
|
|
4513
4583
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -4528,6 +4598,11 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4528
4598
|
identifier?: string | undefined;
|
|
4529
4599
|
url?: string | undefined;
|
|
4530
4600
|
} | undefined;
|
|
4601
|
+
"x-scalar-sdk-installation"?: {
|
|
4602
|
+
lang: string;
|
|
4603
|
+
description?: string | undefined;
|
|
4604
|
+
source?: string | undefined;
|
|
4605
|
+
}[] | undefined;
|
|
4531
4606
|
};
|
|
4532
4607
|
security: Record<string, string[]>[];
|
|
4533
4608
|
'x-scalar-icon': string;
|
|
@@ -4583,6 +4658,11 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4583
4658
|
identifier?: string | undefined;
|
|
4584
4659
|
url?: string | undefined;
|
|
4585
4660
|
} | undefined;
|
|
4661
|
+
"x-scalar-sdk-installation"?: {
|
|
4662
|
+
lang: string;
|
|
4663
|
+
description?: string | undefined;
|
|
4664
|
+
source?: string | undefined;
|
|
4665
|
+
}[] | undefined;
|
|
4586
4666
|
};
|
|
4587
4667
|
security: Record<string, string[]>[];
|
|
4588
4668
|
'x-scalar-icon': string;
|
|
@@ -4638,6 +4718,11 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4638
4718
|
identifier?: string | undefined;
|
|
4639
4719
|
url?: string | undefined;
|
|
4640
4720
|
} | undefined;
|
|
4721
|
+
"x-scalar-sdk-installation"?: {
|
|
4722
|
+
lang: string;
|
|
4723
|
+
description?: string | undefined;
|
|
4724
|
+
source?: string | undefined;
|
|
4725
|
+
}[] | undefined;
|
|
4641
4726
|
};
|
|
4642
4727
|
security: Record<string, string[]>[];
|
|
4643
4728
|
'x-scalar-icon': string;
|
|
@@ -4673,7 +4758,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4673
4758
|
documentUrl?: string | undefined;
|
|
4674
4759
|
integration?: string | null | undefined;
|
|
4675
4760
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
4676
|
-
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" ? {
|
|
4761
|
+
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" ? {
|
|
4677
4762
|
uid: string & import("zod").BRAND<"collection">;
|
|
4678
4763
|
type: "collection";
|
|
4679
4764
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -4694,6 +4779,11 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4694
4779
|
identifier?: string | undefined;
|
|
4695
4780
|
url?: string | undefined;
|
|
4696
4781
|
} | undefined;
|
|
4782
|
+
"x-scalar-sdk-installation"?: {
|
|
4783
|
+
lang: string;
|
|
4784
|
+
description?: string | undefined;
|
|
4785
|
+
source?: string | undefined;
|
|
4786
|
+
}[] | undefined;
|
|
4697
4787
|
};
|
|
4698
4788
|
security: Record<string, string[]>[];
|
|
4699
4789
|
'x-scalar-icon': string;
|
|
@@ -4749,6 +4839,11 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4749
4839
|
identifier?: string | undefined;
|
|
4750
4840
|
url?: string | undefined;
|
|
4751
4841
|
} | undefined;
|
|
4842
|
+
"x-scalar-sdk-installation"?: {
|
|
4843
|
+
lang: string;
|
|
4844
|
+
description?: string | undefined;
|
|
4845
|
+
source?: string | undefined;
|
|
4846
|
+
}[] | undefined;
|
|
4752
4847
|
};
|
|
4753
4848
|
security: Record<string, string[]>[];
|
|
4754
4849
|
'x-scalar-icon': string;
|
|
@@ -4804,6 +4899,11 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
4804
4899
|
identifier?: string | undefined;
|
|
4805
4900
|
url?: string | undefined;
|
|
4806
4901
|
} | undefined;
|
|
4902
|
+
"x-scalar-sdk-installation"?: {
|
|
4903
|
+
lang: string;
|
|
4904
|
+
description?: string | undefined;
|
|
4905
|
+
source?: string | undefined;
|
|
4906
|
+
}[] | undefined;
|
|
4807
4907
|
};
|
|
4808
4908
|
security: Record<string, string[]>[];
|
|
4809
4909
|
'x-scalar-icon': string;
|
|
@@ -5068,7 +5168,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5068
5168
|
}[] | undefined;
|
|
5069
5169
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5070
5170
|
}) => void;
|
|
5071
|
-
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}.
|
|
5171
|
+
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" ? {
|
|
5072
5172
|
uid: string & import("zod").BRAND<"operation">;
|
|
5073
5173
|
path: string;
|
|
5074
5174
|
type: "request";
|
|
@@ -5231,7 +5331,7 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
|
|
|
5231
5331
|
}[] | undefined;
|
|
5232
5332
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
5233
5333
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
5234
|
-
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}.
|
|
5334
|
+
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" ? {
|
|
5235
5335
|
uid: string & import("zod").BRAND<"operation">;
|
|
5236
5336
|
path: string;
|
|
5237
5337
|
type: "request";
|