@scalar/api-reference 1.29.3 → 1.31.0
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 +58 -0
- package/README.md +13 -114
- package/dist/browser/standalone.js +6525 -6416
- package/dist/browser/webpack-stats.json +1 -1
- package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
- package/dist/components/ApiReferenceLayout.vue.js +1 -1
- package/dist/components/ApiReferenceLayout.vue2.js +164 -181
- package/dist/components/Content/ClientLibraries/ClientLibraries.vue.d.ts.map +1 -1
- package/dist/components/Content/ClientLibraries/ClientLibraries.vue.js +2 -2
- package/dist/components/Content/ClientLibraries/ClientLibraries.vue2.js +56 -51
- package/dist/components/Content/Content.vue.d.ts.map +1 -1
- package/dist/components/Content/Content.vue.js +1 -1
- package/dist/components/Content/Content.vue2.js +5 -5
- package/dist/components/Content/Introduction/Introduction.vue.d.ts +2 -2
- package/dist/components/Content/Introduction/Introduction.vue.d.ts.map +1 -1
- package/dist/components/Content/Introduction/Introduction.vue.js +2 -2
- package/dist/components/Content/Introduction/Introduction.vue2.js +57 -63
- package/dist/components/Content/Lazy/Loading.vue.d.ts.map +1 -1
- package/dist/components/Content/Lazy/Loading.vue.js +46 -46
- package/dist/components/Content/Models/Models.vue.d.ts +2 -2
- 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/Models/Models.vue2.js +7 -6
- package/dist/components/Content/Models/ModelsAccordion.vue.d.ts +2 -2
- package/dist/components/Content/Models/ModelsAccordion.vue.d.ts.map +1 -1
- package/dist/components/Content/Models/ModelsAccordion.vue.js +2 -2
- package/dist/components/Content/Schema/Schema.preview.d.ts +98 -56
- package/dist/components/Content/Schema/Schema.preview.d.ts.map +1 -1
- package/dist/components/Content/Schema/Schema.vue.d.ts +6 -3
- package/dist/components/Content/Schema/Schema.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/Schema.vue.js +1 -1
- package/dist/components/Content/Schema/Schema.vue2.js +140 -97
- package/dist/components/Content/Schema/SchemaComposition.vue.d.ts +2 -2
- package/dist/components/Content/Schema/SchemaComposition.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/SchemaComposition.vue.js +57 -53
- package/dist/components/Content/Schema/SchemaDiscriminator.vue.d.ts +13 -0
- package/dist/components/Content/Schema/SchemaDiscriminator.vue.d.ts.map +1 -0
- package/dist/components/Content/Schema/SchemaDiscriminator.vue.js +49 -0
- package/dist/components/Content/Schema/SchemaDiscriminator.vue2.js +4 -0
- package/dist/components/Content/Schema/SchemaHeading.vue.d.ts +2 -2
- package/dist/components/Content/Schema/SchemaHeading.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/SchemaHeading.vue.js +1 -1
- package/dist/components/Content/Schema/SchemaProperty.vue.d.ts +4 -2
- package/dist/components/Content/Schema/SchemaProperty.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/SchemaProperty.vue.js +2 -2
- package/dist/components/Content/Schema/SchemaProperty.vue2.js +40 -38
- package/dist/components/Content/Schema/SchemaPropertyHeading.vue.d.ts +3 -2
- package/dist/components/Content/Schema/SchemaPropertyHeading.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/SchemaPropertyHeading.vue.js +2 -2
- package/dist/components/Content/Schema/SchemaPropertyHeading.vue2.js +147 -143
- package/dist/components/Content/Schema/helpers/merge-all-of-schemas.d.ts +2 -2
- package/dist/components/Content/Schema/helpers/merge-all-of-schemas.d.ts.map +1 -1
- package/dist/components/Content/Schema/helpers/schema-discriminator.d.ts +9 -1
- package/dist/components/Content/Schema/helpers/schema-discriminator.d.ts.map +1 -1
- package/dist/components/Content/Schema/helpers/schema-discriminator.js +45 -0
- package/dist/components/Content/Tag/TagList.vue.d.ts +2 -2
- package/dist/components/Content/Tag/TagList.vue.d.ts.map +1 -1
- package/dist/components/DocumentSelector/DocumentSelector.vue.js +3 -3
- package/dist/components/Layouts/ClassicLayout.vue.js +10 -8
- package/dist/components/Layouts/Layouts.vue.js +11 -9
- package/dist/components/Layouts/ModernLayout.vue2.js +22 -20
- package/dist/components/Section/SectionHeader.vue.d.ts.map +1 -1
- package/dist/components/Section/SectionHeader.vue.js +2 -2
- package/dist/components/Section/SectionHeaderTag.vue.d.ts.map +1 -1
- package/dist/components/Section/SectionHeaderTag.vue.js +2 -2
- package/dist/components/Sidebar/Sidebar.vue.d.ts.map +1 -1
- package/dist/components/Sidebar/Sidebar.vue.js +2 -2
- package/dist/components/Sidebar/Sidebar.vue2.js +56 -56
- package/dist/components/SingleApiReference.vue.d.ts.map +1 -1
- package/dist/components/SingleApiReference.vue.js +27 -33
- package/dist/esm.d.ts.map +1 -1
- package/dist/features/ApiClientModal/ApiClientModal.vue.d.ts +2 -2
- package/dist/features/ApiClientModal/ApiClientModal.vue.d.ts.map +1 -1
- package/dist/features/ApiClientModal/ApiClientModal.vue.js +49 -50
- package/dist/features/ApiClientModal/useApiClient.d.ts +224 -204
- package/dist/features/ApiClientModal/useApiClient.d.ts.map +1 -1
- package/dist/features/DocumentSource/hooks/useDocumentFetcher.d.ts +11 -0
- package/dist/features/DocumentSource/hooks/useDocumentFetcher.d.ts.map +1 -0
- package/dist/features/DocumentSource/hooks/useDocumentFetcher.js +38 -0
- package/dist/features/DocumentSource/hooks/useDocumentSource.d.ts +21 -0
- package/dist/features/DocumentSource/hooks/useDocumentSource.d.ts.map +1 -0
- package/dist/features/DocumentSource/hooks/useDocumentSource.js +94 -0
- package/dist/features/DocumentSource/index.d.ts +2 -0
- package/dist/features/DocumentSource/index.d.ts.map +1 -0
- package/dist/features/DownloadLink/DownloadLink.vue.d.ts +1 -1
- package/dist/features/DownloadLink/DownloadLink.vue.d.ts.map +1 -1
- package/dist/features/DownloadLink/DownloadLink.vue.js +1 -1
- package/dist/features/DownloadLink/DownloadLink.vue2.js +18 -17
- package/dist/features/DownloadLink/index.d.ts +1 -0
- package/dist/features/DownloadLink/index.d.ts.map +1 -1
- package/dist/features/DownloadLink/openapi-version-symbol.d.ts +2 -0
- package/dist/features/DownloadLink/openapi-version-symbol.d.ts.map +1 -0
- package/dist/features/DownloadLink/openapi-version-symbol.js +4 -0
- package/dist/features/Operation/Operation.vue.d.ts +2 -2
- package/dist/features/Operation/Operation.vue.d.ts.map +1 -1
- package/dist/features/Operation/components/OperationParameters.vue.d.ts +2 -2
- package/dist/features/Operation/components/OperationParameters.vue.d.ts.map +1 -1
- package/dist/features/Operation/components/OperationResponses.vue.d.ts +2 -2
- package/dist/features/Operation/components/OperationResponses.vue.d.ts.map +1 -1
- package/dist/features/Operation/components/ParameterHeaders.vue.d.ts +2 -2
- package/dist/features/Operation/components/ParameterHeaders.vue.d.ts.map +1 -1
- package/dist/features/Operation/components/ParameterHeaders.vue.js +2 -2
- package/dist/features/Operation/components/ParameterList.vue.d.ts +2 -2
- package/dist/features/Operation/components/ParameterList.vue.d.ts.map +1 -1
- package/dist/features/Operation/components/ParameterList.vue.js +2 -2
- package/dist/features/Operation/components/ParameterListItem.vue.d.ts +2 -2
- package/dist/features/Operation/components/ParameterListItem.vue.d.ts.map +1 -1
- package/dist/features/Operation/components/ParameterListItem.vue.js +3 -3
- package/dist/features/Operation/components/ParameterListItem.vue2.js +6 -6
- package/dist/features/Operation/components/RequestBody.vue.d.ts +2 -2
- 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/callbacks/Callback.vue.d.ts +14 -0
- package/dist/features/Operation/components/callbacks/Callback.vue.d.ts.map +1 -0
- package/dist/features/Operation/components/callbacks/Callback.vue.js +7 -0
- package/dist/features/Operation/components/callbacks/Callback.vue2.js +62 -0
- package/dist/features/Operation/components/callbacks/Callbacks.vue.d.ts +10 -0
- package/dist/features/Operation/components/callbacks/Callbacks.vue.d.ts.map +1 -0
- package/dist/features/Operation/components/callbacks/Callbacks.vue.js +30 -0
- package/dist/features/Operation/components/callbacks/Callbacks.vue2.js +4 -0
- package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts +2 -2
- package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts.map +1 -1
- package/dist/features/Operation/layouts/ClassicLayout.vue.js +2 -2
- package/dist/features/Operation/layouts/ClassicLayout.vue2.js +55 -55
- package/dist/features/Operation/layouts/ModernLayout.vue.d.ts +2 -2
- package/dist/features/Operation/layouts/ModernLayout.vue.d.ts.map +1 -1
- package/dist/features/Operation/layouts/ModernLayout.vue.js +1 -1
- package/dist/features/Operation/layouts/ModernLayout.vue2.js +94 -79
- package/dist/features/Operation/types/schemas.d.ts +3 -0
- package/dist/features/Operation/types/schemas.d.ts.map +1 -0
- package/dist/features/Search/SearchButton.vue.js +2 -2
- package/dist/helpers/local-storage.d.ts +8 -0
- package/dist/helpers/local-storage.d.ts.map +1 -0
- package/dist/helpers/local-storage.js +6 -0
- package/dist/helpers/measure.d.ts +21 -0
- package/dist/helpers/measure.d.ts.map +1 -0
- package/dist/helpers/measure.js +7 -0
- package/dist/helpers/parse.d.ts +3 -5
- package/dist/helpers/parse.d.ts.map +1 -1
- package/dist/helpers/parse.js +64 -86
- package/dist/helpers/scroll-to-id.d.ts.map +1 -1
- package/dist/helpers/scroll-to-id.js +18 -4
- package/dist/index.d.ts +0 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +33 -35
- package/dist/libs/openapi.d.ts +3 -3
- package/dist/libs/openapi.d.ts.map +1 -1
- package/dist/libs/openapi.js +35 -42
- package/dist/standalone/lib/html-api.d.ts.map +1 -1
- package/dist/standalone/lib/html-api.js +15 -15
- package/dist/stores/useHttpClientStore.d.ts.map +1 -1
- package/dist/stores/useHttpClientStore.js +19 -18
- package/dist/style.css +1 -1
- package/dist/types.d.ts +27 -3
- package/dist/types.d.ts.map +1 -1
- package/package.json +15 -16
- package/dist/hooks/useReactiveSpec.d.ts +0 -448
- package/dist/hooks/useReactiveSpec.d.ts.map +0 -1
- package/dist/hooks/useReactiveSpec.js +0 -59
|
@@ -36,88 +36,6 @@ declare const client: import("vue").Ref<{
|
|
|
36
36
|
enum?: string[] | undefined;
|
|
37
37
|
}> | undefined;
|
|
38
38
|
}>;
|
|
39
|
-
securitySchemes: Record<string, {
|
|
40
|
-
type: "apiKey";
|
|
41
|
-
value: string;
|
|
42
|
-
name: string;
|
|
43
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
44
|
-
nameKey: string;
|
|
45
|
-
in: "cookie" | "query" | "header";
|
|
46
|
-
description?: string | undefined;
|
|
47
|
-
} | {
|
|
48
|
-
type: "http";
|
|
49
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
50
|
-
nameKey: string;
|
|
51
|
-
scheme: "basic" | "bearer";
|
|
52
|
-
bearerFormat: string;
|
|
53
|
-
username: string;
|
|
54
|
-
password: string;
|
|
55
|
-
token: string;
|
|
56
|
-
description?: string | undefined;
|
|
57
|
-
} | {
|
|
58
|
-
type: "openIdConnect";
|
|
59
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
60
|
-
nameKey: string;
|
|
61
|
-
openIdConnectUrl: string;
|
|
62
|
-
description?: string | undefined;
|
|
63
|
-
} | {
|
|
64
|
-
type: "oauth2";
|
|
65
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
66
|
-
nameKey: string;
|
|
67
|
-
flows: {
|
|
68
|
-
password?: {
|
|
69
|
-
type: "password";
|
|
70
|
-
username: string;
|
|
71
|
-
password: string;
|
|
72
|
-
token: string;
|
|
73
|
-
refreshUrl: string;
|
|
74
|
-
scopes: Record<string, string>;
|
|
75
|
-
selectedScopes: string[];
|
|
76
|
-
"x-scalar-client-id": string;
|
|
77
|
-
tokenUrl: string;
|
|
78
|
-
clientSecret: string;
|
|
79
|
-
"x-scalar-security-query"?: Record<string, string> | undefined;
|
|
80
|
-
} | undefined;
|
|
81
|
-
implicit?: {
|
|
82
|
-
type: "implicit";
|
|
83
|
-
token: string;
|
|
84
|
-
refreshUrl: string;
|
|
85
|
-
scopes: Record<string, string>;
|
|
86
|
-
selectedScopes: string[];
|
|
87
|
-
"x-scalar-client-id": string;
|
|
88
|
-
authorizationUrl: string;
|
|
89
|
-
"x-scalar-redirect-uri": string;
|
|
90
|
-
"x-scalar-security-query"?: Record<string, string> | undefined;
|
|
91
|
-
} | undefined;
|
|
92
|
-
clientCredentials?: {
|
|
93
|
-
type: "clientCredentials";
|
|
94
|
-
token: string;
|
|
95
|
-
refreshUrl: string;
|
|
96
|
-
scopes: Record<string, string>;
|
|
97
|
-
selectedScopes: string[];
|
|
98
|
-
"x-scalar-client-id": string;
|
|
99
|
-
tokenUrl: string;
|
|
100
|
-
clientSecret: string;
|
|
101
|
-
"x-scalar-security-query"?: Record<string, string> | undefined;
|
|
102
|
-
} | undefined;
|
|
103
|
-
authorizationCode?: {
|
|
104
|
-
type: "authorizationCode";
|
|
105
|
-
token: string;
|
|
106
|
-
refreshUrl: string;
|
|
107
|
-
scopes: Record<string, string>;
|
|
108
|
-
selectedScopes: string[];
|
|
109
|
-
"x-scalar-client-id": string;
|
|
110
|
-
authorizationUrl: string;
|
|
111
|
-
"x-scalar-redirect-uri": string;
|
|
112
|
-
tokenUrl: string;
|
|
113
|
-
clientSecret: string;
|
|
114
|
-
"x-usePkce": "SHA-256" | "plain" | "no";
|
|
115
|
-
"x-scalar-security-query"?: Record<string, string> | undefined;
|
|
116
|
-
} | undefined;
|
|
117
|
-
};
|
|
118
|
-
description?: string | undefined;
|
|
119
|
-
"x-default-scopes"?: string | string[] | undefined;
|
|
120
|
-
}>;
|
|
121
39
|
tags: Record<string, {
|
|
122
40
|
uid: string & import("zod").BRAND<"tag">;
|
|
123
41
|
name: string;
|
|
@@ -235,6 +153,88 @@ declare const client: import("vue").Ref<{
|
|
|
235
153
|
redo: (uid: string & import("zod").BRAND<"server">) => void;
|
|
236
154
|
reset: () => void;
|
|
237
155
|
};
|
|
156
|
+
securitySchemes: Record<string, {
|
|
157
|
+
type: "apiKey";
|
|
158
|
+
value: string;
|
|
159
|
+
name: string;
|
|
160
|
+
uid: string & import("zod").BRAND<"securityScheme">;
|
|
161
|
+
nameKey: string;
|
|
162
|
+
in: "cookie" | "query" | "header";
|
|
163
|
+
description?: string | undefined;
|
|
164
|
+
} | {
|
|
165
|
+
type: "http";
|
|
166
|
+
uid: string & import("zod").BRAND<"securityScheme">;
|
|
167
|
+
nameKey: string;
|
|
168
|
+
scheme: "basic" | "bearer";
|
|
169
|
+
bearerFormat: string;
|
|
170
|
+
username: string;
|
|
171
|
+
password: string;
|
|
172
|
+
token: string;
|
|
173
|
+
description?: string | undefined;
|
|
174
|
+
} | {
|
|
175
|
+
type: "openIdConnect";
|
|
176
|
+
uid: string & import("zod").BRAND<"securityScheme">;
|
|
177
|
+
nameKey: string;
|
|
178
|
+
openIdConnectUrl: string;
|
|
179
|
+
description?: string | undefined;
|
|
180
|
+
} | {
|
|
181
|
+
type: "oauth2";
|
|
182
|
+
uid: string & import("zod").BRAND<"securityScheme">;
|
|
183
|
+
nameKey: string;
|
|
184
|
+
flows: {
|
|
185
|
+
password?: {
|
|
186
|
+
type: "password";
|
|
187
|
+
username: string;
|
|
188
|
+
password: string;
|
|
189
|
+
token: string;
|
|
190
|
+
refreshUrl: string;
|
|
191
|
+
scopes: Record<string, string>;
|
|
192
|
+
selectedScopes: string[];
|
|
193
|
+
"x-scalar-client-id": string;
|
|
194
|
+
tokenUrl: string;
|
|
195
|
+
clientSecret: string;
|
|
196
|
+
"x-scalar-security-query"?: Record<string, string> | undefined;
|
|
197
|
+
} | undefined;
|
|
198
|
+
implicit?: {
|
|
199
|
+
type: "implicit";
|
|
200
|
+
token: string;
|
|
201
|
+
refreshUrl: string;
|
|
202
|
+
scopes: Record<string, string>;
|
|
203
|
+
selectedScopes: string[];
|
|
204
|
+
"x-scalar-client-id": string;
|
|
205
|
+
authorizationUrl: string;
|
|
206
|
+
"x-scalar-redirect-uri": string;
|
|
207
|
+
"x-scalar-security-query"?: Record<string, string> | undefined;
|
|
208
|
+
} | undefined;
|
|
209
|
+
clientCredentials?: {
|
|
210
|
+
type: "clientCredentials";
|
|
211
|
+
token: string;
|
|
212
|
+
refreshUrl: string;
|
|
213
|
+
scopes: Record<string, string>;
|
|
214
|
+
selectedScopes: string[];
|
|
215
|
+
"x-scalar-client-id": string;
|
|
216
|
+
tokenUrl: string;
|
|
217
|
+
clientSecret: string;
|
|
218
|
+
"x-scalar-security-query"?: Record<string, string> | undefined;
|
|
219
|
+
} | undefined;
|
|
220
|
+
authorizationCode?: {
|
|
221
|
+
type: "authorizationCode";
|
|
222
|
+
token: string;
|
|
223
|
+
refreshUrl: string;
|
|
224
|
+
scopes: Record<string, string>;
|
|
225
|
+
selectedScopes: string[];
|
|
226
|
+
"x-scalar-client-id": string;
|
|
227
|
+
authorizationUrl: string;
|
|
228
|
+
"x-scalar-redirect-uri": string;
|
|
229
|
+
tokenUrl: string;
|
|
230
|
+
clientSecret: string;
|
|
231
|
+
"x-usePkce": "SHA-256" | "plain" | "no";
|
|
232
|
+
"x-scalar-security-query"?: Record<string, string> | undefined;
|
|
233
|
+
} | undefined;
|
|
234
|
+
};
|
|
235
|
+
description?: string | undefined;
|
|
236
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
237
|
+
}>;
|
|
238
238
|
requests: Record<string, {
|
|
239
239
|
uid: string & import("zod").BRAND<"operation">;
|
|
240
240
|
path: string;
|
|
@@ -275,6 +275,7 @@ declare const client: import("vue").Ref<{
|
|
|
275
275
|
}[] | undefined;
|
|
276
276
|
requestBody?: any;
|
|
277
277
|
responses?: Record<string, any> | undefined;
|
|
278
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
278
279
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
279
280
|
"x-post-response"?: string | undefined;
|
|
280
281
|
"x-codeSamples"?: {
|
|
@@ -1409,13 +1410,10 @@ declare const client: import("vue").Ref<{
|
|
|
1409
1410
|
}>;
|
|
1410
1411
|
setSidebarWidth: (width: string) => void;
|
|
1411
1412
|
integration: "elysiajs" | "fastify" | "go" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "svelte" | "vue" | null | undefined;
|
|
1412
|
-
importSpecFile: (_spec: string | Record<string, any
|
|
1413
|
+
importSpecFile: (_spec: string | Record<string, any> | undefined, workspaceUid: string, options?: Pick<{
|
|
1413
1414
|
uid?: string | undefined;
|
|
1414
1415
|
type?: "collection" | undefined;
|
|
1415
|
-
externalDocs?:
|
|
1416
|
-
url: string;
|
|
1417
|
-
description?: unknown;
|
|
1418
|
-
} | undefined;
|
|
1416
|
+
externalDocs?: unknown;
|
|
1419
1417
|
children?: string[] | undefined;
|
|
1420
1418
|
openapi?: string | undefined;
|
|
1421
1419
|
jsonSchemaDialect?: string | undefined;
|
|
@@ -1449,9 +1447,12 @@ declare const client: import("vue").Ref<{
|
|
|
1449
1447
|
useCollectionSecurity?: boolean | undefined;
|
|
1450
1448
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
1451
1449
|
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
1450
|
+
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
|
|
1452
1451
|
useCollectionSecurity?: boolean;
|
|
1453
1452
|
shouldLoad?: boolean;
|
|
1454
|
-
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">
|
|
1453
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers"> & {
|
|
1454
|
+
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
|
|
1455
|
+
}) => Promise<{
|
|
1455
1456
|
error: false;
|
|
1456
1457
|
collection: import("@scalar/oas-utils/entities/spec").Collection;
|
|
1457
1458
|
requests: import("@scalar/oas-utils/entities/spec").Request[];
|
|
@@ -1464,10 +1465,7 @@ declare const client: import("vue").Ref<{
|
|
|
1464
1465
|
importSpecFromUrl: (url: string, workspaceUid: string, { proxyUrl, ...options }?: Omit<Pick<{
|
|
1465
1466
|
uid?: string | undefined;
|
|
1466
1467
|
type?: "collection" | undefined;
|
|
1467
|
-
externalDocs?:
|
|
1468
|
-
url: string;
|
|
1469
|
-
description?: unknown;
|
|
1470
|
-
} | undefined;
|
|
1468
|
+
externalDocs?: unknown;
|
|
1471
1469
|
children?: string[] | undefined;
|
|
1472
1470
|
openapi?: string | undefined;
|
|
1473
1471
|
jsonSchemaDialect?: string | undefined;
|
|
@@ -1501,15 +1499,15 @@ declare const client: import("vue").Ref<{
|
|
|
1501
1499
|
useCollectionSecurity?: boolean | undefined;
|
|
1502
1500
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
1503
1501
|
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
1502
|
+
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
|
|
1504
1503
|
useCollectionSecurity?: boolean;
|
|
1505
1504
|
shouldLoad?: boolean;
|
|
1506
|
-
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers"
|
|
1505
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers"> & {
|
|
1506
|
+
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
|
|
1507
|
+
}, "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "proxyUrl">) => Promise<import("@scalar/api-client/libs").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any> | undefined, workspaceUid: string, options?: Pick<{
|
|
1507
1508
|
uid?: string | undefined;
|
|
1508
1509
|
type?: "collection" | undefined;
|
|
1509
|
-
externalDocs?:
|
|
1510
|
-
url: string;
|
|
1511
|
-
description?: unknown;
|
|
1512
|
-
} | undefined;
|
|
1510
|
+
externalDocs?: unknown;
|
|
1513
1511
|
children?: string[] | undefined;
|
|
1514
1512
|
openapi?: string | undefined;
|
|
1515
1513
|
jsonSchemaDialect?: string | undefined;
|
|
@@ -1543,9 +1541,12 @@ declare const client: import("vue").Ref<{
|
|
|
1543
1541
|
useCollectionSecurity?: boolean | undefined;
|
|
1544
1542
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
1545
1543
|
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
1544
|
+
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
|
|
1546
1545
|
useCollectionSecurity?: boolean;
|
|
1547
1546
|
shouldLoad?: boolean;
|
|
1548
|
-
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">
|
|
1547
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers"> & {
|
|
1548
|
+
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
|
|
1549
|
+
}) => Promise<{
|
|
1549
1550
|
error: false;
|
|
1550
1551
|
collection: import("@scalar/oas-utils/entities/spec").Collection;
|
|
1551
1552
|
requests: import("@scalar/oas-utils/entities/spec").Request[];
|
|
@@ -2265,6 +2266,7 @@ declare const client: import("vue").Ref<{
|
|
|
2265
2266
|
}[] | undefined;
|
|
2266
2267
|
requestBody?: any;
|
|
2267
2268
|
responses?: Record<string, any> | undefined;
|
|
2269
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
2268
2270
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
2269
2271
|
"x-post-response"?: string | undefined;
|
|
2270
2272
|
"x-codeSamples"?: {
|
|
@@ -2323,6 +2325,7 @@ declare const client: import("vue").Ref<{
|
|
|
2323
2325
|
}[] | undefined;
|
|
2324
2326
|
requestBody?: any;
|
|
2325
2327
|
responses?: Record<string, any> | undefined;
|
|
2328
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
2326
2329
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
2327
2330
|
"x-post-response"?: string | undefined;
|
|
2328
2331
|
"x-codeSamples"?: {
|
|
@@ -2382,6 +2385,7 @@ declare const client: import("vue").Ref<{
|
|
|
2382
2385
|
}[] | undefined;
|
|
2383
2386
|
requestBody?: any;
|
|
2384
2387
|
responses?: Record<string, any> | undefined;
|
|
2388
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
2385
2389
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
2386
2390
|
"x-post-response"?: string | undefined;
|
|
2387
2391
|
"x-codeSamples"?: {
|
|
@@ -2400,7 +2404,7 @@ declare const client: import("vue").Ref<{
|
|
|
2400
2404
|
lang?: string | undefined;
|
|
2401
2405
|
}[] | undefined;
|
|
2402
2406
|
}) => void;
|
|
2403
|
-
edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "x-post-response" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.examples` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.required` | `parameters.${number}.explode` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.lang` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.label` | `x-code-samples.${number}` | `x-code-samples.${number}.lang` | `x-code-samples.${number}.source` | `x-code-samples.${number}.label` | `x-custom-examples.${number}` | `x-custom-examples.${number}.lang` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.label`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? {
|
|
2407
|
+
edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "x-post-response" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.examples` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.required` | `parameters.${number}.explode` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `callbacks.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.lang` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.label` | `x-code-samples.${number}` | `x-code-samples.${number}.lang` | `x-code-samples.${number}.source` | `x-code-samples.${number}.label` | `x-custom-examples.${number}` | `x-custom-examples.${number}.lang` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.label`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? {
|
|
2404
2408
|
uid: string & import("zod").BRAND<"operation">;
|
|
2405
2409
|
path: string;
|
|
2406
2410
|
type: "request";
|
|
@@ -2440,6 +2444,7 @@ declare const client: import("vue").Ref<{
|
|
|
2440
2444
|
}[] | undefined;
|
|
2441
2445
|
requestBody?: any;
|
|
2442
2446
|
responses?: Record<string, any> | undefined;
|
|
2447
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
2443
2448
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
2444
2449
|
"x-post-response"?: string | undefined;
|
|
2445
2450
|
"x-codeSamples"?: {
|
|
@@ -2457,7 +2462,7 @@ declare const client: import("vue").Ref<{
|
|
|
2457
2462
|
label?: string | undefined;
|
|
2458
2463
|
lang?: string | undefined;
|
|
2459
2464
|
}[] | undefined;
|
|
2460
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2465
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2461
2466
|
uid: string & import("zod").BRAND<"operation">;
|
|
2462
2467
|
path: string;
|
|
2463
2468
|
type: "request";
|
|
@@ -2497,6 +2502,7 @@ declare const client: import("vue").Ref<{
|
|
|
2497
2502
|
}[] | undefined;
|
|
2498
2503
|
requestBody?: any;
|
|
2499
2504
|
responses?: Record<string, any> | undefined;
|
|
2505
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
2500
2506
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
2501
2507
|
"x-post-response"?: string | undefined;
|
|
2502
2508
|
"x-codeSamples"?: {
|
|
@@ -2554,6 +2560,7 @@ declare const client: import("vue").Ref<{
|
|
|
2554
2560
|
}[] | undefined;
|
|
2555
2561
|
requestBody?: any;
|
|
2556
2562
|
responses?: Record<string, any> | undefined;
|
|
2563
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
2557
2564
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
2558
2565
|
"x-post-response"?: string | undefined;
|
|
2559
2566
|
"x-codeSamples"?: {
|
|
@@ -2572,7 +2579,7 @@ declare const client: import("vue").Ref<{
|
|
|
2572
2579
|
lang?: string | undefined;
|
|
2573
2580
|
}[] | undefined;
|
|
2574
2581
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2575
|
-
untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "x-post-response" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.examples` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.required` | `parameters.${number}.explode` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.lang` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.label` | `x-code-samples.${number}` | `x-code-samples.${number}.lang` | `x-code-samples.${number}.source` | `x-code-samples.${number}.label` | `x-custom-examples.${number}` | `x-custom-examples.${number}.lang` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.label`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? {
|
|
2582
|
+
untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "x-post-response" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.examples` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.required` | `parameters.${number}.explode` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `callbacks.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.lang` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.label` | `x-code-samples.${number}` | `x-code-samples.${number}.lang` | `x-code-samples.${number}.source` | `x-code-samples.${number}.label` | `x-custom-examples.${number}` | `x-custom-examples.${number}.lang` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.label`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? {
|
|
2576
2583
|
uid: string & import("zod").BRAND<"operation">;
|
|
2577
2584
|
path: string;
|
|
2578
2585
|
type: "request";
|
|
@@ -2612,6 +2619,7 @@ declare const client: import("vue").Ref<{
|
|
|
2612
2619
|
}[] | undefined;
|
|
2613
2620
|
requestBody?: any;
|
|
2614
2621
|
responses?: Record<string, any> | undefined;
|
|
2622
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
2615
2623
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
2616
2624
|
"x-post-response"?: string | undefined;
|
|
2617
2625
|
"x-codeSamples"?: {
|
|
@@ -2629,7 +2637,7 @@ declare const client: import("vue").Ref<{
|
|
|
2629
2637
|
label?: string | undefined;
|
|
2630
2638
|
lang?: string | undefined;
|
|
2631
2639
|
}[] | undefined;
|
|
2632
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2640
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2633
2641
|
uid: string & import("zod").BRAND<"operation">;
|
|
2634
2642
|
path: string;
|
|
2635
2643
|
type: "request";
|
|
@@ -2669,6 +2677,7 @@ declare const client: import("vue").Ref<{
|
|
|
2669
2677
|
}[] | undefined;
|
|
2670
2678
|
requestBody?: any;
|
|
2671
2679
|
responses?: Record<string, any> | undefined;
|
|
2680
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
2672
2681
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
2673
2682
|
"x-post-response"?: string | undefined;
|
|
2674
2683
|
"x-codeSamples"?: {
|
|
@@ -2726,6 +2735,7 @@ declare const client: import("vue").Ref<{
|
|
|
2726
2735
|
}[] | undefined;
|
|
2727
2736
|
requestBody?: any;
|
|
2728
2737
|
responses?: Record<string, any> | undefined;
|
|
2738
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
2729
2739
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
2730
2740
|
"x-post-response"?: string | undefined;
|
|
2731
2741
|
"x-codeSamples"?: {
|
|
@@ -3873,88 +3883,6 @@ declare const client: import("vue").Ref<{
|
|
|
3873
3883
|
enum?: string[] | undefined;
|
|
3874
3884
|
}> | undefined;
|
|
3875
3885
|
}>;
|
|
3876
|
-
securitySchemes: Record<string, {
|
|
3877
|
-
type: "apiKey";
|
|
3878
|
-
value: string;
|
|
3879
|
-
name: string;
|
|
3880
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
3881
|
-
nameKey: string;
|
|
3882
|
-
in: "cookie" | "query" | "header";
|
|
3883
|
-
description?: string | undefined;
|
|
3884
|
-
} | {
|
|
3885
|
-
type: "http";
|
|
3886
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
3887
|
-
nameKey: string;
|
|
3888
|
-
scheme: "basic" | "bearer";
|
|
3889
|
-
bearerFormat: string;
|
|
3890
|
-
username: string;
|
|
3891
|
-
password: string;
|
|
3892
|
-
token: string;
|
|
3893
|
-
description?: string | undefined;
|
|
3894
|
-
} | {
|
|
3895
|
-
type: "openIdConnect";
|
|
3896
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
3897
|
-
nameKey: string;
|
|
3898
|
-
openIdConnectUrl: string;
|
|
3899
|
-
description?: string | undefined;
|
|
3900
|
-
} | {
|
|
3901
|
-
type: "oauth2";
|
|
3902
|
-
uid: string & import("zod").BRAND<"securityScheme">;
|
|
3903
|
-
nameKey: string;
|
|
3904
|
-
flows: {
|
|
3905
|
-
password?: {
|
|
3906
|
-
type: "password";
|
|
3907
|
-
username: string;
|
|
3908
|
-
password: string;
|
|
3909
|
-
token: string;
|
|
3910
|
-
refreshUrl: string;
|
|
3911
|
-
scopes: Record<string, string>;
|
|
3912
|
-
selectedScopes: string[];
|
|
3913
|
-
"x-scalar-client-id": string;
|
|
3914
|
-
tokenUrl: string;
|
|
3915
|
-
clientSecret: string;
|
|
3916
|
-
"x-scalar-security-query"?: Record<string, string> | undefined;
|
|
3917
|
-
} | undefined;
|
|
3918
|
-
implicit?: {
|
|
3919
|
-
type: "implicit";
|
|
3920
|
-
token: string;
|
|
3921
|
-
refreshUrl: string;
|
|
3922
|
-
scopes: Record<string, string>;
|
|
3923
|
-
selectedScopes: string[];
|
|
3924
|
-
"x-scalar-client-id": string;
|
|
3925
|
-
authorizationUrl: string;
|
|
3926
|
-
"x-scalar-redirect-uri": string;
|
|
3927
|
-
"x-scalar-security-query"?: Record<string, string> | undefined;
|
|
3928
|
-
} | undefined;
|
|
3929
|
-
clientCredentials?: {
|
|
3930
|
-
type: "clientCredentials";
|
|
3931
|
-
token: string;
|
|
3932
|
-
refreshUrl: string;
|
|
3933
|
-
scopes: Record<string, string>;
|
|
3934
|
-
selectedScopes: string[];
|
|
3935
|
-
"x-scalar-client-id": string;
|
|
3936
|
-
tokenUrl: string;
|
|
3937
|
-
clientSecret: string;
|
|
3938
|
-
"x-scalar-security-query"?: Record<string, string> | undefined;
|
|
3939
|
-
} | undefined;
|
|
3940
|
-
authorizationCode?: {
|
|
3941
|
-
type: "authorizationCode";
|
|
3942
|
-
token: string;
|
|
3943
|
-
refreshUrl: string;
|
|
3944
|
-
scopes: Record<string, string>;
|
|
3945
|
-
selectedScopes: string[];
|
|
3946
|
-
"x-scalar-client-id": string;
|
|
3947
|
-
authorizationUrl: string;
|
|
3948
|
-
"x-scalar-redirect-uri": string;
|
|
3949
|
-
tokenUrl: string;
|
|
3950
|
-
clientSecret: string;
|
|
3951
|
-
"x-usePkce": "SHA-256" | "plain" | "no";
|
|
3952
|
-
"x-scalar-security-query"?: Record<string, string> | undefined;
|
|
3953
|
-
} | undefined;
|
|
3954
|
-
};
|
|
3955
|
-
description?: string | undefined;
|
|
3956
|
-
"x-default-scopes"?: string | string[] | undefined;
|
|
3957
|
-
}>;
|
|
3958
3886
|
tags: Record<string, {
|
|
3959
3887
|
uid: string & import("zod").BRAND<"tag">;
|
|
3960
3888
|
name: string;
|
|
@@ -4072,6 +4000,88 @@ declare const client: import("vue").Ref<{
|
|
|
4072
4000
|
redo: (uid: string & import("zod").BRAND<"server">) => void;
|
|
4073
4001
|
reset: () => void;
|
|
4074
4002
|
};
|
|
4003
|
+
securitySchemes: Record<string, {
|
|
4004
|
+
type: "apiKey";
|
|
4005
|
+
value: string;
|
|
4006
|
+
name: string;
|
|
4007
|
+
uid: string & import("zod").BRAND<"securityScheme">;
|
|
4008
|
+
nameKey: string;
|
|
4009
|
+
in: "cookie" | "query" | "header";
|
|
4010
|
+
description?: string | undefined;
|
|
4011
|
+
} | {
|
|
4012
|
+
type: "http";
|
|
4013
|
+
uid: string & import("zod").BRAND<"securityScheme">;
|
|
4014
|
+
nameKey: string;
|
|
4015
|
+
scheme: "basic" | "bearer";
|
|
4016
|
+
bearerFormat: string;
|
|
4017
|
+
username: string;
|
|
4018
|
+
password: string;
|
|
4019
|
+
token: string;
|
|
4020
|
+
description?: string | undefined;
|
|
4021
|
+
} | {
|
|
4022
|
+
type: "openIdConnect";
|
|
4023
|
+
uid: string & import("zod").BRAND<"securityScheme">;
|
|
4024
|
+
nameKey: string;
|
|
4025
|
+
openIdConnectUrl: string;
|
|
4026
|
+
description?: string | undefined;
|
|
4027
|
+
} | {
|
|
4028
|
+
type: "oauth2";
|
|
4029
|
+
uid: string & import("zod").BRAND<"securityScheme">;
|
|
4030
|
+
nameKey: string;
|
|
4031
|
+
flows: {
|
|
4032
|
+
password?: {
|
|
4033
|
+
type: "password";
|
|
4034
|
+
username: string;
|
|
4035
|
+
password: string;
|
|
4036
|
+
token: string;
|
|
4037
|
+
refreshUrl: string;
|
|
4038
|
+
scopes: Record<string, string>;
|
|
4039
|
+
selectedScopes: string[];
|
|
4040
|
+
"x-scalar-client-id": string;
|
|
4041
|
+
tokenUrl: string;
|
|
4042
|
+
clientSecret: string;
|
|
4043
|
+
"x-scalar-security-query"?: Record<string, string> | undefined;
|
|
4044
|
+
} | undefined;
|
|
4045
|
+
implicit?: {
|
|
4046
|
+
type: "implicit";
|
|
4047
|
+
token: string;
|
|
4048
|
+
refreshUrl: string;
|
|
4049
|
+
scopes: Record<string, string>;
|
|
4050
|
+
selectedScopes: string[];
|
|
4051
|
+
"x-scalar-client-id": string;
|
|
4052
|
+
authorizationUrl: string;
|
|
4053
|
+
"x-scalar-redirect-uri": string;
|
|
4054
|
+
"x-scalar-security-query"?: Record<string, string> | undefined;
|
|
4055
|
+
} | undefined;
|
|
4056
|
+
clientCredentials?: {
|
|
4057
|
+
type: "clientCredentials";
|
|
4058
|
+
token: string;
|
|
4059
|
+
refreshUrl: string;
|
|
4060
|
+
scopes: Record<string, string>;
|
|
4061
|
+
selectedScopes: string[];
|
|
4062
|
+
"x-scalar-client-id": string;
|
|
4063
|
+
tokenUrl: string;
|
|
4064
|
+
clientSecret: string;
|
|
4065
|
+
"x-scalar-security-query"?: Record<string, string> | undefined;
|
|
4066
|
+
} | undefined;
|
|
4067
|
+
authorizationCode?: {
|
|
4068
|
+
type: "authorizationCode";
|
|
4069
|
+
token: string;
|
|
4070
|
+
refreshUrl: string;
|
|
4071
|
+
scopes: Record<string, string>;
|
|
4072
|
+
selectedScopes: string[];
|
|
4073
|
+
"x-scalar-client-id": string;
|
|
4074
|
+
authorizationUrl: string;
|
|
4075
|
+
"x-scalar-redirect-uri": string;
|
|
4076
|
+
tokenUrl: string;
|
|
4077
|
+
clientSecret: string;
|
|
4078
|
+
"x-usePkce": "SHA-256" | "plain" | "no";
|
|
4079
|
+
"x-scalar-security-query"?: Record<string, string> | undefined;
|
|
4080
|
+
} | undefined;
|
|
4081
|
+
};
|
|
4082
|
+
description?: string | undefined;
|
|
4083
|
+
"x-default-scopes"?: string | string[] | undefined;
|
|
4084
|
+
}>;
|
|
4075
4085
|
requests: Record<string, {
|
|
4076
4086
|
uid: string & import("zod").BRAND<"operation">;
|
|
4077
4087
|
path: string;
|
|
@@ -4112,6 +4122,7 @@ declare const client: import("vue").Ref<{
|
|
|
4112
4122
|
}[] | undefined;
|
|
4113
4123
|
requestBody?: any;
|
|
4114
4124
|
responses?: Record<string, any> | undefined;
|
|
4125
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
4115
4126
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
4116
4127
|
"x-post-response"?: string | undefined;
|
|
4117
4128
|
"x-codeSamples"?: {
|
|
@@ -5246,13 +5257,10 @@ declare const client: import("vue").Ref<{
|
|
|
5246
5257
|
}>;
|
|
5247
5258
|
setSidebarWidth: (width: string) => void;
|
|
5248
5259
|
integration: "elysiajs" | "fastify" | "go" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "svelte" | "vue" | null | undefined;
|
|
5249
|
-
importSpecFile: (_spec: string | Record<string, any
|
|
5260
|
+
importSpecFile: (_spec: string | Record<string, any> | undefined, workspaceUid: string, options?: Pick<{
|
|
5250
5261
|
uid?: string | undefined;
|
|
5251
5262
|
type?: "collection" | undefined;
|
|
5252
|
-
externalDocs?:
|
|
5253
|
-
url: string;
|
|
5254
|
-
description?: unknown;
|
|
5255
|
-
} | undefined;
|
|
5263
|
+
externalDocs?: unknown;
|
|
5256
5264
|
children?: string[] | undefined;
|
|
5257
5265
|
openapi?: string | undefined;
|
|
5258
5266
|
jsonSchemaDialect?: string | undefined;
|
|
@@ -5286,9 +5294,12 @@ declare const client: import("vue").Ref<{
|
|
|
5286
5294
|
useCollectionSecurity?: boolean | undefined;
|
|
5287
5295
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
5288
5296
|
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
5297
|
+
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
|
|
5289
5298
|
useCollectionSecurity?: boolean;
|
|
5290
5299
|
shouldLoad?: boolean;
|
|
5291
|
-
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">
|
|
5300
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers"> & {
|
|
5301
|
+
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
|
|
5302
|
+
}) => Promise<{
|
|
5292
5303
|
error: false;
|
|
5293
5304
|
collection: import("@scalar/oas-utils/entities/spec").Collection;
|
|
5294
5305
|
requests: import("@scalar/oas-utils/entities/spec").Request[];
|
|
@@ -5301,10 +5312,7 @@ declare const client: import("vue").Ref<{
|
|
|
5301
5312
|
importSpecFromUrl: (url: string, workspaceUid: string, { proxyUrl, ...options }?: Omit<Pick<{
|
|
5302
5313
|
uid?: string | undefined;
|
|
5303
5314
|
type?: "collection" | undefined;
|
|
5304
|
-
externalDocs?:
|
|
5305
|
-
url: string;
|
|
5306
|
-
description?: unknown;
|
|
5307
|
-
} | undefined;
|
|
5315
|
+
externalDocs?: unknown;
|
|
5308
5316
|
children?: string[] | undefined;
|
|
5309
5317
|
openapi?: string | undefined;
|
|
5310
5318
|
jsonSchemaDialect?: string | undefined;
|
|
@@ -5338,15 +5346,15 @@ declare const client: import("vue").Ref<{
|
|
|
5338
5346
|
useCollectionSecurity?: boolean | undefined;
|
|
5339
5347
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
5340
5348
|
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
5349
|
+
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
|
|
5341
5350
|
useCollectionSecurity?: boolean;
|
|
5342
5351
|
shouldLoad?: boolean;
|
|
5343
|
-
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers"
|
|
5352
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers"> & {
|
|
5353
|
+
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
|
|
5354
|
+
}, "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "proxyUrl">) => Promise<import("@scalar/api-client/libs").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any> | undefined, workspaceUid: string, options?: Pick<{
|
|
5344
5355
|
uid?: string | undefined;
|
|
5345
5356
|
type?: "collection" | undefined;
|
|
5346
|
-
externalDocs?:
|
|
5347
|
-
url: string;
|
|
5348
|
-
description?: unknown;
|
|
5349
|
-
} | undefined;
|
|
5357
|
+
externalDocs?: unknown;
|
|
5350
5358
|
children?: string[] | undefined;
|
|
5351
5359
|
openapi?: string | undefined;
|
|
5352
5360
|
jsonSchemaDialect?: string | undefined;
|
|
@@ -5380,9 +5388,12 @@ declare const client: import("vue").Ref<{
|
|
|
5380
5388
|
useCollectionSecurity?: boolean | undefined;
|
|
5381
5389
|
watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
|
|
5382
5390
|
}, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
|
|
5391
|
+
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
|
|
5383
5392
|
useCollectionSecurity?: boolean;
|
|
5384
5393
|
shouldLoad?: boolean;
|
|
5385
|
-
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">
|
|
5394
|
+
} & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers"> & {
|
|
5395
|
+
dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
|
|
5396
|
+
}) => Promise<{
|
|
5386
5397
|
error: false;
|
|
5387
5398
|
collection: import("@scalar/oas-utils/entities/spec").Collection;
|
|
5388
5399
|
requests: import("@scalar/oas-utils/entities/spec").Request[];
|
|
@@ -6102,6 +6113,7 @@ declare const client: import("vue").Ref<{
|
|
|
6102
6113
|
}[] | undefined;
|
|
6103
6114
|
requestBody?: any;
|
|
6104
6115
|
responses?: Record<string, any> | undefined;
|
|
6116
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
6105
6117
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
6106
6118
|
"x-post-response"?: string | undefined;
|
|
6107
6119
|
"x-codeSamples"?: {
|
|
@@ -6160,6 +6172,7 @@ declare const client: import("vue").Ref<{
|
|
|
6160
6172
|
}[] | undefined;
|
|
6161
6173
|
requestBody?: any;
|
|
6162
6174
|
responses?: Record<string, any> | undefined;
|
|
6175
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
6163
6176
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
6164
6177
|
"x-post-response"?: string | undefined;
|
|
6165
6178
|
"x-codeSamples"?: {
|
|
@@ -6219,6 +6232,7 @@ declare const client: import("vue").Ref<{
|
|
|
6219
6232
|
}[] | undefined;
|
|
6220
6233
|
requestBody?: any;
|
|
6221
6234
|
responses?: Record<string, any> | undefined;
|
|
6235
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
6222
6236
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
6223
6237
|
"x-post-response"?: string | undefined;
|
|
6224
6238
|
"x-codeSamples"?: {
|
|
@@ -6237,7 +6251,7 @@ declare const client: import("vue").Ref<{
|
|
|
6237
6251
|
lang?: string | undefined;
|
|
6238
6252
|
}[] | undefined;
|
|
6239
6253
|
}) => void;
|
|
6240
|
-
edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "x-post-response" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.examples` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.required` | `parameters.${number}.explode` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.lang` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.label` | `x-code-samples.${number}` | `x-code-samples.${number}.lang` | `x-code-samples.${number}.source` | `x-code-samples.${number}.label` | `x-custom-examples.${number}` | `x-custom-examples.${number}.lang` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.label`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? {
|
|
6254
|
+
edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "x-post-response" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.examples` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.required` | `parameters.${number}.explode` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `callbacks.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.lang` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.label` | `x-code-samples.${number}` | `x-code-samples.${number}.lang` | `x-code-samples.${number}.source` | `x-code-samples.${number}.label` | `x-custom-examples.${number}` | `x-custom-examples.${number}.lang` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.label`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? {
|
|
6241
6255
|
uid: string & import("zod").BRAND<"operation">;
|
|
6242
6256
|
path: string;
|
|
6243
6257
|
type: "request";
|
|
@@ -6277,6 +6291,7 @@ declare const client: import("vue").Ref<{
|
|
|
6277
6291
|
}[] | undefined;
|
|
6278
6292
|
requestBody?: any;
|
|
6279
6293
|
responses?: Record<string, any> | undefined;
|
|
6294
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
6280
6295
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
6281
6296
|
"x-post-response"?: string | undefined;
|
|
6282
6297
|
"x-codeSamples"?: {
|
|
@@ -6294,7 +6309,7 @@ declare const client: import("vue").Ref<{
|
|
|
6294
6309
|
label?: string | undefined;
|
|
6295
6310
|
lang?: string | undefined;
|
|
6296
6311
|
}[] | undefined;
|
|
6297
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
6312
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
6298
6313
|
uid: string & import("zod").BRAND<"operation">;
|
|
6299
6314
|
path: string;
|
|
6300
6315
|
type: "request";
|
|
@@ -6334,6 +6349,7 @@ declare const client: import("vue").Ref<{
|
|
|
6334
6349
|
}[] | undefined;
|
|
6335
6350
|
requestBody?: any;
|
|
6336
6351
|
responses?: Record<string, any> | undefined;
|
|
6352
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
6337
6353
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
6338
6354
|
"x-post-response"?: string | undefined;
|
|
6339
6355
|
"x-codeSamples"?: {
|
|
@@ -6391,6 +6407,7 @@ declare const client: import("vue").Ref<{
|
|
|
6391
6407
|
}[] | undefined;
|
|
6392
6408
|
requestBody?: any;
|
|
6393
6409
|
responses?: Record<string, any> | undefined;
|
|
6410
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
6394
6411
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
6395
6412
|
"x-post-response"?: string | undefined;
|
|
6396
6413
|
"x-codeSamples"?: {
|
|
@@ -6409,7 +6426,7 @@ declare const client: import("vue").Ref<{
|
|
|
6409
6426
|
lang?: string | undefined;
|
|
6410
6427
|
}[] | undefined;
|
|
6411
6428
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
6412
|
-
untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "x-post-response" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.examples` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.required` | `parameters.${number}.explode` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.lang` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.label` | `x-code-samples.${number}` | `x-code-samples.${number}.lang` | `x-code-samples.${number}.source` | `x-code-samples.${number}.label` | `x-custom-examples.${number}` | `x-custom-examples.${number}.lang` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.label`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? {
|
|
6429
|
+
untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "x-post-response" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.examples` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.required` | `parameters.${number}.explode` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `callbacks.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.lang` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.label` | `x-code-samples.${number}` | `x-code-samples.${number}.lang` | `x-code-samples.${number}.source` | `x-code-samples.${number}.label` | `x-custom-examples.${number}` | `x-custom-examples.${number}.lang` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.label`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? {
|
|
6413
6430
|
uid: string & import("zod").BRAND<"operation">;
|
|
6414
6431
|
path: string;
|
|
6415
6432
|
type: "request";
|
|
@@ -6449,6 +6466,7 @@ declare const client: import("vue").Ref<{
|
|
|
6449
6466
|
}[] | undefined;
|
|
6450
6467
|
requestBody?: any;
|
|
6451
6468
|
responses?: Record<string, any> | undefined;
|
|
6469
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
6452
6470
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
6453
6471
|
"x-post-response"?: string | undefined;
|
|
6454
6472
|
"x-codeSamples"?: {
|
|
@@ -6466,7 +6484,7 @@ declare const client: import("vue").Ref<{
|
|
|
6466
6484
|
label?: string | undefined;
|
|
6467
6485
|
lang?: string | undefined;
|
|
6468
6486
|
}[] | undefined;
|
|
6469
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
6487
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "callbacks" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "path" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
6470
6488
|
uid: string & import("zod").BRAND<"operation">;
|
|
6471
6489
|
path: string;
|
|
6472
6490
|
type: "request";
|
|
@@ -6506,6 +6524,7 @@ declare const client: import("vue").Ref<{
|
|
|
6506
6524
|
}[] | undefined;
|
|
6507
6525
|
requestBody?: any;
|
|
6508
6526
|
responses?: Record<string, any> | undefined;
|
|
6527
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
6509
6528
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
6510
6529
|
"x-post-response"?: string | undefined;
|
|
6511
6530
|
"x-codeSamples"?: {
|
|
@@ -6563,6 +6582,7 @@ declare const client: import("vue").Ref<{
|
|
|
6563
6582
|
}[] | undefined;
|
|
6564
6583
|
requestBody?: any;
|
|
6565
6584
|
responses?: Record<string, any> | undefined;
|
|
6585
|
+
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
6566
6586
|
"x-scalar-stability"?: import("@scalar/types").XScalarStability | undefined;
|
|
6567
6587
|
"x-post-response"?: string | undefined;
|
|
6568
6588
|
"x-codeSamples"?: {
|