@scalar/api-reference 1.28.9 → 1.28.11
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 +40 -0
- package/dist/browser/standalone.js +5570 -5486
- package/dist/browser/webpack-stats.json +1 -1
- package/dist/components/ApiReferenceLayout.vue.js +2 -2
- package/dist/components/ApiReferenceLayout.vue2.js +13 -13
- package/dist/components/Content/Models/Models.vue.d.ts.map +1 -1
- package/dist/components/Content/Models/Models.vue.js +2 -2
- package/dist/components/Content/Schema/Schema.vue.d.ts +2 -0
- package/dist/components/Content/Schema/Schema.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/Schema.vue.js +4 -4
- package/dist/components/Content/Schema/Schema.vue2.js +78 -54
- package/dist/components/Content/Schema/SchemaProperty.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/SchemaProperty.vue.js +1 -1
- package/dist/components/Content/Schema/SchemaProperty.vue2.js +96 -114
- package/dist/components/Content/Schema/SchemaPropertyExamples.vue.d.ts +8 -0
- package/dist/components/Content/Schema/SchemaPropertyExamples.vue.d.ts.map +1 -0
- package/dist/components/Content/Schema/SchemaPropertyExamples.vue.js +7 -0
- package/dist/components/Content/Schema/SchemaPropertyExamples.vue2.js +71 -0
- package/dist/components/Content/Schema/SchemaPropertyHeading.vue.d.ts +2 -0
- package/dist/components/Content/Schema/SchemaPropertyHeading.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/SchemaPropertyHeading.vue.js +1 -1
- package/dist/components/Content/Schema/SchemaPropertyHeading.vue2.js +139 -130
- package/dist/features/ApiClientModal/useApiClient.d.ts +76 -334
- package/dist/features/ApiClientModal/useApiClient.d.ts.map +1 -1
- package/dist/features/ExampleResponses/ExampleResponses.vue.d.ts.map +1 -1
- package/dist/features/ExampleResponses/ExampleResponses.vue.js +2 -2
- package/dist/features/ExampleResponses/ExampleResponses.vue2.js +86 -85
- package/dist/features/Operation/components/RequestBody.vue.d.ts.map +1 -1
- package/dist/features/Operation/components/RequestBody.vue.js +2 -2
- package/dist/features/Operation/components/RequestBody.vue2.js +65 -28
- package/dist/features/Search/useSearchIndex.js +72 -72
- package/dist/helpers/get-request.d.ts.map +1 -1
- package/dist/hooks/useMultipleDocuments.d.ts +5 -1
- package/dist/hooks/useMultipleDocuments.d.ts.map +1 -1
- package/dist/hooks/useMultipleDocuments.js +49 -48
- package/dist/hooks/useNavState.d.ts +6 -4
- package/dist/hooks/useNavState.d.ts.map +1 -1
- package/dist/hooks/useNavState.js +34 -37
- package/dist/index.js +1 -1
- package/dist/style.css +1 -1
- package/package.json +12 -12
|
@@ -128,6 +128,7 @@ declare const client: import("vue").Ref<{
|
|
|
128
128
|
} | undefined;
|
|
129
129
|
};
|
|
130
130
|
description?: string | undefined;
|
|
131
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
131
132
|
}>;
|
|
132
133
|
cookies: Record<string, {
|
|
133
134
|
uid: string & import("zod").BRAND<"cookie">;
|
|
@@ -307,6 +308,7 @@ declare const client: import("vue").Ref<{
|
|
|
307
308
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
308
309
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
309
310
|
watchMode: boolean;
|
|
311
|
+
useCollectionSecurity: boolean;
|
|
310
312
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
311
313
|
externalDocs?: {
|
|
312
314
|
url: string;
|
|
@@ -506,9 +508,10 @@ declare const client: import("vue").Ref<{
|
|
|
506
508
|
documentUrl?: string | undefined;
|
|
507
509
|
watchMode?: boolean | undefined;
|
|
508
510
|
integration?: string | null | undefined;
|
|
511
|
+
useCollectionSecurity?: boolean | undefined;
|
|
509
512
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
510
513
|
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types/api-reference").ApiReferenceConfiguration, "servers" | "authentication" | "slug" | "baseServerURL"> & {
|
|
511
|
-
|
|
514
|
+
useCollectionSecurity?: boolean;
|
|
512
515
|
shouldLoad?: boolean;
|
|
513
516
|
} & Pick<import("@scalar/types/api-reference").ApiReferenceConfiguration, "servers">) => Promise<{
|
|
514
517
|
error: false;
|
|
@@ -518,83 +521,7 @@ declare const client: import("vue").Ref<{
|
|
|
518
521
|
examples: import("@scalar/oas-utils/entities/spec").RequestExample[];
|
|
519
522
|
servers: import("@scalar/oas-utils/entities/spec").Server[];
|
|
520
523
|
tags: import("@scalar/oas-utils/entities/spec").Tag[];
|
|
521
|
-
securitySchemes: (
|
|
522
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
523
|
-
name: string;
|
|
524
|
-
value: string;
|
|
525
|
-
type: "apiKey";
|
|
526
|
-
in: "cookie" | "query" | "header";
|
|
527
|
-
nameKey: string;
|
|
528
|
-
description?: string | undefined;
|
|
529
|
-
} | {
|
|
530
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
531
|
-
type: "http";
|
|
532
|
-
password: string;
|
|
533
|
-
nameKey: string;
|
|
534
|
-
scheme: "basic" | "bearer";
|
|
535
|
-
bearerFormat: string;
|
|
536
|
-
username: string;
|
|
537
|
-
token: string;
|
|
538
|
-
description?: string | undefined;
|
|
539
|
-
} | {
|
|
540
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
541
|
-
type: "openIdConnect";
|
|
542
|
-
nameKey: string;
|
|
543
|
-
openIdConnectUrl: string;
|
|
544
|
-
description?: string | undefined;
|
|
545
|
-
} | {
|
|
546
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
547
|
-
type: "oauth2";
|
|
548
|
-
nameKey: string;
|
|
549
|
-
flows: {
|
|
550
|
-
password?: {
|
|
551
|
-
type: "password";
|
|
552
|
-
password: string;
|
|
553
|
-
username: string;
|
|
554
|
-
token: string;
|
|
555
|
-
refreshUrl: string;
|
|
556
|
-
scopes: Record<string, string>;
|
|
557
|
-
selectedScopes: string[];
|
|
558
|
-
"x-scalar-client-id": string;
|
|
559
|
-
tokenUrl: string;
|
|
560
|
-
clientSecret: string;
|
|
561
|
-
} | undefined;
|
|
562
|
-
implicit?: {
|
|
563
|
-
type: "implicit";
|
|
564
|
-
token: string;
|
|
565
|
-
refreshUrl: string;
|
|
566
|
-
scopes: Record<string, string>;
|
|
567
|
-
selectedScopes: string[];
|
|
568
|
-
"x-scalar-client-id": string;
|
|
569
|
-
authorizationUrl: string;
|
|
570
|
-
"x-scalar-redirect-uri": string;
|
|
571
|
-
} | undefined;
|
|
572
|
-
clientCredentials?: {
|
|
573
|
-
type: "clientCredentials";
|
|
574
|
-
token: string;
|
|
575
|
-
refreshUrl: string;
|
|
576
|
-
scopes: Record<string, string>;
|
|
577
|
-
selectedScopes: string[];
|
|
578
|
-
"x-scalar-client-id": string;
|
|
579
|
-
tokenUrl: string;
|
|
580
|
-
clientSecret: string;
|
|
581
|
-
} | undefined;
|
|
582
|
-
authorizationCode?: {
|
|
583
|
-
type: "authorizationCode";
|
|
584
|
-
token: string;
|
|
585
|
-
refreshUrl: string;
|
|
586
|
-
scopes: Record<string, string>;
|
|
587
|
-
selectedScopes: string[];
|
|
588
|
-
"x-scalar-client-id": string;
|
|
589
|
-
authorizationUrl: string;
|
|
590
|
-
"x-scalar-redirect-uri": string;
|
|
591
|
-
tokenUrl: string;
|
|
592
|
-
clientSecret: string;
|
|
593
|
-
"x-usePkce": "SHA-256" | "plain" | "no";
|
|
594
|
-
} | undefined;
|
|
595
|
-
};
|
|
596
|
-
description?: string | undefined;
|
|
597
|
-
})[];
|
|
524
|
+
securitySchemes: import("@scalar/types/entities").SecurityScheme[];
|
|
598
525
|
} | undefined>;
|
|
599
526
|
importSpecFromUrl: (url: string, workspaceUid: string, { proxyUrl, ...options }?: Omit<Pick<{
|
|
600
527
|
uid?: string | undefined;
|
|
@@ -633,9 +560,10 @@ declare const client: import("vue").Ref<{
|
|
|
633
560
|
documentUrl?: string | undefined;
|
|
634
561
|
watchMode?: boolean | undefined;
|
|
635
562
|
integration?: string | null | undefined;
|
|
563
|
+
useCollectionSecurity?: boolean | undefined;
|
|
636
564
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
637
565
|
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types/api-reference").ApiReferenceConfiguration, "servers" | "authentication" | "slug" | "baseServerURL"> & {
|
|
638
|
-
|
|
566
|
+
useCollectionSecurity?: boolean;
|
|
639
567
|
shouldLoad?: boolean;
|
|
640
568
|
} & Pick<import("@scalar/types/api-reference").ApiReferenceConfiguration, "servers">, "documentUrl"> & Pick<import("@scalar/types/api-reference").ApiReferenceConfiguration, "proxyUrl">) => Promise<import("@scalar/api-client/libs").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
|
|
641
569
|
uid?: string | undefined;
|
|
@@ -674,9 +602,10 @@ declare const client: import("vue").Ref<{
|
|
|
674
602
|
documentUrl?: string | undefined;
|
|
675
603
|
watchMode?: boolean | undefined;
|
|
676
604
|
integration?: string | null | undefined;
|
|
605
|
+
useCollectionSecurity?: boolean | undefined;
|
|
677
606
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
678
607
|
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types/api-reference").ApiReferenceConfiguration, "servers" | "authentication" | "slug" | "baseServerURL"> & {
|
|
679
|
-
|
|
608
|
+
useCollectionSecurity?: boolean;
|
|
680
609
|
shouldLoad?: boolean;
|
|
681
610
|
} & Pick<import("@scalar/types/api-reference").ApiReferenceConfiguration, "servers">) => Promise<{
|
|
682
611
|
error: false;
|
|
@@ -686,83 +615,7 @@ declare const client: import("vue").Ref<{
|
|
|
686
615
|
examples: import("@scalar/oas-utils/entities/spec").RequestExample[];
|
|
687
616
|
servers: import("@scalar/oas-utils/entities/spec").Server[];
|
|
688
617
|
tags: import("@scalar/oas-utils/entities/spec").Tag[];
|
|
689
|
-
securitySchemes: (
|
|
690
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
691
|
-
name: string;
|
|
692
|
-
value: string;
|
|
693
|
-
type: "apiKey";
|
|
694
|
-
in: "cookie" | "query" | "header";
|
|
695
|
-
nameKey: string;
|
|
696
|
-
description?: string | undefined;
|
|
697
|
-
} | {
|
|
698
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
699
|
-
type: "http";
|
|
700
|
-
password: string;
|
|
701
|
-
nameKey: string;
|
|
702
|
-
scheme: "basic" | "bearer";
|
|
703
|
-
bearerFormat: string;
|
|
704
|
-
username: string;
|
|
705
|
-
token: string;
|
|
706
|
-
description?: string | undefined;
|
|
707
|
-
} | {
|
|
708
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
709
|
-
type: "openIdConnect";
|
|
710
|
-
nameKey: string;
|
|
711
|
-
openIdConnectUrl: string;
|
|
712
|
-
description?: string | undefined;
|
|
713
|
-
} | {
|
|
714
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
715
|
-
type: "oauth2";
|
|
716
|
-
nameKey: string;
|
|
717
|
-
flows: {
|
|
718
|
-
password?: {
|
|
719
|
-
type: "password";
|
|
720
|
-
password: string;
|
|
721
|
-
username: string;
|
|
722
|
-
token: string;
|
|
723
|
-
refreshUrl: string;
|
|
724
|
-
scopes: Record<string, string>;
|
|
725
|
-
selectedScopes: string[];
|
|
726
|
-
"x-scalar-client-id": string;
|
|
727
|
-
tokenUrl: string;
|
|
728
|
-
clientSecret: string;
|
|
729
|
-
} | undefined;
|
|
730
|
-
implicit?: {
|
|
731
|
-
type: "implicit";
|
|
732
|
-
token: string;
|
|
733
|
-
refreshUrl: string;
|
|
734
|
-
scopes: Record<string, string>;
|
|
735
|
-
selectedScopes: string[];
|
|
736
|
-
"x-scalar-client-id": string;
|
|
737
|
-
authorizationUrl: string;
|
|
738
|
-
"x-scalar-redirect-uri": string;
|
|
739
|
-
} | undefined;
|
|
740
|
-
clientCredentials?: {
|
|
741
|
-
type: "clientCredentials";
|
|
742
|
-
token: string;
|
|
743
|
-
refreshUrl: string;
|
|
744
|
-
scopes: Record<string, string>;
|
|
745
|
-
selectedScopes: string[];
|
|
746
|
-
"x-scalar-client-id": string;
|
|
747
|
-
tokenUrl: string;
|
|
748
|
-
clientSecret: string;
|
|
749
|
-
} | undefined;
|
|
750
|
-
authorizationCode?: {
|
|
751
|
-
type: "authorizationCode";
|
|
752
|
-
token: string;
|
|
753
|
-
refreshUrl: string;
|
|
754
|
-
scopes: Record<string, string>;
|
|
755
|
-
selectedScopes: string[];
|
|
756
|
-
"x-scalar-client-id": string;
|
|
757
|
-
authorizationUrl: string;
|
|
758
|
-
"x-scalar-redirect-uri": string;
|
|
759
|
-
tokenUrl: string;
|
|
760
|
-
clientSecret: string;
|
|
761
|
-
"x-usePkce": "SHA-256" | "plain" | "no";
|
|
762
|
-
} | undefined;
|
|
763
|
-
};
|
|
764
|
-
description?: string | undefined;
|
|
765
|
-
})[];
|
|
618
|
+
securitySchemes: import("@scalar/types/entities").SecurityScheme[];
|
|
766
619
|
} | undefined>>>>>;
|
|
767
620
|
cookieMutators: {
|
|
768
621
|
add: (item: {
|
|
@@ -853,6 +706,7 @@ declare const client: import("vue").Ref<{
|
|
|
853
706
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
854
707
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
855
708
|
watchMode: boolean;
|
|
709
|
+
useCollectionSecurity: boolean;
|
|
856
710
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
857
711
|
externalDocs?: {
|
|
858
712
|
url: string;
|
|
@@ -908,6 +762,7 @@ declare const client: import("vue").Ref<{
|
|
|
908
762
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
909
763
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
910
764
|
watchMode: boolean;
|
|
765
|
+
useCollectionSecurity: boolean;
|
|
911
766
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
912
767
|
externalDocs?: {
|
|
913
768
|
url: string;
|
|
@@ -966,6 +821,7 @@ declare const client: import("vue").Ref<{
|
|
|
966
821
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
967
822
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
968
823
|
watchMode: boolean;
|
|
824
|
+
useCollectionSecurity: boolean;
|
|
969
825
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
970
826
|
externalDocs?: {
|
|
971
827
|
url: string;
|
|
@@ -991,7 +847,7 @@ declare const client: import("vue").Ref<{
|
|
|
991
847
|
documentUrl?: string | undefined;
|
|
992
848
|
integration?: string | null | undefined;
|
|
993
849
|
}) => void;
|
|
994
|
-
edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: (string & import("zod").BRAND<"collection">) | null | undefined, path: P, value: P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
|
|
850
|
+
edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: (string & import("zod").BRAND<"collection">) | null | undefined, path: P, value: P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
|
|
995
851
|
uid: string & import("zod").BRAND<"collection">;
|
|
996
852
|
type: "collection";
|
|
997
853
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -1021,6 +877,7 @@ declare const client: import("vue").Ref<{
|
|
|
1021
877
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
1022
878
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
1023
879
|
watchMode: boolean;
|
|
880
|
+
useCollectionSecurity: boolean;
|
|
1024
881
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
1025
882
|
externalDocs?: {
|
|
1026
883
|
url: string;
|
|
@@ -1045,7 +902,7 @@ declare const client: import("vue").Ref<{
|
|
|
1045
902
|
selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
|
|
1046
903
|
documentUrl?: string | undefined;
|
|
1047
904
|
integration?: string | null | undefined;
|
|
1048
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
905
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1049
906
|
uid: string & import("zod").BRAND<"collection">;
|
|
1050
907
|
type: "collection";
|
|
1051
908
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -1075,6 +932,7 @@ declare const client: import("vue").Ref<{
|
|
|
1075
932
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
1076
933
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
1077
934
|
watchMode: boolean;
|
|
935
|
+
useCollectionSecurity: boolean;
|
|
1078
936
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
1079
937
|
externalDocs?: {
|
|
1080
938
|
url: string;
|
|
@@ -1129,6 +987,7 @@ declare const client: import("vue").Ref<{
|
|
|
1129
987
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
1130
988
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
1131
989
|
watchMode: boolean;
|
|
990
|
+
useCollectionSecurity: boolean;
|
|
1132
991
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
1133
992
|
externalDocs?: {
|
|
1134
993
|
url: string;
|
|
@@ -1154,7 +1013,7 @@ declare const client: import("vue").Ref<{
|
|
|
1154
1013
|
documentUrl?: string | undefined;
|
|
1155
1014
|
integration?: string | null | undefined;
|
|
1156
1015
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1157
|
-
untrackedEdit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string & import("zod").BRAND<"collection">, path: P, value: P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
|
|
1016
|
+
untrackedEdit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string & import("zod").BRAND<"collection">, path: P, value: P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
|
|
1158
1017
|
uid: string & import("zod").BRAND<"collection">;
|
|
1159
1018
|
type: "collection";
|
|
1160
1019
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -1184,6 +1043,7 @@ declare const client: import("vue").Ref<{
|
|
|
1184
1043
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
1185
1044
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
1186
1045
|
watchMode: boolean;
|
|
1046
|
+
useCollectionSecurity: boolean;
|
|
1187
1047
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
1188
1048
|
externalDocs?: {
|
|
1189
1049
|
url: string;
|
|
@@ -1208,7 +1068,7 @@ declare const client: import("vue").Ref<{
|
|
|
1208
1068
|
selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
|
|
1209
1069
|
documentUrl?: string | undefined;
|
|
1210
1070
|
integration?: string | null | undefined;
|
|
1211
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1071
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1212
1072
|
uid: string & import("zod").BRAND<"collection">;
|
|
1213
1073
|
type: "collection";
|
|
1214
1074
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -1238,6 +1098,7 @@ declare const client: import("vue").Ref<{
|
|
|
1238
1098
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
1239
1099
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
1240
1100
|
watchMode: boolean;
|
|
1101
|
+
useCollectionSecurity: boolean;
|
|
1241
1102
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
1242
1103
|
externalDocs?: {
|
|
1243
1104
|
url: string;
|
|
@@ -1292,6 +1153,7 @@ declare const client: import("vue").Ref<{
|
|
|
1292
1153
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
1293
1154
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
1294
1155
|
watchMode: boolean;
|
|
1156
|
+
useCollectionSecurity: boolean;
|
|
1295
1157
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
1296
1158
|
externalDocs?: {
|
|
1297
1159
|
url: string;
|
|
@@ -2730,6 +2592,7 @@ declare const client: import("vue").Ref<{
|
|
|
2730
2592
|
} | undefined;
|
|
2731
2593
|
};
|
|
2732
2594
|
description?: string | undefined;
|
|
2595
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
2733
2596
|
}) => void;
|
|
2734
2597
|
add: (payload: import("@scalar/types/entities").SecuritySchemePayload, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => {
|
|
2735
2598
|
type: "apiKey";
|
|
@@ -2807,6 +2670,7 @@ declare const client: import("vue").Ref<{
|
|
|
2807
2670
|
} | undefined;
|
|
2808
2671
|
};
|
|
2809
2672
|
description?: string | undefined;
|
|
2673
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
2810
2674
|
};
|
|
2811
2675
|
delete: (schemeUid: import("@scalar/types/entities").SecurityScheme["uid"]) => void;
|
|
2812
2676
|
set: (item: {
|
|
@@ -2885,8 +2749,9 @@ declare const client: import("vue").Ref<{
|
|
|
2885
2749
|
} | undefined;
|
|
2886
2750
|
};
|
|
2887
2751
|
description?: string | undefined;
|
|
2752
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
2888
2753
|
}) => void;
|
|
2889
|
-
edit: <P extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "openIdConnectUrl" | "flows" | "password" | "username" | "token" | "flows.password" | "flows.implicit" | "flows.clientCredentials" | "flows.authorizationCode" | "flows.password.type" | "flows.password.password" | "flows.password.username" | "flows.password.token" | "flows.password.refreshUrl" | "flows.password.scopes" | "flows.password.selectedScopes" | "flows.password.x-scalar-client-id" | "flows.password.tokenUrl" | "flows.password.clientSecret" | `flows.password.scopes.${string}` | `flows.password.selectedScopes.${number}` | "flows.implicit.type" | "flows.implicit.token" | "flows.implicit.refreshUrl" | "flows.implicit.scopes" | "flows.implicit.selectedScopes" | "flows.implicit.x-scalar-client-id" | `flows.implicit.scopes.${string}` | `flows.implicit.selectedScopes.${number}` | "flows.implicit.authorizationUrl" | "flows.implicit.x-scalar-redirect-uri" | "flows.clientCredentials.type" | "flows.clientCredentials.token" | "flows.clientCredentials.refreshUrl" | "flows.clientCredentials.scopes" | "flows.clientCredentials.selectedScopes" | "flows.clientCredentials.x-scalar-client-id" | "flows.clientCredentials.tokenUrl" | "flows.clientCredentials.clientSecret" | `flows.clientCredentials.scopes.${string}` | `flows.clientCredentials.selectedScopes.${number}` | "flows.authorizationCode.type" | "flows.authorizationCode.token" | "flows.authorizationCode.refreshUrl" | "flows.authorizationCode.scopes" | "flows.authorizationCode.selectedScopes" | "flows.authorizationCode.x-scalar-client-id" | "flows.authorizationCode.tokenUrl" | "flows.authorizationCode.clientSecret" | `flows.authorizationCode.scopes.${string}` | `flows.authorizationCode.selectedScopes.${number}` | "flows.authorizationCode.authorizationUrl" | "flows.authorizationCode.x-scalar-redirect-uri" | "flows.authorizationCode.x-usePkce">(uid: (string & import("zod").BRAND<"securityScheme">) | null | undefined, path: P, value: (P extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" ? {
|
|
2754
|
+
edit: <P extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "openIdConnectUrl" | "x-default-scopes" | "flows" | "password" | "username" | "token" | `x-default-scopes.${number}` | "flows.password" | "flows.implicit" | "flows.clientCredentials" | "flows.authorizationCode" | "flows.password.type" | "flows.password.password" | "flows.password.username" | "flows.password.token" | "flows.password.refreshUrl" | "flows.password.scopes" | "flows.password.selectedScopes" | "flows.password.x-scalar-client-id" | "flows.password.tokenUrl" | "flows.password.clientSecret" | `flows.password.scopes.${string}` | `flows.password.selectedScopes.${number}` | "flows.implicit.type" | "flows.implicit.token" | "flows.implicit.refreshUrl" | "flows.implicit.scopes" | "flows.implicit.selectedScopes" | "flows.implicit.x-scalar-client-id" | `flows.implicit.scopes.${string}` | `flows.implicit.selectedScopes.${number}` | "flows.implicit.authorizationUrl" | "flows.implicit.x-scalar-redirect-uri" | "flows.clientCredentials.type" | "flows.clientCredentials.token" | "flows.clientCredentials.refreshUrl" | "flows.clientCredentials.scopes" | "flows.clientCredentials.selectedScopes" | "flows.clientCredentials.x-scalar-client-id" | "flows.clientCredentials.tokenUrl" | "flows.clientCredentials.clientSecret" | `flows.clientCredentials.scopes.${string}` | `flows.clientCredentials.selectedScopes.${number}` | "flows.authorizationCode.type" | "flows.authorizationCode.token" | "flows.authorizationCode.refreshUrl" | "flows.authorizationCode.scopes" | "flows.authorizationCode.selectedScopes" | "flows.authorizationCode.x-scalar-client-id" | "flows.authorizationCode.tokenUrl" | "flows.authorizationCode.clientSecret" | `flows.authorizationCode.scopes.${string}` | `flows.authorizationCode.selectedScopes.${number}` | "flows.authorizationCode.authorizationUrl" | "flows.authorizationCode.x-scalar-redirect-uri" | "flows.authorizationCode.x-usePkce">(uid: (string & import("zod").BRAND<"securityScheme">) | null | undefined, path: P, value: (P extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" ? {
|
|
2890
2755
|
type: "apiKey";
|
|
2891
2756
|
value: string;
|
|
2892
2757
|
uid: string & import("zod").BRAND<"securityScheme">;
|
|
@@ -2958,7 +2823,7 @@ declare const client: import("vue").Ref<{
|
|
|
2958
2823
|
nameKey: string;
|
|
2959
2824
|
openIdConnectUrl: string;
|
|
2960
2825
|
description?: string | undefined;
|
|
2961
|
-
}[K], R_2> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "flows" ? {
|
|
2826
|
+
}[K], R_2> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "x-default-scopes" | "flows" ? {
|
|
2962
2827
|
type: "oauth2";
|
|
2963
2828
|
uid: string & import("zod").BRAND<"securityScheme">;
|
|
2964
2829
|
nameKey: string;
|
|
@@ -3010,7 +2875,8 @@ declare const client: import("vue").Ref<{
|
|
|
3010
2875
|
} | undefined;
|
|
3011
2876
|
};
|
|
3012
2877
|
description?: string | undefined;
|
|
3013
|
-
|
|
2878
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
2879
|
+
}[P] : P extends `${infer K}.${infer R_3}` ? K extends "description" | "type" | "uid" | "nameKey" | "x-default-scopes" | "flows" ? R_3 extends import("@scalar/object-utils/nested").Path<{
|
|
3014
2880
|
type: "oauth2";
|
|
3015
2881
|
uid: string & import("zod").BRAND<"securityScheme">;
|
|
3016
2882
|
nameKey: string;
|
|
@@ -3062,6 +2928,7 @@ declare const client: import("vue").Ref<{
|
|
|
3062
2928
|
} | undefined;
|
|
3063
2929
|
};
|
|
3064
2930
|
description?: string | undefined;
|
|
2931
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
3065
2932
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
3066
2933
|
type: "oauth2";
|
|
3067
2934
|
uid: string & import("zod").BRAND<"securityScheme">;
|
|
@@ -3114,8 +2981,9 @@ declare const client: import("vue").Ref<{
|
|
|
3114
2981
|
} | undefined;
|
|
3115
2982
|
};
|
|
3116
2983
|
description?: string | undefined;
|
|
2984
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
3117
2985
|
}[K], R_3> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never)) => void;
|
|
3118
|
-
untrackedEdit: <P extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "openIdConnectUrl" | "flows" | "password" | "username" | "token" | "flows.password" | "flows.implicit" | "flows.clientCredentials" | "flows.authorizationCode" | "flows.password.type" | "flows.password.password" | "flows.password.username" | "flows.password.token" | "flows.password.refreshUrl" | "flows.password.scopes" | "flows.password.selectedScopes" | "flows.password.x-scalar-client-id" | "flows.password.tokenUrl" | "flows.password.clientSecret" | `flows.password.scopes.${string}` | `flows.password.selectedScopes.${number}` | "flows.implicit.type" | "flows.implicit.token" | "flows.implicit.refreshUrl" | "flows.implicit.scopes" | "flows.implicit.selectedScopes" | "flows.implicit.x-scalar-client-id" | `flows.implicit.scopes.${string}` | `flows.implicit.selectedScopes.${number}` | "flows.implicit.authorizationUrl" | "flows.implicit.x-scalar-redirect-uri" | "flows.clientCredentials.type" | "flows.clientCredentials.token" | "flows.clientCredentials.refreshUrl" | "flows.clientCredentials.scopes" | "flows.clientCredentials.selectedScopes" | "flows.clientCredentials.x-scalar-client-id" | "flows.clientCredentials.tokenUrl" | "flows.clientCredentials.clientSecret" | `flows.clientCredentials.scopes.${string}` | `flows.clientCredentials.selectedScopes.${number}` | "flows.authorizationCode.type" | "flows.authorizationCode.token" | "flows.authorizationCode.refreshUrl" | "flows.authorizationCode.scopes" | "flows.authorizationCode.selectedScopes" | "flows.authorizationCode.x-scalar-client-id" | "flows.authorizationCode.tokenUrl" | "flows.authorizationCode.clientSecret" | `flows.authorizationCode.scopes.${string}` | `flows.authorizationCode.selectedScopes.${number}` | "flows.authorizationCode.authorizationUrl" | "flows.authorizationCode.x-scalar-redirect-uri" | "flows.authorizationCode.x-usePkce">(uid: string & import("zod").BRAND<"securityScheme">, path: P, value: (P extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" ? {
|
|
2986
|
+
untrackedEdit: <P extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "openIdConnectUrl" | "x-default-scopes" | "flows" | "password" | "username" | "token" | `x-default-scopes.${number}` | "flows.password" | "flows.implicit" | "flows.clientCredentials" | "flows.authorizationCode" | "flows.password.type" | "flows.password.password" | "flows.password.username" | "flows.password.token" | "flows.password.refreshUrl" | "flows.password.scopes" | "flows.password.selectedScopes" | "flows.password.x-scalar-client-id" | "flows.password.tokenUrl" | "flows.password.clientSecret" | `flows.password.scopes.${string}` | `flows.password.selectedScopes.${number}` | "flows.implicit.type" | "flows.implicit.token" | "flows.implicit.refreshUrl" | "flows.implicit.scopes" | "flows.implicit.selectedScopes" | "flows.implicit.x-scalar-client-id" | `flows.implicit.scopes.${string}` | `flows.implicit.selectedScopes.${number}` | "flows.implicit.authorizationUrl" | "flows.implicit.x-scalar-redirect-uri" | "flows.clientCredentials.type" | "flows.clientCredentials.token" | "flows.clientCredentials.refreshUrl" | "flows.clientCredentials.scopes" | "flows.clientCredentials.selectedScopes" | "flows.clientCredentials.x-scalar-client-id" | "flows.clientCredentials.tokenUrl" | "flows.clientCredentials.clientSecret" | `flows.clientCredentials.scopes.${string}` | `flows.clientCredentials.selectedScopes.${number}` | "flows.authorizationCode.type" | "flows.authorizationCode.token" | "flows.authorizationCode.refreshUrl" | "flows.authorizationCode.scopes" | "flows.authorizationCode.selectedScopes" | "flows.authorizationCode.x-scalar-client-id" | "flows.authorizationCode.tokenUrl" | "flows.authorizationCode.clientSecret" | `flows.authorizationCode.scopes.${string}` | `flows.authorizationCode.selectedScopes.${number}` | "flows.authorizationCode.authorizationUrl" | "flows.authorizationCode.x-scalar-redirect-uri" | "flows.authorizationCode.x-usePkce">(uid: string & import("zod").BRAND<"securityScheme">, path: P, value: (P extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" ? {
|
|
3119
2987
|
type: "apiKey";
|
|
3120
2988
|
value: string;
|
|
3121
2989
|
uid: string & import("zod").BRAND<"securityScheme">;
|
|
@@ -3187,7 +3055,7 @@ declare const client: import("vue").Ref<{
|
|
|
3187
3055
|
nameKey: string;
|
|
3188
3056
|
openIdConnectUrl: string;
|
|
3189
3057
|
description?: string | undefined;
|
|
3190
|
-
}[K], R_2> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "flows" ? {
|
|
3058
|
+
}[K], R_2> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "x-default-scopes" | "flows" ? {
|
|
3191
3059
|
type: "oauth2";
|
|
3192
3060
|
uid: string & import("zod").BRAND<"securityScheme">;
|
|
3193
3061
|
nameKey: string;
|
|
@@ -3239,7 +3107,8 @@ declare const client: import("vue").Ref<{
|
|
|
3239
3107
|
} | undefined;
|
|
3240
3108
|
};
|
|
3241
3109
|
description?: string | undefined;
|
|
3242
|
-
|
|
3110
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
3111
|
+
}[P] : P extends `${infer K}.${infer R_3}` ? K extends "description" | "type" | "uid" | "nameKey" | "x-default-scopes" | "flows" ? R_3 extends import("@scalar/object-utils/nested").Path<{
|
|
3243
3112
|
type: "oauth2";
|
|
3244
3113
|
uid: string & import("zod").BRAND<"securityScheme">;
|
|
3245
3114
|
nameKey: string;
|
|
@@ -3291,6 +3160,7 @@ declare const client: import("vue").Ref<{
|
|
|
3291
3160
|
} | undefined;
|
|
3292
3161
|
};
|
|
3293
3162
|
description?: string | undefined;
|
|
3163
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
3294
3164
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
3295
3165
|
type: "oauth2";
|
|
3296
3166
|
uid: string & import("zod").BRAND<"securityScheme">;
|
|
@@ -3343,6 +3213,7 @@ declare const client: import("vue").Ref<{
|
|
|
3343
3213
|
} | undefined;
|
|
3344
3214
|
};
|
|
3345
3215
|
description?: string | undefined;
|
|
3216
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
3346
3217
|
}[K], R_3> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never)) => void;
|
|
3347
3218
|
undo: (uid: string & import("zod").BRAND<"securityScheme">) => void;
|
|
3348
3219
|
redo: (uid: string & import("zod").BRAND<"securityScheme">) => void;
|
|
@@ -3824,6 +3695,7 @@ declare const client: import("vue").Ref<{
|
|
|
3824
3695
|
} | undefined;
|
|
3825
3696
|
};
|
|
3826
3697
|
description?: string | undefined;
|
|
3698
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
3827
3699
|
}>;
|
|
3828
3700
|
cookies: Record<string, {
|
|
3829
3701
|
uid: string & import("zod").BRAND<"cookie">;
|
|
@@ -4003,6 +3875,7 @@ declare const client: import("vue").Ref<{
|
|
|
4003
3875
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
4004
3876
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
4005
3877
|
watchMode: boolean;
|
|
3878
|
+
useCollectionSecurity: boolean;
|
|
4006
3879
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4007
3880
|
externalDocs?: {
|
|
4008
3881
|
url: string;
|
|
@@ -4202,9 +4075,10 @@ declare const client: import("vue").Ref<{
|
|
|
4202
4075
|
documentUrl?: string | undefined;
|
|
4203
4076
|
watchMode?: boolean | undefined;
|
|
4204
4077
|
integration?: string | null | undefined;
|
|
4078
|
+
useCollectionSecurity?: boolean | undefined;
|
|
4205
4079
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
4206
4080
|
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types/api-reference").ApiReferenceConfiguration, "servers" | "authentication" | "slug" | "baseServerURL"> & {
|
|
4207
|
-
|
|
4081
|
+
useCollectionSecurity?: boolean;
|
|
4208
4082
|
shouldLoad?: boolean;
|
|
4209
4083
|
} & Pick<import("@scalar/types/api-reference").ApiReferenceConfiguration, "servers">) => Promise<{
|
|
4210
4084
|
error: false;
|
|
@@ -4214,83 +4088,7 @@ declare const client: import("vue").Ref<{
|
|
|
4214
4088
|
examples: import("@scalar/oas-utils/entities/spec").RequestExample[];
|
|
4215
4089
|
servers: import("@scalar/oas-utils/entities/spec").Server[];
|
|
4216
4090
|
tags: import("@scalar/oas-utils/entities/spec").Tag[];
|
|
4217
|
-
securitySchemes: (
|
|
4218
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
4219
|
-
name: string;
|
|
4220
|
-
value: string;
|
|
4221
|
-
type: "apiKey";
|
|
4222
|
-
in: "cookie" | "query" | "header";
|
|
4223
|
-
nameKey: string;
|
|
4224
|
-
description?: string | undefined;
|
|
4225
|
-
} | {
|
|
4226
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
4227
|
-
type: "http";
|
|
4228
|
-
password: string;
|
|
4229
|
-
nameKey: string;
|
|
4230
|
-
scheme: "basic" | "bearer";
|
|
4231
|
-
bearerFormat: string;
|
|
4232
|
-
username: string;
|
|
4233
|
-
token: string;
|
|
4234
|
-
description?: string | undefined;
|
|
4235
|
-
} | {
|
|
4236
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
4237
|
-
type: "openIdConnect";
|
|
4238
|
-
nameKey: string;
|
|
4239
|
-
openIdConnectUrl: string;
|
|
4240
|
-
description?: string | undefined;
|
|
4241
|
-
} | {
|
|
4242
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
4243
|
-
type: "oauth2";
|
|
4244
|
-
nameKey: string;
|
|
4245
|
-
flows: {
|
|
4246
|
-
password?: {
|
|
4247
|
-
type: "password";
|
|
4248
|
-
password: string;
|
|
4249
|
-
username: string;
|
|
4250
|
-
token: string;
|
|
4251
|
-
refreshUrl: string;
|
|
4252
|
-
scopes: Record<string, string>;
|
|
4253
|
-
selectedScopes: string[];
|
|
4254
|
-
"x-scalar-client-id": string;
|
|
4255
|
-
tokenUrl: string;
|
|
4256
|
-
clientSecret: string;
|
|
4257
|
-
} | undefined;
|
|
4258
|
-
implicit?: {
|
|
4259
|
-
type: "implicit";
|
|
4260
|
-
token: string;
|
|
4261
|
-
refreshUrl: string;
|
|
4262
|
-
scopes: Record<string, string>;
|
|
4263
|
-
selectedScopes: string[];
|
|
4264
|
-
"x-scalar-client-id": string;
|
|
4265
|
-
authorizationUrl: string;
|
|
4266
|
-
"x-scalar-redirect-uri": string;
|
|
4267
|
-
} | undefined;
|
|
4268
|
-
clientCredentials?: {
|
|
4269
|
-
type: "clientCredentials";
|
|
4270
|
-
token: string;
|
|
4271
|
-
refreshUrl: string;
|
|
4272
|
-
scopes: Record<string, string>;
|
|
4273
|
-
selectedScopes: string[];
|
|
4274
|
-
"x-scalar-client-id": string;
|
|
4275
|
-
tokenUrl: string;
|
|
4276
|
-
clientSecret: string;
|
|
4277
|
-
} | undefined;
|
|
4278
|
-
authorizationCode?: {
|
|
4279
|
-
type: "authorizationCode";
|
|
4280
|
-
token: string;
|
|
4281
|
-
refreshUrl: string;
|
|
4282
|
-
scopes: Record<string, string>;
|
|
4283
|
-
selectedScopes: string[];
|
|
4284
|
-
"x-scalar-client-id": string;
|
|
4285
|
-
authorizationUrl: string;
|
|
4286
|
-
"x-scalar-redirect-uri": string;
|
|
4287
|
-
tokenUrl: string;
|
|
4288
|
-
clientSecret: string;
|
|
4289
|
-
"x-usePkce": "SHA-256" | "plain" | "no";
|
|
4290
|
-
} | undefined;
|
|
4291
|
-
};
|
|
4292
|
-
description?: string | undefined;
|
|
4293
|
-
})[];
|
|
4091
|
+
securitySchemes: import("@scalar/types/entities").SecurityScheme[];
|
|
4294
4092
|
} | undefined>;
|
|
4295
4093
|
importSpecFromUrl: (url: string, workspaceUid: string, { proxyUrl, ...options }?: Omit<Pick<{
|
|
4296
4094
|
uid?: string | undefined;
|
|
@@ -4329,9 +4127,10 @@ declare const client: import("vue").Ref<{
|
|
|
4329
4127
|
documentUrl?: string | undefined;
|
|
4330
4128
|
watchMode?: boolean | undefined;
|
|
4331
4129
|
integration?: string | null | undefined;
|
|
4130
|
+
useCollectionSecurity?: boolean | undefined;
|
|
4332
4131
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
4333
4132
|
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types/api-reference").ApiReferenceConfiguration, "servers" | "authentication" | "slug" | "baseServerURL"> & {
|
|
4334
|
-
|
|
4133
|
+
useCollectionSecurity?: boolean;
|
|
4335
4134
|
shouldLoad?: boolean;
|
|
4336
4135
|
} & Pick<import("@scalar/types/api-reference").ApiReferenceConfiguration, "servers">, "documentUrl"> & Pick<import("@scalar/types/api-reference").ApiReferenceConfiguration, "proxyUrl">) => Promise<import("@scalar/api-client/libs").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
|
|
4337
4136
|
uid?: string | undefined;
|
|
@@ -4370,9 +4169,10 @@ declare const client: import("vue").Ref<{
|
|
|
4370
4169
|
documentUrl?: string | undefined;
|
|
4371
4170
|
watchMode?: boolean | undefined;
|
|
4372
4171
|
integration?: string | null | undefined;
|
|
4172
|
+
useCollectionSecurity?: boolean | undefined;
|
|
4373
4173
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
4374
4174
|
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types/api-reference").ApiReferenceConfiguration, "servers" | "authentication" | "slug" | "baseServerURL"> & {
|
|
4375
|
-
|
|
4175
|
+
useCollectionSecurity?: boolean;
|
|
4376
4176
|
shouldLoad?: boolean;
|
|
4377
4177
|
} & Pick<import("@scalar/types/api-reference").ApiReferenceConfiguration, "servers">) => Promise<{
|
|
4378
4178
|
error: false;
|
|
@@ -4382,83 +4182,7 @@ declare const client: import("vue").Ref<{
|
|
|
4382
4182
|
examples: import("@scalar/oas-utils/entities/spec").RequestExample[];
|
|
4383
4183
|
servers: import("@scalar/oas-utils/entities/spec").Server[];
|
|
4384
4184
|
tags: import("@scalar/oas-utils/entities/spec").Tag[];
|
|
4385
|
-
securitySchemes: (
|
|
4386
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
4387
|
-
name: string;
|
|
4388
|
-
value: string;
|
|
4389
|
-
type: "apiKey";
|
|
4390
|
-
in: "cookie" | "query" | "header";
|
|
4391
|
-
nameKey: string;
|
|
4392
|
-
description?: string | undefined;
|
|
4393
|
-
} | {
|
|
4394
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
4395
|
-
type: "http";
|
|
4396
|
-
password: string;
|
|
4397
|
-
nameKey: string;
|
|
4398
|
-
scheme: "basic" | "bearer";
|
|
4399
|
-
bearerFormat: string;
|
|
4400
|
-
username: string;
|
|
4401
|
-
token: string;
|
|
4402
|
-
description?: string | undefined;
|
|
4403
|
-
} | {
|
|
4404
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
4405
|
-
type: "openIdConnect";
|
|
4406
|
-
nameKey: string;
|
|
4407
|
-
openIdConnectUrl: string;
|
|
4408
|
-
description?: string | undefined;
|
|
4409
|
-
} | {
|
|
4410
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
4411
|
-
type: "oauth2";
|
|
4412
|
-
nameKey: string;
|
|
4413
|
-
flows: {
|
|
4414
|
-
password?: {
|
|
4415
|
-
type: "password";
|
|
4416
|
-
password: string;
|
|
4417
|
-
username: string;
|
|
4418
|
-
token: string;
|
|
4419
|
-
refreshUrl: string;
|
|
4420
|
-
scopes: Record<string, string>;
|
|
4421
|
-
selectedScopes: string[];
|
|
4422
|
-
"x-scalar-client-id": string;
|
|
4423
|
-
tokenUrl: string;
|
|
4424
|
-
clientSecret: string;
|
|
4425
|
-
} | undefined;
|
|
4426
|
-
implicit?: {
|
|
4427
|
-
type: "implicit";
|
|
4428
|
-
token: string;
|
|
4429
|
-
refreshUrl: string;
|
|
4430
|
-
scopes: Record<string, string>;
|
|
4431
|
-
selectedScopes: string[];
|
|
4432
|
-
"x-scalar-client-id": string;
|
|
4433
|
-
authorizationUrl: string;
|
|
4434
|
-
"x-scalar-redirect-uri": string;
|
|
4435
|
-
} | undefined;
|
|
4436
|
-
clientCredentials?: {
|
|
4437
|
-
type: "clientCredentials";
|
|
4438
|
-
token: string;
|
|
4439
|
-
refreshUrl: string;
|
|
4440
|
-
scopes: Record<string, string>;
|
|
4441
|
-
selectedScopes: string[];
|
|
4442
|
-
"x-scalar-client-id": string;
|
|
4443
|
-
tokenUrl: string;
|
|
4444
|
-
clientSecret: string;
|
|
4445
|
-
} | undefined;
|
|
4446
|
-
authorizationCode?: {
|
|
4447
|
-
type: "authorizationCode";
|
|
4448
|
-
token: string;
|
|
4449
|
-
refreshUrl: string;
|
|
4450
|
-
scopes: Record<string, string>;
|
|
4451
|
-
selectedScopes: string[];
|
|
4452
|
-
"x-scalar-client-id": string;
|
|
4453
|
-
authorizationUrl: string;
|
|
4454
|
-
"x-scalar-redirect-uri": string;
|
|
4455
|
-
tokenUrl: string;
|
|
4456
|
-
clientSecret: string;
|
|
4457
|
-
"x-usePkce": "SHA-256" | "plain" | "no";
|
|
4458
|
-
} | undefined;
|
|
4459
|
-
};
|
|
4460
|
-
description?: string | undefined;
|
|
4461
|
-
})[];
|
|
4185
|
+
securitySchemes: import("@scalar/types/entities").SecurityScheme[];
|
|
4462
4186
|
} | undefined>>>>>;
|
|
4463
4187
|
cookieMutators: {
|
|
4464
4188
|
add: (item: {
|
|
@@ -4549,6 +4273,7 @@ declare const client: import("vue").Ref<{
|
|
|
4549
4273
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
4550
4274
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
4551
4275
|
watchMode: boolean;
|
|
4276
|
+
useCollectionSecurity: boolean;
|
|
4552
4277
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4553
4278
|
externalDocs?: {
|
|
4554
4279
|
url: string;
|
|
@@ -4604,6 +4329,7 @@ declare const client: import("vue").Ref<{
|
|
|
4604
4329
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
4605
4330
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
4606
4331
|
watchMode: boolean;
|
|
4332
|
+
useCollectionSecurity: boolean;
|
|
4607
4333
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4608
4334
|
externalDocs?: {
|
|
4609
4335
|
url: string;
|
|
@@ -4662,6 +4388,7 @@ declare const client: import("vue").Ref<{
|
|
|
4662
4388
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
4663
4389
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
4664
4390
|
watchMode: boolean;
|
|
4391
|
+
useCollectionSecurity: boolean;
|
|
4665
4392
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4666
4393
|
externalDocs?: {
|
|
4667
4394
|
url: string;
|
|
@@ -4687,7 +4414,7 @@ declare const client: import("vue").Ref<{
|
|
|
4687
4414
|
documentUrl?: string | undefined;
|
|
4688
4415
|
integration?: string | null | undefined;
|
|
4689
4416
|
}) => void;
|
|
4690
|
-
edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: (string & import("zod").BRAND<"collection">) | null | undefined, path: P, value: P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
|
|
4417
|
+
edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: (string & import("zod").BRAND<"collection">) | null | undefined, path: P, value: P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
|
|
4691
4418
|
uid: string & import("zod").BRAND<"collection">;
|
|
4692
4419
|
type: "collection";
|
|
4693
4420
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -4717,6 +4444,7 @@ declare const client: import("vue").Ref<{
|
|
|
4717
4444
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
4718
4445
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
4719
4446
|
watchMode: boolean;
|
|
4447
|
+
useCollectionSecurity: boolean;
|
|
4720
4448
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4721
4449
|
externalDocs?: {
|
|
4722
4450
|
url: string;
|
|
@@ -4741,7 +4469,7 @@ declare const client: import("vue").Ref<{
|
|
|
4741
4469
|
selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
|
|
4742
4470
|
documentUrl?: string | undefined;
|
|
4743
4471
|
integration?: string | null | undefined;
|
|
4744
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
4472
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
4745
4473
|
uid: string & import("zod").BRAND<"collection">;
|
|
4746
4474
|
type: "collection";
|
|
4747
4475
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -4771,6 +4499,7 @@ declare const client: import("vue").Ref<{
|
|
|
4771
4499
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
4772
4500
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
4773
4501
|
watchMode: boolean;
|
|
4502
|
+
useCollectionSecurity: boolean;
|
|
4774
4503
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4775
4504
|
externalDocs?: {
|
|
4776
4505
|
url: string;
|
|
@@ -4825,6 +4554,7 @@ declare const client: import("vue").Ref<{
|
|
|
4825
4554
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
4826
4555
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
4827
4556
|
watchMode: boolean;
|
|
4557
|
+
useCollectionSecurity: boolean;
|
|
4828
4558
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4829
4559
|
externalDocs?: {
|
|
4830
4560
|
url: string;
|
|
@@ -4850,7 +4580,7 @@ declare const client: import("vue").Ref<{
|
|
|
4850
4580
|
documentUrl?: string | undefined;
|
|
4851
4581
|
integration?: string | null | undefined;
|
|
4852
4582
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
4853
|
-
untrackedEdit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string & import("zod").BRAND<"collection">, path: P, value: P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
|
|
4583
|
+
untrackedEdit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string & import("zod").BRAND<"collection">, path: P, value: P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
|
|
4854
4584
|
uid: string & import("zod").BRAND<"collection">;
|
|
4855
4585
|
type: "collection";
|
|
4856
4586
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -4880,6 +4610,7 @@ declare const client: import("vue").Ref<{
|
|
|
4880
4610
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
4881
4611
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
4882
4612
|
watchMode: boolean;
|
|
4613
|
+
useCollectionSecurity: boolean;
|
|
4883
4614
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4884
4615
|
externalDocs?: {
|
|
4885
4616
|
url: string;
|
|
@@ -4904,7 +4635,7 @@ declare const client: import("vue").Ref<{
|
|
|
4904
4635
|
selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
|
|
4905
4636
|
documentUrl?: string | undefined;
|
|
4906
4637
|
integration?: string | null | undefined;
|
|
4907
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
4638
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
4908
4639
|
uid: string & import("zod").BRAND<"collection">;
|
|
4909
4640
|
type: "collection";
|
|
4910
4641
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -4934,6 +4665,7 @@ declare const client: import("vue").Ref<{
|
|
|
4934
4665
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
4935
4666
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
4936
4667
|
watchMode: boolean;
|
|
4668
|
+
useCollectionSecurity: boolean;
|
|
4937
4669
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4938
4670
|
externalDocs?: {
|
|
4939
4671
|
url: string;
|
|
@@ -4988,6 +4720,7 @@ declare const client: import("vue").Ref<{
|
|
|
4988
4720
|
requests: (string & import("zod").BRAND<"operation">)[];
|
|
4989
4721
|
tags: (string & import("zod").BRAND<"tag">)[];
|
|
4990
4722
|
watchMode: boolean;
|
|
4723
|
+
useCollectionSecurity: boolean;
|
|
4991
4724
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4992
4725
|
externalDocs?: {
|
|
4993
4726
|
url: string;
|
|
@@ -6426,6 +6159,7 @@ declare const client: import("vue").Ref<{
|
|
|
6426
6159
|
} | undefined;
|
|
6427
6160
|
};
|
|
6428
6161
|
description?: string | undefined;
|
|
6162
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
6429
6163
|
}) => void;
|
|
6430
6164
|
add: (payload: import("@scalar/types/entities").SecuritySchemePayload, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => {
|
|
6431
6165
|
type: "apiKey";
|
|
@@ -6503,6 +6237,7 @@ declare const client: import("vue").Ref<{
|
|
|
6503
6237
|
} | undefined;
|
|
6504
6238
|
};
|
|
6505
6239
|
description?: string | undefined;
|
|
6240
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
6506
6241
|
};
|
|
6507
6242
|
delete: (schemeUid: import("@scalar/types/entities").SecurityScheme["uid"]) => void;
|
|
6508
6243
|
set: (item: {
|
|
@@ -6581,8 +6316,9 @@ declare const client: import("vue").Ref<{
|
|
|
6581
6316
|
} | undefined;
|
|
6582
6317
|
};
|
|
6583
6318
|
description?: string | undefined;
|
|
6319
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
6584
6320
|
}) => void;
|
|
6585
|
-
edit: <P extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "openIdConnectUrl" | "flows" | "password" | "username" | "token" | "flows.password" | "flows.implicit" | "flows.clientCredentials" | "flows.authorizationCode" | "flows.password.type" | "flows.password.password" | "flows.password.username" | "flows.password.token" | "flows.password.refreshUrl" | "flows.password.scopes" | "flows.password.selectedScopes" | "flows.password.x-scalar-client-id" | "flows.password.tokenUrl" | "flows.password.clientSecret" | `flows.password.scopes.${string}` | `flows.password.selectedScopes.${number}` | "flows.implicit.type" | "flows.implicit.token" | "flows.implicit.refreshUrl" | "flows.implicit.scopes" | "flows.implicit.selectedScopes" | "flows.implicit.x-scalar-client-id" | `flows.implicit.scopes.${string}` | `flows.implicit.selectedScopes.${number}` | "flows.implicit.authorizationUrl" | "flows.implicit.x-scalar-redirect-uri" | "flows.clientCredentials.type" | "flows.clientCredentials.token" | "flows.clientCredentials.refreshUrl" | "flows.clientCredentials.scopes" | "flows.clientCredentials.selectedScopes" | "flows.clientCredentials.x-scalar-client-id" | "flows.clientCredentials.tokenUrl" | "flows.clientCredentials.clientSecret" | `flows.clientCredentials.scopes.${string}` | `flows.clientCredentials.selectedScopes.${number}` | "flows.authorizationCode.type" | "flows.authorizationCode.token" | "flows.authorizationCode.refreshUrl" | "flows.authorizationCode.scopes" | "flows.authorizationCode.selectedScopes" | "flows.authorizationCode.x-scalar-client-id" | "flows.authorizationCode.tokenUrl" | "flows.authorizationCode.clientSecret" | `flows.authorizationCode.scopes.${string}` | `flows.authorizationCode.selectedScopes.${number}` | "flows.authorizationCode.authorizationUrl" | "flows.authorizationCode.x-scalar-redirect-uri" | "flows.authorizationCode.x-usePkce">(uid: (string & import("zod").BRAND<"securityScheme">) | null | undefined, path: P, value: (P extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" ? {
|
|
6321
|
+
edit: <P extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "openIdConnectUrl" | "x-default-scopes" | "flows" | "password" | "username" | "token" | `x-default-scopes.${number}` | "flows.password" | "flows.implicit" | "flows.clientCredentials" | "flows.authorizationCode" | "flows.password.type" | "flows.password.password" | "flows.password.username" | "flows.password.token" | "flows.password.refreshUrl" | "flows.password.scopes" | "flows.password.selectedScopes" | "flows.password.x-scalar-client-id" | "flows.password.tokenUrl" | "flows.password.clientSecret" | `flows.password.scopes.${string}` | `flows.password.selectedScopes.${number}` | "flows.implicit.type" | "flows.implicit.token" | "flows.implicit.refreshUrl" | "flows.implicit.scopes" | "flows.implicit.selectedScopes" | "flows.implicit.x-scalar-client-id" | `flows.implicit.scopes.${string}` | `flows.implicit.selectedScopes.${number}` | "flows.implicit.authorizationUrl" | "flows.implicit.x-scalar-redirect-uri" | "flows.clientCredentials.type" | "flows.clientCredentials.token" | "flows.clientCredentials.refreshUrl" | "flows.clientCredentials.scopes" | "flows.clientCredentials.selectedScopes" | "flows.clientCredentials.x-scalar-client-id" | "flows.clientCredentials.tokenUrl" | "flows.clientCredentials.clientSecret" | `flows.clientCredentials.scopes.${string}` | `flows.clientCredentials.selectedScopes.${number}` | "flows.authorizationCode.type" | "flows.authorizationCode.token" | "flows.authorizationCode.refreshUrl" | "flows.authorizationCode.scopes" | "flows.authorizationCode.selectedScopes" | "flows.authorizationCode.x-scalar-client-id" | "flows.authorizationCode.tokenUrl" | "flows.authorizationCode.clientSecret" | `flows.authorizationCode.scopes.${string}` | `flows.authorizationCode.selectedScopes.${number}` | "flows.authorizationCode.authorizationUrl" | "flows.authorizationCode.x-scalar-redirect-uri" | "flows.authorizationCode.x-usePkce">(uid: (string & import("zod").BRAND<"securityScheme">) | null | undefined, path: P, value: (P extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" ? {
|
|
6586
6322
|
type: "apiKey";
|
|
6587
6323
|
value: string;
|
|
6588
6324
|
uid: string & import("zod").BRAND<"securityScheme">;
|
|
@@ -6654,7 +6390,7 @@ declare const client: import("vue").Ref<{
|
|
|
6654
6390
|
nameKey: string;
|
|
6655
6391
|
openIdConnectUrl: string;
|
|
6656
6392
|
description?: string | undefined;
|
|
6657
|
-
}[K], R_2> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "flows" ? {
|
|
6393
|
+
}[K], R_2> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "x-default-scopes" | "flows" ? {
|
|
6658
6394
|
type: "oauth2";
|
|
6659
6395
|
uid: string & import("zod").BRAND<"securityScheme">;
|
|
6660
6396
|
nameKey: string;
|
|
@@ -6706,7 +6442,8 @@ declare const client: import("vue").Ref<{
|
|
|
6706
6442
|
} | undefined;
|
|
6707
6443
|
};
|
|
6708
6444
|
description?: string | undefined;
|
|
6709
|
-
|
|
6445
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
6446
|
+
}[P] : P extends `${infer K}.${infer R_3}` ? K extends "description" | "type" | "uid" | "nameKey" | "x-default-scopes" | "flows" ? R_3 extends import("@scalar/object-utils/nested").Path<{
|
|
6710
6447
|
type: "oauth2";
|
|
6711
6448
|
uid: string & import("zod").BRAND<"securityScheme">;
|
|
6712
6449
|
nameKey: string;
|
|
@@ -6758,6 +6495,7 @@ declare const client: import("vue").Ref<{
|
|
|
6758
6495
|
} | undefined;
|
|
6759
6496
|
};
|
|
6760
6497
|
description?: string | undefined;
|
|
6498
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
6761
6499
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6762
6500
|
type: "oauth2";
|
|
6763
6501
|
uid: string & import("zod").BRAND<"securityScheme">;
|
|
@@ -6810,8 +6548,9 @@ declare const client: import("vue").Ref<{
|
|
|
6810
6548
|
} | undefined;
|
|
6811
6549
|
};
|
|
6812
6550
|
description?: string | undefined;
|
|
6551
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
6813
6552
|
}[K], R_3> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never)) => void;
|
|
6814
|
-
untrackedEdit: <P extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "openIdConnectUrl" | "flows" | "password" | "username" | "token" | "flows.password" | "flows.implicit" | "flows.clientCredentials" | "flows.authorizationCode" | "flows.password.type" | "flows.password.password" | "flows.password.username" | "flows.password.token" | "flows.password.refreshUrl" | "flows.password.scopes" | "flows.password.selectedScopes" | "flows.password.x-scalar-client-id" | "flows.password.tokenUrl" | "flows.password.clientSecret" | `flows.password.scopes.${string}` | `flows.password.selectedScopes.${number}` | "flows.implicit.type" | "flows.implicit.token" | "flows.implicit.refreshUrl" | "flows.implicit.scopes" | "flows.implicit.selectedScopes" | "flows.implicit.x-scalar-client-id" | `flows.implicit.scopes.${string}` | `flows.implicit.selectedScopes.${number}` | "flows.implicit.authorizationUrl" | "flows.implicit.x-scalar-redirect-uri" | "flows.clientCredentials.type" | "flows.clientCredentials.token" | "flows.clientCredentials.refreshUrl" | "flows.clientCredentials.scopes" | "flows.clientCredentials.selectedScopes" | "flows.clientCredentials.x-scalar-client-id" | "flows.clientCredentials.tokenUrl" | "flows.clientCredentials.clientSecret" | `flows.clientCredentials.scopes.${string}` | `flows.clientCredentials.selectedScopes.${number}` | "flows.authorizationCode.type" | "flows.authorizationCode.token" | "flows.authorizationCode.refreshUrl" | "flows.authorizationCode.scopes" | "flows.authorizationCode.selectedScopes" | "flows.authorizationCode.x-scalar-client-id" | "flows.authorizationCode.tokenUrl" | "flows.authorizationCode.clientSecret" | `flows.authorizationCode.scopes.${string}` | `flows.authorizationCode.selectedScopes.${number}` | "flows.authorizationCode.authorizationUrl" | "flows.authorizationCode.x-scalar-redirect-uri" | "flows.authorizationCode.x-usePkce">(uid: string & import("zod").BRAND<"securityScheme">, path: P, value: (P extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" ? {
|
|
6553
|
+
untrackedEdit: <P extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "openIdConnectUrl" | "x-default-scopes" | "flows" | "password" | "username" | "token" | `x-default-scopes.${number}` | "flows.password" | "flows.implicit" | "flows.clientCredentials" | "flows.authorizationCode" | "flows.password.type" | "flows.password.password" | "flows.password.username" | "flows.password.token" | "flows.password.refreshUrl" | "flows.password.scopes" | "flows.password.selectedScopes" | "flows.password.x-scalar-client-id" | "flows.password.tokenUrl" | "flows.password.clientSecret" | `flows.password.scopes.${string}` | `flows.password.selectedScopes.${number}` | "flows.implicit.type" | "flows.implicit.token" | "flows.implicit.refreshUrl" | "flows.implicit.scopes" | "flows.implicit.selectedScopes" | "flows.implicit.x-scalar-client-id" | `flows.implicit.scopes.${string}` | `flows.implicit.selectedScopes.${number}` | "flows.implicit.authorizationUrl" | "flows.implicit.x-scalar-redirect-uri" | "flows.clientCredentials.type" | "flows.clientCredentials.token" | "flows.clientCredentials.refreshUrl" | "flows.clientCredentials.scopes" | "flows.clientCredentials.selectedScopes" | "flows.clientCredentials.x-scalar-client-id" | "flows.clientCredentials.tokenUrl" | "flows.clientCredentials.clientSecret" | `flows.clientCredentials.scopes.${string}` | `flows.clientCredentials.selectedScopes.${number}` | "flows.authorizationCode.type" | "flows.authorizationCode.token" | "flows.authorizationCode.refreshUrl" | "flows.authorizationCode.scopes" | "flows.authorizationCode.selectedScopes" | "flows.authorizationCode.x-scalar-client-id" | "flows.authorizationCode.tokenUrl" | "flows.authorizationCode.clientSecret" | `flows.authorizationCode.scopes.${string}` | `flows.authorizationCode.selectedScopes.${number}` | "flows.authorizationCode.authorizationUrl" | "flows.authorizationCode.x-scalar-redirect-uri" | "flows.authorizationCode.x-usePkce">(uid: string & import("zod").BRAND<"securityScheme">, path: P, value: (P extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" ? {
|
|
6815
6554
|
type: "apiKey";
|
|
6816
6555
|
value: string;
|
|
6817
6556
|
uid: string & import("zod").BRAND<"securityScheme">;
|
|
@@ -6883,7 +6622,7 @@ declare const client: import("vue").Ref<{
|
|
|
6883
6622
|
nameKey: string;
|
|
6884
6623
|
openIdConnectUrl: string;
|
|
6885
6624
|
description?: string | undefined;
|
|
6886
|
-
}[K], R_2> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "flows" ? {
|
|
6625
|
+
}[K], R_2> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "x-default-scopes" | "flows" ? {
|
|
6887
6626
|
type: "oauth2";
|
|
6888
6627
|
uid: string & import("zod").BRAND<"securityScheme">;
|
|
6889
6628
|
nameKey: string;
|
|
@@ -6935,7 +6674,8 @@ declare const client: import("vue").Ref<{
|
|
|
6935
6674
|
} | undefined;
|
|
6936
6675
|
};
|
|
6937
6676
|
description?: string | undefined;
|
|
6938
|
-
|
|
6677
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
6678
|
+
}[P] : P extends `${infer K}.${infer R_3}` ? K extends "description" | "type" | "uid" | "nameKey" | "x-default-scopes" | "flows" ? R_3 extends import("@scalar/object-utils/nested").Path<{
|
|
6939
6679
|
type: "oauth2";
|
|
6940
6680
|
uid: string & import("zod").BRAND<"securityScheme">;
|
|
6941
6681
|
nameKey: string;
|
|
@@ -6987,6 +6727,7 @@ declare const client: import("vue").Ref<{
|
|
|
6987
6727
|
} | undefined;
|
|
6988
6728
|
};
|
|
6989
6729
|
description?: string | undefined;
|
|
6730
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
6990
6731
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6991
6732
|
type: "oauth2";
|
|
6992
6733
|
uid: string & import("zod").BRAND<"securityScheme">;
|
|
@@ -7039,6 +6780,7 @@ declare const client: import("vue").Ref<{
|
|
|
7039
6780
|
} | undefined;
|
|
7040
6781
|
};
|
|
7041
6782
|
description?: string | undefined;
|
|
6783
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
7042
6784
|
}[K], R_3> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never)) => void;
|
|
7043
6785
|
undo: (uid: string & import("zod").BRAND<"securityScheme">) => void;
|
|
7044
6786
|
redo: (uid: string & import("zod").BRAND<"securityScheme">) => void;
|