@scalar/types 0.0.39 → 0.1.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 +18 -0
- package/dist/api-reference/api-reference-configuration.d.ts +1087 -84
- package/dist/api-reference/api-reference-configuration.d.ts.map +1 -1
- package/dist/api-reference/api-reference-configuration.js +117 -12
- package/dist/api-reference/html-rendering-configuration.d.ts +1 -1
- package/dist/api-reference/html-rendering-configuration.d.ts.map +1 -1
- package/dist/api-reference/index.d.ts +2 -2
- package/dist/api-reference/index.d.ts.map +1 -1
- package/dist/api-reference/index.js +1 -1
- package/dist/legacy/reference-config.d.ts +2 -271
- package/dist/legacy/reference-config.d.ts.map +1 -1
- package/package.json +2 -2
|
@@ -1,6 +1,186 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
+
/** Configuration for the OpenAPI/Swagger specification */
|
|
3
|
+
export declare const specConfigurationSchema: z.ZodObject<{
|
|
4
|
+
/**
|
|
5
|
+
* URL to an OpenAPI/Swagger document
|
|
6
|
+
*
|
|
7
|
+
* @deprecated Please move `url` to the top level and remove the `spec` prefix.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const oldConfiguration = {
|
|
12
|
+
* spec: {
|
|
13
|
+
* url: 'https://example.com/openapi.json',
|
|
14
|
+
* },
|
|
15
|
+
* }
|
|
16
|
+
*
|
|
17
|
+
* const newConfiguration = {
|
|
18
|
+
* url: 'https://example.com/openapi.json',
|
|
19
|
+
* }
|
|
20
|
+
* ```
|
|
21
|
+
**/
|
|
22
|
+
url: z.ZodOptional<z.ZodString>;
|
|
23
|
+
/**
|
|
24
|
+
* Directly embed the OpenAPI document.
|
|
25
|
+
* Can be a string, object, function returning an object, or null.
|
|
26
|
+
*
|
|
27
|
+
* @remarks It's recommended to pass a URL instead of content.
|
|
28
|
+
*
|
|
29
|
+
* @deprecated Please move `content` to the top level and remove the `spec` prefix.
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* ```ts
|
|
33
|
+
* const oldConfiguration = {
|
|
34
|
+
* spec: {
|
|
35
|
+
* content: '…',
|
|
36
|
+
* },
|
|
37
|
+
* }
|
|
38
|
+
*
|
|
39
|
+
* const newConfiguration = {
|
|
40
|
+
* content: '…',
|
|
41
|
+
* }
|
|
42
|
+
* ```
|
|
43
|
+
**/
|
|
44
|
+
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
|
|
45
|
+
/**
|
|
46
|
+
* The title of the OpenAPI document.
|
|
47
|
+
*
|
|
48
|
+
* @example 'Scalar Galaxy'
|
|
49
|
+
*
|
|
50
|
+
* @deprecated Please move `title` to the top level and remove the `spec` prefix.
|
|
51
|
+
*/
|
|
52
|
+
title: z.ZodOptional<z.ZodString>;
|
|
53
|
+
/**
|
|
54
|
+
* The slug of the OpenAPI document used in the URL.
|
|
55
|
+
*
|
|
56
|
+
* If none is passed, the title will be used.
|
|
57
|
+
*
|
|
58
|
+
* If no title is used, it’ll just use the index.
|
|
59
|
+
*
|
|
60
|
+
* @example 'scalar-galaxy'
|
|
61
|
+
*
|
|
62
|
+
* @deprecated Please move `slug` to the top level and remove the `spec` prefix.
|
|
63
|
+
*/
|
|
64
|
+
slug: z.ZodOptional<z.ZodString>;
|
|
65
|
+
}, "strip", z.ZodTypeAny, {
|
|
66
|
+
url?: string | undefined;
|
|
67
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
68
|
+
title?: string | undefined;
|
|
69
|
+
slug?: string | undefined;
|
|
70
|
+
}, {
|
|
71
|
+
url?: string | undefined;
|
|
72
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
73
|
+
title?: string | undefined;
|
|
74
|
+
slug?: string | undefined;
|
|
75
|
+
}>;
|
|
76
|
+
export type SpecConfiguration = z.infer<typeof specConfigurationSchema>;
|
|
2
77
|
/** Configuration for the Api Client */
|
|
3
78
|
export declare const apiClientConfigurationSchema: z.ZodObject<{
|
|
79
|
+
/**
|
|
80
|
+
* URL to an OpenAPI/Swagger document
|
|
81
|
+
**/
|
|
82
|
+
url: z.ZodOptional<z.ZodString>;
|
|
83
|
+
/**
|
|
84
|
+
* Directly embed the OpenAPI document.
|
|
85
|
+
* Can be a string, object, function returning an object, or null.
|
|
86
|
+
*
|
|
87
|
+
* @remarks It’s recommended to pass a URL instead of content.
|
|
88
|
+
**/
|
|
89
|
+
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
|
|
90
|
+
/**
|
|
91
|
+
* The title of the OpenAPI document.
|
|
92
|
+
*
|
|
93
|
+
* @example 'Scalar Galaxy'
|
|
94
|
+
*/
|
|
95
|
+
title: z.ZodOptional<z.ZodString>;
|
|
96
|
+
/**
|
|
97
|
+
* The slug of the OpenAPI document used in the URL.
|
|
98
|
+
*
|
|
99
|
+
* If none is passed, the title will be used.
|
|
100
|
+
*
|
|
101
|
+
* If no title is used, it’ll just use the index.
|
|
102
|
+
*
|
|
103
|
+
* @example 'scalar-galaxy'
|
|
104
|
+
*/
|
|
105
|
+
slug: z.ZodOptional<z.ZodString>;
|
|
106
|
+
/**
|
|
107
|
+
* The OpenAPI/Swagger document to render
|
|
108
|
+
*
|
|
109
|
+
* @deprecated Use `url` and `content` on the top level instead.
|
|
110
|
+
**/
|
|
111
|
+
spec: z.ZodOptional<z.ZodObject<{
|
|
112
|
+
/**
|
|
113
|
+
* URL to an OpenAPI/Swagger document
|
|
114
|
+
*
|
|
115
|
+
* @deprecated Please move `url` to the top level and remove the `spec` prefix.
|
|
116
|
+
*
|
|
117
|
+
* @example
|
|
118
|
+
* ```ts
|
|
119
|
+
* const oldConfiguration = {
|
|
120
|
+
* spec: {
|
|
121
|
+
* url: 'https://example.com/openapi.json',
|
|
122
|
+
* },
|
|
123
|
+
* }
|
|
124
|
+
*
|
|
125
|
+
* const newConfiguration = {
|
|
126
|
+
* url: 'https://example.com/openapi.json',
|
|
127
|
+
* }
|
|
128
|
+
* ```
|
|
129
|
+
**/
|
|
130
|
+
url: z.ZodOptional<z.ZodString>;
|
|
131
|
+
/**
|
|
132
|
+
* Directly embed the OpenAPI document.
|
|
133
|
+
* Can be a string, object, function returning an object, or null.
|
|
134
|
+
*
|
|
135
|
+
* @remarks It's recommended to pass a URL instead of content.
|
|
136
|
+
*
|
|
137
|
+
* @deprecated Please move `content` to the top level and remove the `spec` prefix.
|
|
138
|
+
*
|
|
139
|
+
* @example
|
|
140
|
+
* ```ts
|
|
141
|
+
* const oldConfiguration = {
|
|
142
|
+
* spec: {
|
|
143
|
+
* content: '…',
|
|
144
|
+
* },
|
|
145
|
+
* }
|
|
146
|
+
*
|
|
147
|
+
* const newConfiguration = {
|
|
148
|
+
* content: '…',
|
|
149
|
+
* }
|
|
150
|
+
* ```
|
|
151
|
+
**/
|
|
152
|
+
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
|
|
153
|
+
/**
|
|
154
|
+
* The title of the OpenAPI document.
|
|
155
|
+
*
|
|
156
|
+
* @example 'Scalar Galaxy'
|
|
157
|
+
*
|
|
158
|
+
* @deprecated Please move `title` to the top level and remove the `spec` prefix.
|
|
159
|
+
*/
|
|
160
|
+
title: z.ZodOptional<z.ZodString>;
|
|
161
|
+
/**
|
|
162
|
+
* The slug of the OpenAPI document used in the URL.
|
|
163
|
+
*
|
|
164
|
+
* If none is passed, the title will be used.
|
|
165
|
+
*
|
|
166
|
+
* If no title is used, it’ll just use the index.
|
|
167
|
+
*
|
|
168
|
+
* @example 'scalar-galaxy'
|
|
169
|
+
*
|
|
170
|
+
* @deprecated Please move `slug` to the top level and remove the `spec` prefix.
|
|
171
|
+
*/
|
|
172
|
+
slug: z.ZodOptional<z.ZodString>;
|
|
173
|
+
}, "strip", z.ZodTypeAny, {
|
|
174
|
+
url?: string | undefined;
|
|
175
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
176
|
+
title?: string | undefined;
|
|
177
|
+
slug?: string | undefined;
|
|
178
|
+
}, {
|
|
179
|
+
url?: string | undefined;
|
|
180
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
181
|
+
title?: string | undefined;
|
|
182
|
+
slug?: string | undefined;
|
|
183
|
+
}>>;
|
|
4
184
|
/** Prefill authentication */
|
|
5
185
|
authentication: z.ZodOptional<z.ZodAny>;
|
|
6
186
|
/** Base URL for the API server */
|
|
@@ -21,23 +201,6 @@ export declare const apiClientConfigurationSchema: z.ZodObject<{
|
|
|
21
201
|
* @default true
|
|
22
202
|
*/
|
|
23
203
|
showSidebar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
|
|
24
|
-
/** The Swagger/OpenAPI spec to render */
|
|
25
|
-
spec: z.ZodOptional<z.ZodObject<{
|
|
26
|
-
/** URL to an OpenAPI/Swagger document */
|
|
27
|
-
url: z.ZodOptional<z.ZodString>;
|
|
28
|
-
/**
|
|
29
|
-
* Directly embed the OpenAPI document.
|
|
30
|
-
* Can be a string, object, function returning an object, or null.
|
|
31
|
-
* @remarks It's recommended to pass a URL instead of content.
|
|
32
|
-
*/
|
|
33
|
-
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
|
|
34
|
-
}, "strip", z.ZodTypeAny, {
|
|
35
|
-
url?: string | undefined;
|
|
36
|
-
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
37
|
-
}, {
|
|
38
|
-
url?: string | undefined;
|
|
39
|
-
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
40
|
-
}>>;
|
|
41
204
|
/** A string to use one of the color presets */
|
|
42
205
|
theme: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<["alternate", "default", "moon", "purple", "solarized", "bluePlanet", "deepSpace", "saturn", "kepler", "elysiajs", "fastify", "mars", "none"]>>>>;
|
|
43
206
|
/** Integration type identifier */
|
|
@@ -46,34 +209,151 @@ export declare const apiClientConfigurationSchema: z.ZodObject<{
|
|
|
46
209
|
hideClientButton: boolean;
|
|
47
210
|
showSidebar: boolean;
|
|
48
211
|
theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
|
|
49
|
-
|
|
212
|
+
url?: string | undefined;
|
|
213
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
214
|
+
title?: string | undefined;
|
|
215
|
+
slug?: string | undefined;
|
|
216
|
+
spec?: {
|
|
217
|
+
url?: string | undefined;
|
|
218
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
219
|
+
title?: string | undefined;
|
|
220
|
+
slug?: string | undefined;
|
|
221
|
+
} | undefined;
|
|
50
222
|
authentication?: any;
|
|
51
223
|
baseServerURL?: string | undefined;
|
|
52
224
|
proxyUrl?: string | undefined;
|
|
53
|
-
searchHotKey?: "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "
|
|
225
|
+
searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
|
|
226
|
+
servers?: any[] | undefined;
|
|
227
|
+
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
|
|
228
|
+
}, {
|
|
229
|
+
url?: string | undefined;
|
|
230
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
231
|
+
title?: string | undefined;
|
|
232
|
+
slug?: string | undefined;
|
|
54
233
|
spec?: {
|
|
55
234
|
url?: string | undefined;
|
|
56
235
|
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
236
|
+
title?: string | undefined;
|
|
237
|
+
slug?: string | undefined;
|
|
57
238
|
} | undefined;
|
|
58
|
-
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
|
|
59
|
-
}, {
|
|
60
|
-
servers?: any[] | undefined;
|
|
61
239
|
authentication?: any;
|
|
62
240
|
baseServerURL?: string | undefined;
|
|
63
241
|
hideClientButton?: unknown;
|
|
64
242
|
proxyUrl?: string | undefined;
|
|
65
|
-
searchHotKey?: "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "
|
|
243
|
+
searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
|
|
244
|
+
servers?: any[] | undefined;
|
|
66
245
|
showSidebar?: unknown;
|
|
67
|
-
spec?: {
|
|
68
|
-
url?: string | undefined;
|
|
69
|
-
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
70
|
-
} | undefined;
|
|
71
246
|
theme?: unknown;
|
|
72
247
|
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
|
|
73
248
|
}>;
|
|
74
249
|
export type ApiClientConfiguration = z.infer<typeof apiClientConfigurationSchema>;
|
|
75
250
|
/** Configuration for the Api Reference */
|
|
76
251
|
export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendShape<{
|
|
252
|
+
/**
|
|
253
|
+
* URL to an OpenAPI/Swagger document
|
|
254
|
+
**/
|
|
255
|
+
url: z.ZodOptional<z.ZodString>;
|
|
256
|
+
/**
|
|
257
|
+
* Directly embed the OpenAPI document.
|
|
258
|
+
* Can be a string, object, function returning an object, or null.
|
|
259
|
+
*
|
|
260
|
+
* @remarks It’s recommended to pass a URL instead of content.
|
|
261
|
+
**/
|
|
262
|
+
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
|
|
263
|
+
/**
|
|
264
|
+
* The title of the OpenAPI document.
|
|
265
|
+
*
|
|
266
|
+
* @example 'Scalar Galaxy'
|
|
267
|
+
*/
|
|
268
|
+
title: z.ZodOptional<z.ZodString>;
|
|
269
|
+
/**
|
|
270
|
+
* The slug of the OpenAPI document used in the URL.
|
|
271
|
+
*
|
|
272
|
+
* If none is passed, the title will be used.
|
|
273
|
+
*
|
|
274
|
+
* If no title is used, it’ll just use the index.
|
|
275
|
+
*
|
|
276
|
+
* @example 'scalar-galaxy'
|
|
277
|
+
*/
|
|
278
|
+
slug: z.ZodOptional<z.ZodString>;
|
|
279
|
+
/**
|
|
280
|
+
* The OpenAPI/Swagger document to render
|
|
281
|
+
*
|
|
282
|
+
* @deprecated Use `url` and `content` on the top level instead.
|
|
283
|
+
**/
|
|
284
|
+
spec: z.ZodOptional<z.ZodObject<{
|
|
285
|
+
/**
|
|
286
|
+
* URL to an OpenAPI/Swagger document
|
|
287
|
+
*
|
|
288
|
+
* @deprecated Please move `url` to the top level and remove the `spec` prefix.
|
|
289
|
+
*
|
|
290
|
+
* @example
|
|
291
|
+
* ```ts
|
|
292
|
+
* const oldConfiguration = {
|
|
293
|
+
* spec: {
|
|
294
|
+
* url: 'https://example.com/openapi.json',
|
|
295
|
+
* },
|
|
296
|
+
* }
|
|
297
|
+
*
|
|
298
|
+
* const newConfiguration = {
|
|
299
|
+
* url: 'https://example.com/openapi.json',
|
|
300
|
+
* }
|
|
301
|
+
* ```
|
|
302
|
+
**/
|
|
303
|
+
url: z.ZodOptional<z.ZodString>;
|
|
304
|
+
/**
|
|
305
|
+
* Directly embed the OpenAPI document.
|
|
306
|
+
* Can be a string, object, function returning an object, or null.
|
|
307
|
+
*
|
|
308
|
+
* @remarks It's recommended to pass a URL instead of content.
|
|
309
|
+
*
|
|
310
|
+
* @deprecated Please move `content` to the top level and remove the `spec` prefix.
|
|
311
|
+
*
|
|
312
|
+
* @example
|
|
313
|
+
* ```ts
|
|
314
|
+
* const oldConfiguration = {
|
|
315
|
+
* spec: {
|
|
316
|
+
* content: '…',
|
|
317
|
+
* },
|
|
318
|
+
* }
|
|
319
|
+
*
|
|
320
|
+
* const newConfiguration = {
|
|
321
|
+
* content: '…',
|
|
322
|
+
* }
|
|
323
|
+
* ```
|
|
324
|
+
**/
|
|
325
|
+
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
|
|
326
|
+
/**
|
|
327
|
+
* The title of the OpenAPI document.
|
|
328
|
+
*
|
|
329
|
+
* @example 'Scalar Galaxy'
|
|
330
|
+
*
|
|
331
|
+
* @deprecated Please move `title` to the top level and remove the `spec` prefix.
|
|
332
|
+
*/
|
|
333
|
+
title: z.ZodOptional<z.ZodString>;
|
|
334
|
+
/**
|
|
335
|
+
* The slug of the OpenAPI document used in the URL.
|
|
336
|
+
*
|
|
337
|
+
* If none is passed, the title will be used.
|
|
338
|
+
*
|
|
339
|
+
* If no title is used, it’ll just use the index.
|
|
340
|
+
*
|
|
341
|
+
* @example 'scalar-galaxy'
|
|
342
|
+
*
|
|
343
|
+
* @deprecated Please move `slug` to the top level and remove the `spec` prefix.
|
|
344
|
+
*/
|
|
345
|
+
slug: z.ZodOptional<z.ZodString>;
|
|
346
|
+
}, "strip", z.ZodTypeAny, {
|
|
347
|
+
url?: string | undefined;
|
|
348
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
349
|
+
title?: string | undefined;
|
|
350
|
+
slug?: string | undefined;
|
|
351
|
+
}, {
|
|
352
|
+
url?: string | undefined;
|
|
353
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
354
|
+
title?: string | undefined;
|
|
355
|
+
slug?: string | undefined;
|
|
356
|
+
}>>;
|
|
77
357
|
/** Prefill authentication */
|
|
78
358
|
authentication: z.ZodOptional<z.ZodAny>;
|
|
79
359
|
/** Base URL for the API server */
|
|
@@ -94,23 +374,6 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
94
374
|
* @default true
|
|
95
375
|
*/
|
|
96
376
|
showSidebar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
|
|
97
|
-
/** The Swagger/OpenAPI spec to render */
|
|
98
|
-
spec: z.ZodOptional<z.ZodObject<{
|
|
99
|
-
/** URL to an OpenAPI/Swagger document */
|
|
100
|
-
url: z.ZodOptional<z.ZodString>;
|
|
101
|
-
/**
|
|
102
|
-
* Directly embed the OpenAPI document.
|
|
103
|
-
* Can be a string, object, function returning an object, or null.
|
|
104
|
-
* @remarks It's recommended to pass a URL instead of content.
|
|
105
|
-
*/
|
|
106
|
-
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
|
|
107
|
-
}, "strip", z.ZodTypeAny, {
|
|
108
|
-
url?: string | undefined;
|
|
109
|
-
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
110
|
-
}, {
|
|
111
|
-
url?: string | undefined;
|
|
112
|
-
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
113
|
-
}>>;
|
|
114
377
|
/** A string to use one of the color presets */
|
|
115
378
|
theme: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<["alternate", "default", "moon", "purple", "solarized", "bluePlanet", "deepSpace", "saturn", "kepler", "elysiajs", "fastify", "mars", "none"]>>>>;
|
|
116
379
|
/** Integration type identifier */
|
|
@@ -258,15 +521,15 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
258
521
|
method: z.ZodString;
|
|
259
522
|
summary: z.ZodOptional<z.ZodString>;
|
|
260
523
|
}, "strip", z.ZodTypeAny, {
|
|
261
|
-
method: string;
|
|
262
524
|
path: string;
|
|
263
|
-
|
|
525
|
+
method: string;
|
|
264
526
|
operationId?: string | undefined;
|
|
527
|
+
summary?: string | undefined;
|
|
265
528
|
}, {
|
|
266
|
-
method: string;
|
|
267
529
|
path: string;
|
|
268
|
-
|
|
530
|
+
method: string;
|
|
269
531
|
operationId?: string | undefined;
|
|
532
|
+
summary?: string | undefined;
|
|
270
533
|
}>], z.ZodUnknown>, z.ZodString>>;
|
|
271
534
|
/**
|
|
272
535
|
* Customize the webhook portion of the hash
|
|
@@ -285,7 +548,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
285
548
|
method?: string | undefined;
|
|
286
549
|
}>], z.ZodUnknown>, z.ZodString>>;
|
|
287
550
|
/** Callback fired when the reference is fully loaded */
|
|
288
|
-
onLoaded: z.ZodOptional<z.
|
|
551
|
+
onLoaded: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
|
|
289
552
|
/**
|
|
290
553
|
* To handle redirects, pass a function that will recieve:
|
|
291
554
|
* - The current path with hash if pathRouting is enabled
|
|
@@ -336,15 +599,21 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
336
599
|
hideSearch: boolean;
|
|
337
600
|
hideDarkModeToggle: boolean;
|
|
338
601
|
withDefaultFonts: boolean;
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
searchHotKey?: "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
|
|
602
|
+
url?: string | undefined;
|
|
603
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
604
|
+
title?: string | undefined;
|
|
605
|
+
slug?: string | undefined;
|
|
344
606
|
spec?: {
|
|
345
607
|
url?: string | undefined;
|
|
346
608
|
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
609
|
+
title?: string | undefined;
|
|
610
|
+
slug?: string | undefined;
|
|
347
611
|
} | undefined;
|
|
612
|
+
authentication?: any;
|
|
613
|
+
baseServerURL?: string | undefined;
|
|
614
|
+
proxyUrl?: string | undefined;
|
|
615
|
+
searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
|
|
616
|
+
servers?: any[] | undefined;
|
|
348
617
|
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
|
|
349
618
|
proxy?: string | undefined;
|
|
350
619
|
darkMode?: boolean | undefined;
|
|
@@ -372,10 +641,10 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
372
641
|
name?: string | undefined;
|
|
373
642
|
}, ...args: unknown[]) => string) | undefined;
|
|
374
643
|
generateOperationSlug?: ((args_0: {
|
|
375
|
-
method: string;
|
|
376
644
|
path: string;
|
|
377
|
-
|
|
645
|
+
method: string;
|
|
378
646
|
operationId?: string | undefined;
|
|
647
|
+
summary?: string | undefined;
|
|
379
648
|
}, ...args: unknown[]) => string) | undefined;
|
|
380
649
|
generateWebhookSlug?: ((args_0: {
|
|
381
650
|
name: string;
|
|
@@ -385,19 +654,25 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
385
654
|
redirect?: ((args_0: string, ...args: unknown[]) => string | null | undefined) | undefined;
|
|
386
655
|
defaultOpenAllTags?: boolean | undefined;
|
|
387
656
|
tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
388
|
-
operationsSorter?: "
|
|
657
|
+
operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
389
658
|
}, {
|
|
390
|
-
|
|
659
|
+
url?: string | undefined;
|
|
660
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
661
|
+
title?: string | undefined;
|
|
662
|
+
slug?: string | undefined;
|
|
663
|
+
spec?: {
|
|
664
|
+
url?: string | undefined;
|
|
665
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
666
|
+
title?: string | undefined;
|
|
667
|
+
slug?: string | undefined;
|
|
668
|
+
} | undefined;
|
|
391
669
|
authentication?: any;
|
|
392
670
|
baseServerURL?: string | undefined;
|
|
393
671
|
hideClientButton?: unknown;
|
|
394
672
|
proxyUrl?: string | undefined;
|
|
395
|
-
searchHotKey?: "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "
|
|
673
|
+
searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
|
|
674
|
+
servers?: any[] | undefined;
|
|
396
675
|
showSidebar?: unknown;
|
|
397
|
-
spec?: {
|
|
398
|
-
url?: string | undefined;
|
|
399
|
-
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
400
|
-
} | undefined;
|
|
401
676
|
theme?: unknown;
|
|
402
677
|
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
|
|
403
678
|
layout?: unknown;
|
|
@@ -433,10 +708,10 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
433
708
|
name: string;
|
|
434
709
|
}, ...args: unknown[]) => string) | undefined;
|
|
435
710
|
generateOperationSlug?: ((args_0: {
|
|
436
|
-
method: string;
|
|
437
711
|
path: string;
|
|
438
|
-
|
|
712
|
+
method: string;
|
|
439
713
|
operationId?: string | undefined;
|
|
714
|
+
summary?: string | undefined;
|
|
440
715
|
}, ...args: unknown[]) => string) | undefined;
|
|
441
716
|
generateWebhookSlug?: ((args_0: {
|
|
442
717
|
name: string;
|
|
@@ -447,7 +722,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
447
722
|
withDefaultFonts?: unknown;
|
|
448
723
|
defaultOpenAllTags?: boolean | undefined;
|
|
449
724
|
tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
450
|
-
operationsSorter?: "
|
|
725
|
+
operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
451
726
|
}>, {
|
|
452
727
|
hideClientButton: boolean;
|
|
453
728
|
showSidebar: boolean;
|
|
@@ -460,15 +735,21 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
460
735
|
hideSearch: boolean;
|
|
461
736
|
hideDarkModeToggle: boolean;
|
|
462
737
|
withDefaultFonts: boolean;
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
searchHotKey?: "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
|
|
738
|
+
url?: string | undefined;
|
|
739
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
740
|
+
title?: string | undefined;
|
|
741
|
+
slug?: string | undefined;
|
|
468
742
|
spec?: {
|
|
469
743
|
url?: string | undefined;
|
|
470
744
|
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
745
|
+
title?: string | undefined;
|
|
746
|
+
slug?: string | undefined;
|
|
471
747
|
} | undefined;
|
|
748
|
+
authentication?: any;
|
|
749
|
+
baseServerURL?: string | undefined;
|
|
750
|
+
proxyUrl?: string | undefined;
|
|
751
|
+
searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
|
|
752
|
+
servers?: any[] | undefined;
|
|
472
753
|
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
|
|
473
754
|
proxy?: string | undefined;
|
|
474
755
|
darkMode?: boolean | undefined;
|
|
@@ -496,10 +777,10 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
496
777
|
name?: string | undefined;
|
|
497
778
|
}, ...args: unknown[]) => string) | undefined;
|
|
498
779
|
generateOperationSlug?: ((args_0: {
|
|
499
|
-
method: string;
|
|
500
780
|
path: string;
|
|
501
|
-
|
|
781
|
+
method: string;
|
|
502
782
|
operationId?: string | undefined;
|
|
783
|
+
summary?: string | undefined;
|
|
503
784
|
}, ...args: unknown[]) => string) | undefined;
|
|
504
785
|
generateWebhookSlug?: ((args_0: {
|
|
505
786
|
name: string;
|
|
@@ -509,19 +790,25 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
509
790
|
redirect?: ((args_0: string, ...args: unknown[]) => string | null | undefined) | undefined;
|
|
510
791
|
defaultOpenAllTags?: boolean | undefined;
|
|
511
792
|
tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
512
|
-
operationsSorter?: "
|
|
793
|
+
operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
513
794
|
}, {
|
|
514
|
-
|
|
795
|
+
url?: string | undefined;
|
|
796
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
797
|
+
title?: string | undefined;
|
|
798
|
+
slug?: string | undefined;
|
|
799
|
+
spec?: {
|
|
800
|
+
url?: string | undefined;
|
|
801
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
802
|
+
title?: string | undefined;
|
|
803
|
+
slug?: string | undefined;
|
|
804
|
+
} | undefined;
|
|
515
805
|
authentication?: any;
|
|
516
806
|
baseServerURL?: string | undefined;
|
|
517
807
|
hideClientButton?: unknown;
|
|
518
808
|
proxyUrl?: string | undefined;
|
|
519
|
-
searchHotKey?: "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "
|
|
809
|
+
searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
|
|
810
|
+
servers?: any[] | undefined;
|
|
520
811
|
showSidebar?: unknown;
|
|
521
|
-
spec?: {
|
|
522
|
-
url?: string | undefined;
|
|
523
|
-
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
524
|
-
} | undefined;
|
|
525
812
|
theme?: unknown;
|
|
526
813
|
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
|
|
527
814
|
layout?: unknown;
|
|
@@ -557,10 +844,10 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
557
844
|
name: string;
|
|
558
845
|
}, ...args: unknown[]) => string) | undefined;
|
|
559
846
|
generateOperationSlug?: ((args_0: {
|
|
560
|
-
method: string;
|
|
561
847
|
path: string;
|
|
562
|
-
|
|
848
|
+
method: string;
|
|
563
849
|
operationId?: string | undefined;
|
|
850
|
+
summary?: string | undefined;
|
|
564
851
|
}, ...args: unknown[]) => string) | undefined;
|
|
565
852
|
generateWebhookSlug?: ((args_0: {
|
|
566
853
|
name: string;
|
|
@@ -571,8 +858,724 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
571
858
|
withDefaultFonts?: unknown;
|
|
572
859
|
defaultOpenAllTags?: boolean | undefined;
|
|
573
860
|
tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
574
|
-
operationsSorter?: "
|
|
861
|
+
operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
575
862
|
}>;
|
|
576
863
|
/** Configuration after parsing, this is the main type */
|
|
577
|
-
export type ApiReferenceConfiguration = Omit<z.infer<typeof apiReferenceConfigurationSchema>, 'proxy'>;
|
|
864
|
+
export type ApiReferenceConfiguration = Omit<z.infer<typeof apiReferenceConfigurationSchema>, 'proxy' | 'spec'>;
|
|
865
|
+
/** Props for the ApiReference components, coming from user input */
|
|
866
|
+
export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
867
|
+
/**
|
|
868
|
+
* URL to an OpenAPI/Swagger document
|
|
869
|
+
**/
|
|
870
|
+
url: z.ZodOptional<z.ZodString>;
|
|
871
|
+
/**
|
|
872
|
+
* Directly embed the OpenAPI document.
|
|
873
|
+
* Can be a string, object, function returning an object, or null.
|
|
874
|
+
*
|
|
875
|
+
* @remarks It’s recommended to pass a URL instead of content.
|
|
876
|
+
**/
|
|
877
|
+
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
|
|
878
|
+
/**
|
|
879
|
+
* The title of the OpenAPI document.
|
|
880
|
+
*
|
|
881
|
+
* @example 'Scalar Galaxy'
|
|
882
|
+
*/
|
|
883
|
+
title: z.ZodOptional<z.ZodString>;
|
|
884
|
+
/**
|
|
885
|
+
* The slug of the OpenAPI document used in the URL.
|
|
886
|
+
*
|
|
887
|
+
* If none is passed, the title will be used.
|
|
888
|
+
*
|
|
889
|
+
* If no title is used, it’ll just use the index.
|
|
890
|
+
*
|
|
891
|
+
* @example 'scalar-galaxy'
|
|
892
|
+
*/
|
|
893
|
+
slug: z.ZodOptional<z.ZodString>;
|
|
894
|
+
/**
|
|
895
|
+
* The OpenAPI/Swagger document to render
|
|
896
|
+
*
|
|
897
|
+
* @deprecated Use `url` and `content` on the top level instead.
|
|
898
|
+
**/
|
|
899
|
+
spec: z.ZodOptional<z.ZodObject<{
|
|
900
|
+
/**
|
|
901
|
+
* URL to an OpenAPI/Swagger document
|
|
902
|
+
*
|
|
903
|
+
* @deprecated Please move `url` to the top level and remove the `spec` prefix.
|
|
904
|
+
*
|
|
905
|
+
* @example
|
|
906
|
+
* ```ts
|
|
907
|
+
* const oldConfiguration = {
|
|
908
|
+
* spec: {
|
|
909
|
+
* url: 'https://example.com/openapi.json',
|
|
910
|
+
* },
|
|
911
|
+
* }
|
|
912
|
+
*
|
|
913
|
+
* const newConfiguration = {
|
|
914
|
+
* url: 'https://example.com/openapi.json',
|
|
915
|
+
* }
|
|
916
|
+
* ```
|
|
917
|
+
**/
|
|
918
|
+
url: z.ZodOptional<z.ZodString>;
|
|
919
|
+
/**
|
|
920
|
+
* Directly embed the OpenAPI document.
|
|
921
|
+
* Can be a string, object, function returning an object, or null.
|
|
922
|
+
*
|
|
923
|
+
* @remarks It's recommended to pass a URL instead of content.
|
|
924
|
+
*
|
|
925
|
+
* @deprecated Please move `content` to the top level and remove the `spec` prefix.
|
|
926
|
+
*
|
|
927
|
+
* @example
|
|
928
|
+
* ```ts
|
|
929
|
+
* const oldConfiguration = {
|
|
930
|
+
* spec: {
|
|
931
|
+
* content: '…',
|
|
932
|
+
* },
|
|
933
|
+
* }
|
|
934
|
+
*
|
|
935
|
+
* const newConfiguration = {
|
|
936
|
+
* content: '…',
|
|
937
|
+
* }
|
|
938
|
+
* ```
|
|
939
|
+
**/
|
|
940
|
+
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
|
|
941
|
+
/**
|
|
942
|
+
* The title of the OpenAPI document.
|
|
943
|
+
*
|
|
944
|
+
* @example 'Scalar Galaxy'
|
|
945
|
+
*
|
|
946
|
+
* @deprecated Please move `title` to the top level and remove the `spec` prefix.
|
|
947
|
+
*/
|
|
948
|
+
title: z.ZodOptional<z.ZodString>;
|
|
949
|
+
/**
|
|
950
|
+
* The slug of the OpenAPI document used in the URL.
|
|
951
|
+
*
|
|
952
|
+
* If none is passed, the title will be used.
|
|
953
|
+
*
|
|
954
|
+
* If no title is used, it’ll just use the index.
|
|
955
|
+
*
|
|
956
|
+
* @example 'scalar-galaxy'
|
|
957
|
+
*
|
|
958
|
+
* @deprecated Please move `slug` to the top level and remove the `spec` prefix.
|
|
959
|
+
*/
|
|
960
|
+
slug: z.ZodOptional<z.ZodString>;
|
|
961
|
+
}, "strip", z.ZodTypeAny, {
|
|
962
|
+
url?: string | undefined;
|
|
963
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
964
|
+
title?: string | undefined;
|
|
965
|
+
slug?: string | undefined;
|
|
966
|
+
}, {
|
|
967
|
+
url?: string | undefined;
|
|
968
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
969
|
+
title?: string | undefined;
|
|
970
|
+
slug?: string | undefined;
|
|
971
|
+
}>>;
|
|
972
|
+
/** Prefill authentication */
|
|
973
|
+
authentication: z.ZodOptional<z.ZodAny>;
|
|
974
|
+
/** Base URL for the API server */
|
|
975
|
+
baseServerURL: z.ZodOptional<z.ZodString>;
|
|
976
|
+
/**
|
|
977
|
+
* Whether to hide the client button
|
|
978
|
+
* @default false
|
|
979
|
+
*/
|
|
980
|
+
hideClientButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
|
|
981
|
+
/** URL to a request proxy for the API client */
|
|
982
|
+
proxyUrl: z.ZodOptional<z.ZodString>;
|
|
983
|
+
/** Key used with CTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k) */
|
|
984
|
+
searchHotKey: z.ZodOptional<z.ZodEnum<["a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z"]>>;
|
|
985
|
+
/** List of OpenAPI server objects */
|
|
986
|
+
servers: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
|
|
987
|
+
/**
|
|
988
|
+
* Whether to show the sidebar
|
|
989
|
+
* @default true
|
|
990
|
+
*/
|
|
991
|
+
showSidebar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
|
|
992
|
+
/** A string to use one of the color presets */
|
|
993
|
+
theme: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<["alternate", "default", "moon", "purple", "solarized", "bluePlanet", "deepSpace", "saturn", "kepler", "elysiajs", "fastify", "mars", "none"]>>>>;
|
|
994
|
+
/** Integration type identifier */
|
|
995
|
+
_integration: z.ZodOptional<z.ZodNullable<z.ZodEnum<["adonisjs", "docusaurus", "dotnet", "elysiajs", "express", "fastapi", "fastify", "go", "hono", "html", "laravel", "litestar", "nestjs", "nextjs", "nitro", "nuxt", "platformatic", "react", "rust", "vue"]>>>;
|
|
996
|
+
}, {
|
|
997
|
+
/**
|
|
998
|
+
* The layout to use for the references
|
|
999
|
+
* @default 'modern'
|
|
1000
|
+
*/
|
|
1001
|
+
layout: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<["modern", "classic"]>>>>;
|
|
1002
|
+
/**
|
|
1003
|
+
* URL to a request proxy for the API client
|
|
1004
|
+
* @deprecated Use proxyUrl instead
|
|
1005
|
+
*/
|
|
1006
|
+
proxy: z.ZodOptional<z.ZodString>;
|
|
1007
|
+
/**
|
|
1008
|
+
* Whether the spec input should show
|
|
1009
|
+
* @default false
|
|
1010
|
+
*/
|
|
1011
|
+
isEditable: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
|
|
1012
|
+
/**
|
|
1013
|
+
* Whether to show models in the sidebar, search, and content.
|
|
1014
|
+
* @default false
|
|
1015
|
+
*/
|
|
1016
|
+
hideModels: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
|
|
1017
|
+
/**
|
|
1018
|
+
* Whether to show the "Download OpenAPI Document" button
|
|
1019
|
+
* @default false
|
|
1020
|
+
*/
|
|
1021
|
+
hideDownloadButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
|
|
1022
|
+
/**
|
|
1023
|
+
* Whether to show the "Test Request" button
|
|
1024
|
+
* @default false
|
|
1025
|
+
*/
|
|
1026
|
+
hideTestRequestButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
|
|
1027
|
+
/**
|
|
1028
|
+
* Whether to show the sidebar search bar
|
|
1029
|
+
* @default false
|
|
1030
|
+
*/
|
|
1031
|
+
hideSearch: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
|
|
1032
|
+
/** Whether dark mode is on or off initially (light mode) */
|
|
1033
|
+
darkMode: z.ZodOptional<z.ZodBoolean>;
|
|
1034
|
+
/** forceDarkModeState makes it always this state no matter what */
|
|
1035
|
+
forceDarkModeState: z.ZodOptional<z.ZodEnum<["dark", "light"]>>;
|
|
1036
|
+
/**
|
|
1037
|
+
* Whether to show the dark mode toggle
|
|
1038
|
+
* @default false
|
|
1039
|
+
*/
|
|
1040
|
+
hideDarkModeToggle: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
|
|
1041
|
+
/**
|
|
1042
|
+
* If used, passed data will be added to the HTML header
|
|
1043
|
+
* @see https://unhead.unjs.io/usage/composables/use-seo-meta
|
|
1044
|
+
*/
|
|
1045
|
+
metaData: z.ZodOptional<z.ZodAny>;
|
|
1046
|
+
/**
|
|
1047
|
+
* Path to a favicon image
|
|
1048
|
+
* @default undefined
|
|
1049
|
+
* @example '/favicon.svg'
|
|
1050
|
+
*/
|
|
1051
|
+
favicon: z.ZodOptional<z.ZodString>;
|
|
1052
|
+
/**
|
|
1053
|
+
* List of httpsnippet clients to hide from the clients menu
|
|
1054
|
+
* By default hides Unirest, pass `[]` to show all clients
|
|
1055
|
+
*/
|
|
1056
|
+
hiddenClients: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>, z.ZodArray<z.ZodString, "many">, z.ZodLiteral<true>]>>;
|
|
1057
|
+
/** Determine the HTTP client that's selected by default */
|
|
1058
|
+
defaultHttpClient: z.ZodOptional<z.ZodObject<{
|
|
1059
|
+
targetKey: z.ZodType<"c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart", z.ZodTypeDef, "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart">;
|
|
1060
|
+
clientKey: z.ZodString;
|
|
1061
|
+
}, "strip", z.ZodTypeAny, {
|
|
1062
|
+
targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
|
|
1063
|
+
clientKey: string;
|
|
1064
|
+
}, {
|
|
1065
|
+
targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
|
|
1066
|
+
clientKey: string;
|
|
1067
|
+
}>>;
|
|
1068
|
+
/** Custom CSS to be added to the page */
|
|
1069
|
+
customCss: z.ZodOptional<z.ZodString>;
|
|
1070
|
+
/** onSpecUpdate is fired on spec/swagger content change */
|
|
1071
|
+
onSpecUpdate: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>>;
|
|
1072
|
+
/** onServerChange is fired on selected server change */
|
|
1073
|
+
onServerChange: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>>;
|
|
1074
|
+
/**
|
|
1075
|
+
* Route using paths instead of hashes, your server MUST support this
|
|
1076
|
+
* @example '/standalone-api-reference/:custom(.*)?'
|
|
1077
|
+
* @experimental
|
|
1078
|
+
* @default undefined
|
|
1079
|
+
*/
|
|
1080
|
+
pathRouting: z.ZodOptional<z.ZodObject<{
|
|
1081
|
+
/** Base path for the API reference */
|
|
1082
|
+
basePath: z.ZodString;
|
|
1083
|
+
}, "strip", z.ZodTypeAny, {
|
|
1084
|
+
basePath: string;
|
|
1085
|
+
}, {
|
|
1086
|
+
basePath: string;
|
|
1087
|
+
}>>;
|
|
1088
|
+
/**
|
|
1089
|
+
* Customize the heading portion of the hash
|
|
1090
|
+
* @param heading - The heading object
|
|
1091
|
+
* @returns A string ID used to generate the URL hash
|
|
1092
|
+
* @default (heading) => `#description/${heading.slug}`
|
|
1093
|
+
*/
|
|
1094
|
+
generateHeadingSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
|
|
1095
|
+
slug: z.ZodDefault<z.ZodString>;
|
|
1096
|
+
}, "strip", z.ZodTypeAny, {
|
|
1097
|
+
slug: string;
|
|
1098
|
+
}, {
|
|
1099
|
+
slug?: string | undefined;
|
|
1100
|
+
}>], z.ZodUnknown>, z.ZodString>>;
|
|
1101
|
+
/**
|
|
1102
|
+
* Customize the model portion of the hash
|
|
1103
|
+
* @param model - The model object with a name property
|
|
1104
|
+
* @returns A string ID used to generate the URL hash
|
|
1105
|
+
* @default (model) => slug(model.name)
|
|
1106
|
+
*/
|
|
1107
|
+
generateModelSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
|
|
1108
|
+
name: z.ZodDefault<z.ZodString>;
|
|
1109
|
+
}, "strip", z.ZodTypeAny, {
|
|
1110
|
+
name: string;
|
|
1111
|
+
}, {
|
|
1112
|
+
name?: string | undefined;
|
|
1113
|
+
}>], z.ZodUnknown>, z.ZodString>>;
|
|
1114
|
+
/**
|
|
1115
|
+
* Customize the tag portion of the hash
|
|
1116
|
+
* @param tag - The tag object
|
|
1117
|
+
* @returns A string ID used to generate the URL hash
|
|
1118
|
+
* @default (tag) => slug(tag.name)
|
|
1119
|
+
*/
|
|
1120
|
+
generateTagSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
|
|
1121
|
+
name: z.ZodDefault<z.ZodString>;
|
|
1122
|
+
}, "strip", z.ZodTypeAny, {
|
|
1123
|
+
name: string;
|
|
1124
|
+
}, {
|
|
1125
|
+
name?: string | undefined;
|
|
1126
|
+
}>], z.ZodUnknown>, z.ZodString>>;
|
|
1127
|
+
/**
|
|
1128
|
+
* Customize the operation portion of the hash
|
|
1129
|
+
* @param operation - The operation object
|
|
1130
|
+
* @returns A string ID used to generate the URL hash
|
|
1131
|
+
* @default (operation) => `${operation.method}${operation.path}`
|
|
1132
|
+
*/
|
|
1133
|
+
generateOperationSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
|
|
1134
|
+
path: z.ZodString;
|
|
1135
|
+
operationId: z.ZodOptional<z.ZodString>;
|
|
1136
|
+
method: z.ZodString;
|
|
1137
|
+
summary: z.ZodOptional<z.ZodString>;
|
|
1138
|
+
}, "strip", z.ZodTypeAny, {
|
|
1139
|
+
path: string;
|
|
1140
|
+
method: string;
|
|
1141
|
+
operationId?: string | undefined;
|
|
1142
|
+
summary?: string | undefined;
|
|
1143
|
+
}, {
|
|
1144
|
+
path: string;
|
|
1145
|
+
method: string;
|
|
1146
|
+
operationId?: string | undefined;
|
|
1147
|
+
summary?: string | undefined;
|
|
1148
|
+
}>], z.ZodUnknown>, z.ZodString>>;
|
|
1149
|
+
/**
|
|
1150
|
+
* Customize the webhook portion of the hash
|
|
1151
|
+
* @param webhook - The webhook object
|
|
1152
|
+
* @returns A string ID used to generate the URL hash
|
|
1153
|
+
* @default (webhook) => slug(webhook.name)
|
|
1154
|
+
*/
|
|
1155
|
+
generateWebhookSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
|
|
1156
|
+
name: z.ZodString;
|
|
1157
|
+
method: z.ZodOptional<z.ZodString>;
|
|
1158
|
+
}, "strip", z.ZodTypeAny, {
|
|
1159
|
+
name: string;
|
|
1160
|
+
method?: string | undefined;
|
|
1161
|
+
}, {
|
|
1162
|
+
name: string;
|
|
1163
|
+
method?: string | undefined;
|
|
1164
|
+
}>], z.ZodUnknown>, z.ZodString>>;
|
|
1165
|
+
/** Callback fired when the reference is fully loaded */
|
|
1166
|
+
onLoaded: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
|
|
1167
|
+
/**
|
|
1168
|
+
* To handle redirects, pass a function that will recieve:
|
|
1169
|
+
* - The current path with hash if pathRouting is enabled
|
|
1170
|
+
* - The current hash if hashRouting (default)
|
|
1171
|
+
* And then passes that to history.replaceState
|
|
1172
|
+
*
|
|
1173
|
+
* @example hashRouting (default)
|
|
1174
|
+
* ```ts
|
|
1175
|
+
* redirect: (hash: string) => hash.replace('#v1/old-path', '#v2/new-path')
|
|
1176
|
+
* ```
|
|
1177
|
+
* @example pathRouting
|
|
1178
|
+
* ```ts
|
|
1179
|
+
* redirect: (pathWithHash: string) => {
|
|
1180
|
+
* if (pathWithHash.includes('#')) {
|
|
1181
|
+
* return pathWithHash.replace('/v1/tags/user#operation/get-user', '/v1/tags/user/operation/get-user')
|
|
1182
|
+
* }
|
|
1183
|
+
* return null
|
|
1184
|
+
* }
|
|
1185
|
+
* ```
|
|
1186
|
+
*/
|
|
1187
|
+
redirect: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodOptional<z.ZodNullable<z.ZodString>>>>;
|
|
1188
|
+
/**
|
|
1189
|
+
* Whether to include default fonts
|
|
1190
|
+
* @default true
|
|
1191
|
+
*/
|
|
1192
|
+
withDefaultFonts: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
|
|
1193
|
+
/** Whether to expand all tags by default */
|
|
1194
|
+
defaultOpenAllTags: z.ZodOptional<z.ZodBoolean>;
|
|
1195
|
+
/**
|
|
1196
|
+
* Function to sort tags
|
|
1197
|
+
* @default 'alpha' for alphabetical sorting
|
|
1198
|
+
*/
|
|
1199
|
+
tagsSorter: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"alpha">, z.ZodFunction<z.ZodTuple<[z.ZodAny, z.ZodAny], z.ZodUnknown>, z.ZodNumber>]>>;
|
|
1200
|
+
/**
|
|
1201
|
+
* Function to sort operations
|
|
1202
|
+
* @default 'alpha' for alphabetical sorting
|
|
1203
|
+
*/
|
|
1204
|
+
operationsSorter: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"alpha">, z.ZodLiteral<"method">, z.ZodFunction<z.ZodTuple<[z.ZodAny, z.ZodAny], z.ZodUnknown>, z.ZodNumber>]>>;
|
|
1205
|
+
}>, {
|
|
1206
|
+
sources: z.ZodArray<z.ZodObject<{
|
|
1207
|
+
/**
|
|
1208
|
+
* URL to an OpenAPI/Swagger document
|
|
1209
|
+
*
|
|
1210
|
+
* @deprecated Please move `url` to the top level and remove the `spec` prefix.
|
|
1211
|
+
*
|
|
1212
|
+
* @example
|
|
1213
|
+
* ```ts
|
|
1214
|
+
* const oldConfiguration = {
|
|
1215
|
+
* spec: {
|
|
1216
|
+
* url: 'https://example.com/openapi.json',
|
|
1217
|
+
* },
|
|
1218
|
+
* }
|
|
1219
|
+
*
|
|
1220
|
+
* const newConfiguration = {
|
|
1221
|
+
* url: 'https://example.com/openapi.json',
|
|
1222
|
+
* }
|
|
1223
|
+
* ```
|
|
1224
|
+
**/
|
|
1225
|
+
url: z.ZodOptional<z.ZodString>;
|
|
1226
|
+
/**
|
|
1227
|
+
* Directly embed the OpenAPI document.
|
|
1228
|
+
* Can be a string, object, function returning an object, or null.
|
|
1229
|
+
*
|
|
1230
|
+
* @remarks It's recommended to pass a URL instead of content.
|
|
1231
|
+
*
|
|
1232
|
+
* @deprecated Please move `content` to the top level and remove the `spec` prefix.
|
|
1233
|
+
*
|
|
1234
|
+
* @example
|
|
1235
|
+
* ```ts
|
|
1236
|
+
* const oldConfiguration = {
|
|
1237
|
+
* spec: {
|
|
1238
|
+
* content: '…',
|
|
1239
|
+
* },
|
|
1240
|
+
* }
|
|
1241
|
+
*
|
|
1242
|
+
* const newConfiguration = {
|
|
1243
|
+
* content: '…',
|
|
1244
|
+
* }
|
|
1245
|
+
* ```
|
|
1246
|
+
**/
|
|
1247
|
+
content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
|
|
1248
|
+
/**
|
|
1249
|
+
* The title of the OpenAPI document.
|
|
1250
|
+
*
|
|
1251
|
+
* @example 'Scalar Galaxy'
|
|
1252
|
+
*
|
|
1253
|
+
* @deprecated Please move `title` to the top level and remove the `spec` prefix.
|
|
1254
|
+
*/
|
|
1255
|
+
title: z.ZodOptional<z.ZodString>;
|
|
1256
|
+
/**
|
|
1257
|
+
* The slug of the OpenAPI document used in the URL.
|
|
1258
|
+
*
|
|
1259
|
+
* If none is passed, the title will be used.
|
|
1260
|
+
*
|
|
1261
|
+
* If no title is used, it’ll just use the index.
|
|
1262
|
+
*
|
|
1263
|
+
* @example 'scalar-galaxy'
|
|
1264
|
+
*
|
|
1265
|
+
* @deprecated Please move `slug` to the top level and remove the `spec` prefix.
|
|
1266
|
+
*/
|
|
1267
|
+
slug: z.ZodOptional<z.ZodString>;
|
|
1268
|
+
}, "strip", z.ZodTypeAny, {
|
|
1269
|
+
url?: string | undefined;
|
|
1270
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1271
|
+
title?: string | undefined;
|
|
1272
|
+
slug?: string | undefined;
|
|
1273
|
+
}, {
|
|
1274
|
+
url?: string | undefined;
|
|
1275
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1276
|
+
title?: string | undefined;
|
|
1277
|
+
slug?: string | undefined;
|
|
1278
|
+
}>, "many">;
|
|
1279
|
+
}>, "strip", z.ZodTypeAny, {
|
|
1280
|
+
hideClientButton: boolean;
|
|
1281
|
+
showSidebar: boolean;
|
|
1282
|
+
theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
|
|
1283
|
+
layout: "modern" | "classic";
|
|
1284
|
+
isEditable: boolean;
|
|
1285
|
+
hideModels: boolean;
|
|
1286
|
+
hideDownloadButton: boolean;
|
|
1287
|
+
hideTestRequestButton: boolean;
|
|
1288
|
+
hideSearch: boolean;
|
|
1289
|
+
hideDarkModeToggle: boolean;
|
|
1290
|
+
withDefaultFonts: boolean;
|
|
1291
|
+
sources: {
|
|
1292
|
+
url?: string | undefined;
|
|
1293
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1294
|
+
title?: string | undefined;
|
|
1295
|
+
slug?: string | undefined;
|
|
1296
|
+
}[];
|
|
1297
|
+
url?: string | undefined;
|
|
1298
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1299
|
+
title?: string | undefined;
|
|
1300
|
+
slug?: string | undefined;
|
|
1301
|
+
spec?: {
|
|
1302
|
+
url?: string | undefined;
|
|
1303
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1304
|
+
title?: string | undefined;
|
|
1305
|
+
slug?: string | undefined;
|
|
1306
|
+
} | undefined;
|
|
1307
|
+
authentication?: any;
|
|
1308
|
+
baseServerURL?: string | undefined;
|
|
1309
|
+
proxyUrl?: string | undefined;
|
|
1310
|
+
searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
|
|
1311
|
+
servers?: any[] | undefined;
|
|
1312
|
+
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
|
|
1313
|
+
proxy?: string | undefined;
|
|
1314
|
+
darkMode?: boolean | undefined;
|
|
1315
|
+
forceDarkModeState?: "dark" | "light" | undefined;
|
|
1316
|
+
metaData?: any;
|
|
1317
|
+
favicon?: string | undefined;
|
|
1318
|
+
hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
|
|
1319
|
+
defaultHttpClient?: {
|
|
1320
|
+
targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
|
|
1321
|
+
clientKey: string;
|
|
1322
|
+
} | undefined;
|
|
1323
|
+
customCss?: string | undefined;
|
|
1324
|
+
onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
|
|
1325
|
+
onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
|
|
1326
|
+
pathRouting?: {
|
|
1327
|
+
basePath: string;
|
|
1328
|
+
} | undefined;
|
|
1329
|
+
generateHeadingSlug?: ((args_0: {
|
|
1330
|
+
slug?: string | undefined;
|
|
1331
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1332
|
+
generateModelSlug?: ((args_0: {
|
|
1333
|
+
name?: string | undefined;
|
|
1334
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1335
|
+
generateTagSlug?: ((args_0: {
|
|
1336
|
+
name?: string | undefined;
|
|
1337
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1338
|
+
generateOperationSlug?: ((args_0: {
|
|
1339
|
+
path: string;
|
|
1340
|
+
method: string;
|
|
1341
|
+
operationId?: string | undefined;
|
|
1342
|
+
summary?: string | undefined;
|
|
1343
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1344
|
+
generateWebhookSlug?: ((args_0: {
|
|
1345
|
+
name: string;
|
|
1346
|
+
method?: string | undefined;
|
|
1347
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1348
|
+
onLoaded?: ((...args: unknown[]) => void) | undefined;
|
|
1349
|
+
redirect?: ((args_0: string, ...args: unknown[]) => string | null | undefined) | undefined;
|
|
1350
|
+
defaultOpenAllTags?: boolean | undefined;
|
|
1351
|
+
tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
1352
|
+
operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
1353
|
+
}, {
|
|
1354
|
+
sources: {
|
|
1355
|
+
url?: string | undefined;
|
|
1356
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1357
|
+
title?: string | undefined;
|
|
1358
|
+
slug?: string | undefined;
|
|
1359
|
+
}[];
|
|
1360
|
+
url?: string | undefined;
|
|
1361
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1362
|
+
title?: string | undefined;
|
|
1363
|
+
slug?: string | undefined;
|
|
1364
|
+
spec?: {
|
|
1365
|
+
url?: string | undefined;
|
|
1366
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1367
|
+
title?: string | undefined;
|
|
1368
|
+
slug?: string | undefined;
|
|
1369
|
+
} | undefined;
|
|
1370
|
+
authentication?: any;
|
|
1371
|
+
baseServerURL?: string | undefined;
|
|
1372
|
+
hideClientButton?: unknown;
|
|
1373
|
+
proxyUrl?: string | undefined;
|
|
1374
|
+
searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
|
|
1375
|
+
servers?: any[] | undefined;
|
|
1376
|
+
showSidebar?: unknown;
|
|
1377
|
+
theme?: unknown;
|
|
1378
|
+
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
|
|
1379
|
+
layout?: unknown;
|
|
1380
|
+
proxy?: string | undefined;
|
|
1381
|
+
isEditable?: unknown;
|
|
1382
|
+
hideModels?: unknown;
|
|
1383
|
+
hideDownloadButton?: unknown;
|
|
1384
|
+
hideTestRequestButton?: unknown;
|
|
1385
|
+
hideSearch?: unknown;
|
|
1386
|
+
darkMode?: boolean | undefined;
|
|
1387
|
+
forceDarkModeState?: "dark" | "light" | undefined;
|
|
1388
|
+
hideDarkModeToggle?: unknown;
|
|
1389
|
+
metaData?: any;
|
|
1390
|
+
favicon?: string | undefined;
|
|
1391
|
+
hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
|
|
1392
|
+
defaultHttpClient?: {
|
|
1393
|
+
targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
|
|
1394
|
+
clientKey: string;
|
|
1395
|
+
} | undefined;
|
|
1396
|
+
customCss?: string | undefined;
|
|
1397
|
+
onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
|
|
1398
|
+
onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
|
|
1399
|
+
pathRouting?: {
|
|
1400
|
+
basePath: string;
|
|
1401
|
+
} | undefined;
|
|
1402
|
+
generateHeadingSlug?: ((args_0: {
|
|
1403
|
+
slug: string;
|
|
1404
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1405
|
+
generateModelSlug?: ((args_0: {
|
|
1406
|
+
name: string;
|
|
1407
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1408
|
+
generateTagSlug?: ((args_0: {
|
|
1409
|
+
name: string;
|
|
1410
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1411
|
+
generateOperationSlug?: ((args_0: {
|
|
1412
|
+
path: string;
|
|
1413
|
+
method: string;
|
|
1414
|
+
operationId?: string | undefined;
|
|
1415
|
+
summary?: string | undefined;
|
|
1416
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1417
|
+
generateWebhookSlug?: ((args_0: {
|
|
1418
|
+
name: string;
|
|
1419
|
+
method?: string | undefined;
|
|
1420
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1421
|
+
onLoaded?: ((...args: unknown[]) => void) | undefined;
|
|
1422
|
+
redirect?: ((args_0: string, ...args: unknown[]) => string | null | undefined) | undefined;
|
|
1423
|
+
withDefaultFonts?: unknown;
|
|
1424
|
+
defaultOpenAllTags?: boolean | undefined;
|
|
1425
|
+
tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
1426
|
+
operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
1427
|
+
}>, {
|
|
1428
|
+
hideClientButton: boolean;
|
|
1429
|
+
showSidebar: boolean;
|
|
1430
|
+
theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
|
|
1431
|
+
layout: "modern" | "classic";
|
|
1432
|
+
isEditable: boolean;
|
|
1433
|
+
hideModels: boolean;
|
|
1434
|
+
hideDownloadButton: boolean;
|
|
1435
|
+
hideTestRequestButton: boolean;
|
|
1436
|
+
hideSearch: boolean;
|
|
1437
|
+
hideDarkModeToggle: boolean;
|
|
1438
|
+
withDefaultFonts: boolean;
|
|
1439
|
+
sources: {
|
|
1440
|
+
url?: string | undefined;
|
|
1441
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1442
|
+
title?: string | undefined;
|
|
1443
|
+
slug?: string | undefined;
|
|
1444
|
+
}[];
|
|
1445
|
+
url?: string | undefined;
|
|
1446
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1447
|
+
title?: string | undefined;
|
|
1448
|
+
slug?: string | undefined;
|
|
1449
|
+
spec?: {
|
|
1450
|
+
url?: string | undefined;
|
|
1451
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1452
|
+
title?: string | undefined;
|
|
1453
|
+
slug?: string | undefined;
|
|
1454
|
+
} | undefined;
|
|
1455
|
+
authentication?: any;
|
|
1456
|
+
baseServerURL?: string | undefined;
|
|
1457
|
+
proxyUrl?: string | undefined;
|
|
1458
|
+
searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
|
|
1459
|
+
servers?: any[] | undefined;
|
|
1460
|
+
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
|
|
1461
|
+
proxy?: string | undefined;
|
|
1462
|
+
darkMode?: boolean | undefined;
|
|
1463
|
+
forceDarkModeState?: "dark" | "light" | undefined;
|
|
1464
|
+
metaData?: any;
|
|
1465
|
+
favicon?: string | undefined;
|
|
1466
|
+
hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
|
|
1467
|
+
defaultHttpClient?: {
|
|
1468
|
+
targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
|
|
1469
|
+
clientKey: string;
|
|
1470
|
+
} | undefined;
|
|
1471
|
+
customCss?: string | undefined;
|
|
1472
|
+
onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
|
|
1473
|
+
onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
|
|
1474
|
+
pathRouting?: {
|
|
1475
|
+
basePath: string;
|
|
1476
|
+
} | undefined;
|
|
1477
|
+
generateHeadingSlug?: ((args_0: {
|
|
1478
|
+
slug?: string | undefined;
|
|
1479
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1480
|
+
generateModelSlug?: ((args_0: {
|
|
1481
|
+
name?: string | undefined;
|
|
1482
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1483
|
+
generateTagSlug?: ((args_0: {
|
|
1484
|
+
name?: string | undefined;
|
|
1485
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1486
|
+
generateOperationSlug?: ((args_0: {
|
|
1487
|
+
path: string;
|
|
1488
|
+
method: string;
|
|
1489
|
+
operationId?: string | undefined;
|
|
1490
|
+
summary?: string | undefined;
|
|
1491
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1492
|
+
generateWebhookSlug?: ((args_0: {
|
|
1493
|
+
name: string;
|
|
1494
|
+
method?: string | undefined;
|
|
1495
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1496
|
+
onLoaded?: ((...args: unknown[]) => void) | undefined;
|
|
1497
|
+
redirect?: ((args_0: string, ...args: unknown[]) => string | null | undefined) | undefined;
|
|
1498
|
+
defaultOpenAllTags?: boolean | undefined;
|
|
1499
|
+
tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
1500
|
+
operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
1501
|
+
}, {
|
|
1502
|
+
sources: {
|
|
1503
|
+
url?: string | undefined;
|
|
1504
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1505
|
+
title?: string | undefined;
|
|
1506
|
+
slug?: string | undefined;
|
|
1507
|
+
}[];
|
|
1508
|
+
url?: string | undefined;
|
|
1509
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1510
|
+
title?: string | undefined;
|
|
1511
|
+
slug?: string | undefined;
|
|
1512
|
+
spec?: {
|
|
1513
|
+
url?: string | undefined;
|
|
1514
|
+
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1515
|
+
title?: string | undefined;
|
|
1516
|
+
slug?: string | undefined;
|
|
1517
|
+
} | undefined;
|
|
1518
|
+
authentication?: any;
|
|
1519
|
+
baseServerURL?: string | undefined;
|
|
1520
|
+
hideClientButton?: unknown;
|
|
1521
|
+
proxyUrl?: string | undefined;
|
|
1522
|
+
searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
|
|
1523
|
+
servers?: any[] | undefined;
|
|
1524
|
+
showSidebar?: unknown;
|
|
1525
|
+
theme?: unknown;
|
|
1526
|
+
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
|
|
1527
|
+
layout?: unknown;
|
|
1528
|
+
proxy?: string | undefined;
|
|
1529
|
+
isEditable?: unknown;
|
|
1530
|
+
hideModels?: unknown;
|
|
1531
|
+
hideDownloadButton?: unknown;
|
|
1532
|
+
hideTestRequestButton?: unknown;
|
|
1533
|
+
hideSearch?: unknown;
|
|
1534
|
+
darkMode?: boolean | undefined;
|
|
1535
|
+
forceDarkModeState?: "dark" | "light" | undefined;
|
|
1536
|
+
hideDarkModeToggle?: unknown;
|
|
1537
|
+
metaData?: any;
|
|
1538
|
+
favicon?: string | undefined;
|
|
1539
|
+
hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
|
|
1540
|
+
defaultHttpClient?: {
|
|
1541
|
+
targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
|
|
1542
|
+
clientKey: string;
|
|
1543
|
+
} | undefined;
|
|
1544
|
+
customCss?: string | undefined;
|
|
1545
|
+
onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
|
|
1546
|
+
onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
|
|
1547
|
+
pathRouting?: {
|
|
1548
|
+
basePath: string;
|
|
1549
|
+
} | undefined;
|
|
1550
|
+
generateHeadingSlug?: ((args_0: {
|
|
1551
|
+
slug: string;
|
|
1552
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1553
|
+
generateModelSlug?: ((args_0: {
|
|
1554
|
+
name: string;
|
|
1555
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1556
|
+
generateTagSlug?: ((args_0: {
|
|
1557
|
+
name: string;
|
|
1558
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1559
|
+
generateOperationSlug?: ((args_0: {
|
|
1560
|
+
path: string;
|
|
1561
|
+
method: string;
|
|
1562
|
+
operationId?: string | undefined;
|
|
1563
|
+
summary?: string | undefined;
|
|
1564
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1565
|
+
generateWebhookSlug?: ((args_0: {
|
|
1566
|
+
name: string;
|
|
1567
|
+
method?: string | undefined;
|
|
1568
|
+
}, ...args: unknown[]) => string) | undefined;
|
|
1569
|
+
onLoaded?: ((...args: unknown[]) => void) | undefined;
|
|
1570
|
+
redirect?: ((args_0: string, ...args: unknown[]) => string | null | undefined) | undefined;
|
|
1571
|
+
withDefaultFonts?: unknown;
|
|
1572
|
+
defaultOpenAllTags?: boolean | undefined;
|
|
1573
|
+
tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
1574
|
+
operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
1575
|
+
}>;
|
|
1576
|
+
export type ApiReferenceConfigurationWithSources = Omit<z.infer<typeof apiReferenceConfigurationWithSourcesSchema>, 'proxy' | 'spec'>;
|
|
1577
|
+
/** Configuration for multiple Api References */
|
|
1578
|
+
export type MultiReferenceConfiguration = Partial<ApiReferenceConfiguration> | Partial<ApiReferenceConfiguration>[] | Partial<ApiReferenceConfigurationWithSources>;
|
|
1579
|
+
/** Typeguard to check to narrow the configs to the one with sources */
|
|
1580
|
+
export declare const isConfigurationWithSources: (config: MultiReferenceConfiguration) => config is Partial<ApiReferenceConfigurationWithSources>;
|
|
578
1581
|
//# sourceMappingURL=api-reference-configuration.d.ts.map
|