@scalar/api-reference 1.28.27 → 1.28.28

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.
@@ -54,8 +54,8 @@ declare const client: import("vue").Ref<{
54
54
  }>;
55
55
  securitySchemes: Record<string, {
56
56
  name: string;
57
- type: "apiKey";
58
57
  value: string;
58
+ type: "apiKey";
59
59
  uid: string & import("zod").BRAND<"securityScheme">;
60
60
  nameKey: string;
61
61
  in: "cookie" | "query" | "header";
@@ -2718,8 +2718,8 @@ declare const client: import("vue").Ref<{
2718
2718
  securitySchemeMutators: {
2719
2719
  rawAdd: (item: {
2720
2720
  name: string;
2721
- type: "apiKey";
2722
2721
  value: string;
2722
+ type: "apiKey";
2723
2723
  uid: string & import("zod").BRAND<"securityScheme">;
2724
2724
  nameKey: string;
2725
2725
  in: "cookie" | "query" | "header";
@@ -2796,8 +2796,8 @@ declare const client: import("vue").Ref<{
2796
2796
  }) => void;
2797
2797
  add: (payload: import("@scalar/types/entities").SecuritySchemePayload, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => {
2798
2798
  name: string;
2799
- type: "apiKey";
2800
2799
  value: string;
2800
+ type: "apiKey";
2801
2801
  uid: string & import("zod").BRAND<"securityScheme">;
2802
2802
  nameKey: string;
2803
2803
  in: "cookie" | "query" | "header";
@@ -2875,8 +2875,8 @@ declare const client: import("vue").Ref<{
2875
2875
  delete: (schemeUid: import("@scalar/types/entities").SecurityScheme["uid"]) => void;
2876
2876
  set: (item: {
2877
2877
  name: string;
2878
- type: "apiKey";
2879
2878
  value: string;
2879
+ type: "apiKey";
2880
2880
  uid: string & import("zod").BRAND<"securityScheme">;
2881
2881
  nameKey: string;
2882
2882
  in: "cookie" | "query" | "header";
@@ -2953,24 +2953,24 @@ declare const client: import("vue").Ref<{
2953
2953
  }) => void;
2954
2954
  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" ? {
2955
2955
  name: string;
2956
- type: "apiKey";
2957
2956
  value: string;
2957
+ type: "apiKey";
2958
2958
  uid: string & import("zod").BRAND<"securityScheme">;
2959
2959
  nameKey: string;
2960
2960
  in: "cookie" | "query" | "header";
2961
2961
  description?: string | undefined;
2962
2962
  }[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" ? R extends import("@scalar/object-utils/nested").Path<{
2963
2963
  name: string;
2964
- type: "apiKey";
2965
2964
  value: string;
2965
+ type: "apiKey";
2966
2966
  uid: string & import("zod").BRAND<"securityScheme">;
2967
2967
  nameKey: string;
2968
2968
  in: "cookie" | "query" | "header";
2969
2969
  description?: string | undefined;
2970
2970
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
2971
2971
  name: string;
2972
- type: "apiKey";
2973
2972
  value: string;
2973
+ type: "apiKey";
2974
2974
  uid: string & import("zod").BRAND<"securityScheme">;
2975
2975
  nameKey: string;
2976
2976
  in: "cookie" | "query" | "header";
@@ -3185,24 +3185,24 @@ declare const client: import("vue").Ref<{
3185
3185
  }[K], R_3> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never)) => void;
3186
3186
  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" ? {
3187
3187
  name: string;
3188
- type: "apiKey";
3189
3188
  value: string;
3189
+ type: "apiKey";
3190
3190
  uid: string & import("zod").BRAND<"securityScheme">;
3191
3191
  nameKey: string;
3192
3192
  in: "cookie" | "query" | "header";
3193
3193
  description?: string | undefined;
3194
3194
  }[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" ? R extends import("@scalar/object-utils/nested").Path<{
3195
3195
  name: string;
3196
- type: "apiKey";
3197
3196
  value: string;
3197
+ type: "apiKey";
3198
3198
  uid: string & import("zod").BRAND<"securityScheme">;
3199
3199
  nameKey: string;
3200
3200
  in: "cookie" | "query" | "header";
3201
3201
  description?: string | undefined;
3202
3202
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
3203
3203
  name: string;
3204
- type: "apiKey";
3205
3204
  value: string;
3205
+ type: "apiKey";
3206
3206
  uid: string & import("zod").BRAND<"securityScheme">;
3207
3207
  nameKey: string;
3208
3208
  in: "cookie" | "query" | "header";
@@ -3821,8 +3821,8 @@ declare const client: import("vue").Ref<{
3821
3821
  }>;
3822
3822
  securitySchemes: Record<string, {
3823
3823
  name: string;
3824
- type: "apiKey";
3825
3824
  value: string;
3825
+ type: "apiKey";
3826
3826
  uid: string & import("zod").BRAND<"securityScheme">;
3827
3827
  nameKey: string;
3828
3828
  in: "cookie" | "query" | "header";
@@ -6485,8 +6485,8 @@ declare const client: import("vue").Ref<{
6485
6485
  securitySchemeMutators: {
6486
6486
  rawAdd: (item: {
6487
6487
  name: string;
6488
- type: "apiKey";
6489
6488
  value: string;
6489
+ type: "apiKey";
6490
6490
  uid: string & import("zod").BRAND<"securityScheme">;
6491
6491
  nameKey: string;
6492
6492
  in: "cookie" | "query" | "header";
@@ -6563,8 +6563,8 @@ declare const client: import("vue").Ref<{
6563
6563
  }) => void;
6564
6564
  add: (payload: import("@scalar/types/entities").SecuritySchemePayload, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => {
6565
6565
  name: string;
6566
- type: "apiKey";
6567
6566
  value: string;
6567
+ type: "apiKey";
6568
6568
  uid: string & import("zod").BRAND<"securityScheme">;
6569
6569
  nameKey: string;
6570
6570
  in: "cookie" | "query" | "header";
@@ -6642,8 +6642,8 @@ declare const client: import("vue").Ref<{
6642
6642
  delete: (schemeUid: import("@scalar/types/entities").SecurityScheme["uid"]) => void;
6643
6643
  set: (item: {
6644
6644
  name: string;
6645
- type: "apiKey";
6646
6645
  value: string;
6646
+ type: "apiKey";
6647
6647
  uid: string & import("zod").BRAND<"securityScheme">;
6648
6648
  nameKey: string;
6649
6649
  in: "cookie" | "query" | "header";
@@ -6720,24 +6720,24 @@ declare const client: import("vue").Ref<{
6720
6720
  }) => void;
6721
6721
  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" ? {
6722
6722
  name: string;
6723
- type: "apiKey";
6724
6723
  value: string;
6724
+ type: "apiKey";
6725
6725
  uid: string & import("zod").BRAND<"securityScheme">;
6726
6726
  nameKey: string;
6727
6727
  in: "cookie" | "query" | "header";
6728
6728
  description?: string | undefined;
6729
6729
  }[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" ? R extends import("@scalar/object-utils/nested").Path<{
6730
6730
  name: string;
6731
- type: "apiKey";
6732
6731
  value: string;
6732
+ type: "apiKey";
6733
6733
  uid: string & import("zod").BRAND<"securityScheme">;
6734
6734
  nameKey: string;
6735
6735
  in: "cookie" | "query" | "header";
6736
6736
  description?: string | undefined;
6737
6737
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
6738
6738
  name: string;
6739
- type: "apiKey";
6740
6739
  value: string;
6740
+ type: "apiKey";
6741
6741
  uid: string & import("zod").BRAND<"securityScheme">;
6742
6742
  nameKey: string;
6743
6743
  in: "cookie" | "query" | "header";
@@ -6952,24 +6952,24 @@ declare const client: import("vue").Ref<{
6952
6952
  }[K], R_3> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never)) => void;
6953
6953
  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" ? {
6954
6954
  name: string;
6955
- type: "apiKey";
6956
6955
  value: string;
6956
+ type: "apiKey";
6957
6957
  uid: string & import("zod").BRAND<"securityScheme">;
6958
6958
  nameKey: string;
6959
6959
  in: "cookie" | "query" | "header";
6960
6960
  description?: string | undefined;
6961
6961
  }[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "description" | "type" | "name" | "in" | "uid" | "nameKey" ? R extends import("@scalar/object-utils/nested").Path<{
6962
6962
  name: string;
6963
- type: "apiKey";
6964
6963
  value: string;
6964
+ type: "apiKey";
6965
6965
  uid: string & import("zod").BRAND<"securityScheme">;
6966
6966
  nameKey: string;
6967
6967
  in: "cookie" | "query" | "header";
6968
6968
  description?: string | undefined;
6969
6969
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
6970
6970
  name: string;
6971
- type: "apiKey";
6972
6971
  value: string;
6972
+ type: "apiKey";
6973
6973
  uid: string & import("zod").BRAND<"securityScheme">;
6974
6974
  nameKey: string;
6975
6975
  in: "cookie" | "query" | "header";