@scalar/types 0.2.5 → 0.2.8
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 +20 -0
- package/dist/api-client/api-client-plugin.d.ts +96 -47
- package/dist/api-client/api-client-plugin.d.ts.map +1 -1
- package/dist/api-client/api-client-plugin.js +8 -7
- package/dist/api-client/api-client-plugin.js.map +2 -2
- package/dist/api-client/index.d.ts +1 -1
- package/dist/api-client/index.d.ts.map +1 -1
- package/dist/api-client/index.js +3 -2
- package/dist/api-client/index.js.map +2 -2
- package/dist/api-reference/api-reference-configuration.d.ts +263 -183
- package/dist/api-reference/api-reference-configuration.d.ts.map +1 -1
- package/dist/api-reference/api-reference-configuration.js +2 -0
- package/dist/api-reference/api-reference-configuration.js.map +2 -2
- package/dist/api-reference/html-rendering-configuration.d.ts +2 -2
- package/dist/api-reference/html-rendering-configuration.d.ts.map +1 -1
- package/dist/api-reference/html-rendering-configuration.js.map +2 -2
- package/dist/entities/security-scheme.d.ts +104 -0
- package/dist/entities/security-scheme.d.ts.map +1 -1
- package/dist/entities/security-scheme.js +3 -1
- package/dist/entities/security-scheme.js.map +2 -2
- package/dist/legacy/reference-config.d.ts +3 -3
- package/dist/legacy/reference-config.js.map +1 -1
- package/dist/snippetz/snippetz.d.ts +1 -1
- package/dist/snippetz/snippetz.d.ts.map +1 -1
- package/dist/snippetz/snippetz.js +3 -2
- package/dist/snippetz/snippetz.js.map +2 -2
- package/dist/snippetz/snippetz.test-d.js +3 -3
- package/dist/snippetz/snippetz.test-d.js.map +2 -2
- package/package.json +3 -3
|
@@ -213,8 +213,8 @@ export declare const apiClientConfigurationSchema: z.ZodObject<{
|
|
|
213
213
|
/** Plugins for the API client */
|
|
214
214
|
plugins: z.ZodOptional<z.ZodArray<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodObject<{
|
|
215
215
|
name: z.ZodString;
|
|
216
|
-
views: z.ZodObject<{
|
|
217
|
-
'request.section': z.ZodArray<z.ZodObject<{
|
|
216
|
+
views: z.ZodOptional<z.ZodObject<{
|
|
217
|
+
'request.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
218
218
|
title: z.ZodOptional<z.ZodString>;
|
|
219
219
|
component: z.ZodUnknown;
|
|
220
220
|
props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
@@ -226,8 +226,8 @@ export declare const apiClientConfigurationSchema: z.ZodObject<{
|
|
|
226
226
|
title?: string | undefined;
|
|
227
227
|
component?: unknown;
|
|
228
228
|
props?: Record<string, any> | undefined;
|
|
229
|
-
}>, "many"
|
|
230
|
-
'response.section': z.ZodArray<z.ZodObject<{
|
|
229
|
+
}>, "many">>;
|
|
230
|
+
'response.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
231
231
|
title: z.ZodOptional<z.ZodString>;
|
|
232
232
|
component: z.ZodUnknown;
|
|
233
233
|
props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
@@ -239,33 +239,39 @@ export declare const apiClientConfigurationSchema: z.ZodObject<{
|
|
|
239
239
|
title?: string | undefined;
|
|
240
240
|
component?: unknown;
|
|
241
241
|
props?: Record<string, any> | undefined;
|
|
242
|
-
}>, "many"
|
|
242
|
+
}>, "many">>;
|
|
243
243
|
}, "strip", z.ZodTypeAny, {
|
|
244
|
-
'request.section'
|
|
244
|
+
'request.section'?: {
|
|
245
245
|
title?: string | undefined;
|
|
246
246
|
component?: unknown;
|
|
247
247
|
props?: Record<string, any> | undefined;
|
|
248
|
-
}[];
|
|
249
|
-
'response.section'
|
|
248
|
+
}[] | undefined;
|
|
249
|
+
'response.section'?: {
|
|
250
250
|
title?: string | undefined;
|
|
251
251
|
component?: unknown;
|
|
252
252
|
props?: Record<string, any> | undefined;
|
|
253
|
-
}[];
|
|
253
|
+
}[] | undefined;
|
|
254
254
|
}, {
|
|
255
|
-
'request.section'
|
|
255
|
+
'request.section'?: {
|
|
256
256
|
title?: string | undefined;
|
|
257
257
|
component?: unknown;
|
|
258
258
|
props?: Record<string, any> | undefined;
|
|
259
|
-
}[];
|
|
260
|
-
'response.section'
|
|
259
|
+
}[] | undefined;
|
|
260
|
+
'response.section'?: {
|
|
261
261
|
title?: string | undefined;
|
|
262
262
|
component?: unknown;
|
|
263
263
|
props?: Record<string, any> | undefined;
|
|
264
|
-
}[];
|
|
265
|
-
}
|
|
266
|
-
hooks: z.ZodObject<{
|
|
267
|
-
onBeforeRequest: z.
|
|
268
|
-
|
|
264
|
+
}[] | undefined;
|
|
265
|
+
}>>;
|
|
266
|
+
hooks: z.ZodOptional<z.ZodObject<{
|
|
267
|
+
onBeforeRequest: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
|
|
268
|
+
request: z.ZodType<Request, z.ZodTypeDef, Request>;
|
|
269
|
+
}, "strip", z.ZodTypeAny, {
|
|
270
|
+
request: Request;
|
|
271
|
+
}, {
|
|
272
|
+
request: Request;
|
|
273
|
+
}>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
|
|
274
|
+
onResponseReceived: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
|
|
269
275
|
response: z.ZodType<Response, z.ZodTypeDef, Response>;
|
|
270
276
|
operation: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
271
277
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -274,62 +280,70 @@ export declare const apiClientConfigurationSchema: z.ZodObject<{
|
|
|
274
280
|
}, {
|
|
275
281
|
response: Response;
|
|
276
282
|
operation: Record<string, any>;
|
|
277
|
-
}>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]
|
|
283
|
+
}>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
|
|
278
284
|
}, "strip", z.ZodTypeAny, {
|
|
279
|
-
onBeforeRequest
|
|
280
|
-
|
|
285
|
+
onBeforeRequest?: ((args_0: {
|
|
286
|
+
request: Request;
|
|
287
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
288
|
+
onResponseReceived?: ((args_0: {
|
|
281
289
|
response: Response;
|
|
282
290
|
operation: Record<string, any>;
|
|
283
|
-
}, ...args: unknown[]) => void | Promise<void
|
|
291
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
284
292
|
}, {
|
|
285
|
-
onBeforeRequest
|
|
286
|
-
|
|
293
|
+
onBeforeRequest?: ((args_0: {
|
|
294
|
+
request: Request;
|
|
295
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
296
|
+
onResponseReceived?: ((args_0: {
|
|
287
297
|
response: Response;
|
|
288
298
|
operation: Record<string, any>;
|
|
289
|
-
}, ...args: unknown[]) => void | Promise<void
|
|
290
|
-
}
|
|
299
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
300
|
+
}>>;
|
|
291
301
|
}, "strip", z.ZodTypeAny, {
|
|
292
302
|
name: string;
|
|
293
|
-
views
|
|
294
|
-
'request.section'
|
|
303
|
+
views?: {
|
|
304
|
+
'request.section'?: {
|
|
295
305
|
title?: string | undefined;
|
|
296
306
|
component?: unknown;
|
|
297
307
|
props?: Record<string, any> | undefined;
|
|
298
|
-
}[];
|
|
299
|
-
'response.section'
|
|
308
|
+
}[] | undefined;
|
|
309
|
+
'response.section'?: {
|
|
300
310
|
title?: string | undefined;
|
|
301
311
|
component?: unknown;
|
|
302
312
|
props?: Record<string, any> | undefined;
|
|
303
|
-
}[];
|
|
304
|
-
};
|
|
305
|
-
hooks
|
|
306
|
-
onBeforeRequest
|
|
307
|
-
|
|
313
|
+
}[] | undefined;
|
|
314
|
+
} | undefined;
|
|
315
|
+
hooks?: {
|
|
316
|
+
onBeforeRequest?: ((args_0: {
|
|
317
|
+
request: Request;
|
|
318
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
319
|
+
onResponseReceived?: ((args_0: {
|
|
308
320
|
response: Response;
|
|
309
321
|
operation: Record<string, any>;
|
|
310
|
-
}, ...args: unknown[]) => void | Promise<void
|
|
311
|
-
};
|
|
322
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
323
|
+
} | undefined;
|
|
312
324
|
}, {
|
|
313
325
|
name: string;
|
|
314
|
-
views
|
|
315
|
-
'request.section'
|
|
326
|
+
views?: {
|
|
327
|
+
'request.section'?: {
|
|
316
328
|
title?: string | undefined;
|
|
317
329
|
component?: unknown;
|
|
318
330
|
props?: Record<string, any> | undefined;
|
|
319
|
-
}[];
|
|
320
|
-
'response.section'
|
|
331
|
+
}[] | undefined;
|
|
332
|
+
'response.section'?: {
|
|
321
333
|
title?: string | undefined;
|
|
322
334
|
component?: unknown;
|
|
323
335
|
props?: Record<string, any> | undefined;
|
|
324
|
-
}[];
|
|
325
|
-
};
|
|
326
|
-
hooks
|
|
327
|
-
onBeforeRequest
|
|
328
|
-
|
|
336
|
+
}[] | undefined;
|
|
337
|
+
} | undefined;
|
|
338
|
+
hooks?: {
|
|
339
|
+
onBeforeRequest?: ((args_0: {
|
|
340
|
+
request: Request;
|
|
341
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
342
|
+
onResponseReceived?: ((args_0: {
|
|
329
343
|
response: Response;
|
|
330
344
|
operation: Record<string, any>;
|
|
331
|
-
}, ...args: unknown[]) => void | Promise<void
|
|
332
|
-
};
|
|
345
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
346
|
+
} | undefined;
|
|
333
347
|
}>>, "many">>;
|
|
334
348
|
}, "strip", z.ZodTypeAny, {
|
|
335
349
|
hideClientButton: boolean;
|
|
@@ -351,29 +365,31 @@ export declare const apiClientConfigurationSchema: z.ZodObject<{
|
|
|
351
365
|
proxyUrl?: string | undefined;
|
|
352
366
|
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;
|
|
353
367
|
servers?: any[] | undefined;
|
|
354
|
-
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "
|
|
368
|
+
_integration?: "go" | "rust" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "svelte" | "vue" | null | undefined;
|
|
355
369
|
onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
|
|
356
370
|
plugins?: ((...args: unknown[]) => {
|
|
357
371
|
name: string;
|
|
358
|
-
views
|
|
359
|
-
'request.section'
|
|
372
|
+
views?: {
|
|
373
|
+
'request.section'?: {
|
|
360
374
|
title?: string | undefined;
|
|
361
375
|
component?: unknown;
|
|
362
376
|
props?: Record<string, any> | undefined;
|
|
363
|
-
}[];
|
|
364
|
-
'response.section'
|
|
377
|
+
}[] | undefined;
|
|
378
|
+
'response.section'?: {
|
|
365
379
|
title?: string | undefined;
|
|
366
380
|
component?: unknown;
|
|
367
381
|
props?: Record<string, any> | undefined;
|
|
368
|
-
}[];
|
|
369
|
-
};
|
|
370
|
-
hooks
|
|
371
|
-
onBeforeRequest
|
|
372
|
-
|
|
382
|
+
}[] | undefined;
|
|
383
|
+
} | undefined;
|
|
384
|
+
hooks?: {
|
|
385
|
+
onBeforeRequest?: ((args_0: {
|
|
386
|
+
request: Request;
|
|
387
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
388
|
+
onResponseReceived?: ((args_0: {
|
|
373
389
|
response: Response;
|
|
374
390
|
operation: Record<string, any>;
|
|
375
|
-
}, ...args: unknown[]) => void | Promise<void
|
|
376
|
-
};
|
|
391
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
392
|
+
} | undefined;
|
|
377
393
|
})[] | undefined;
|
|
378
394
|
}, {
|
|
379
395
|
title?: string | undefined;
|
|
@@ -394,30 +410,32 @@ export declare const apiClientConfigurationSchema: z.ZodObject<{
|
|
|
394
410
|
servers?: any[] | undefined;
|
|
395
411
|
showSidebar?: unknown;
|
|
396
412
|
theme?: unknown;
|
|
397
|
-
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "
|
|
413
|
+
_integration?: "go" | "rust" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "svelte" | "vue" | null | undefined;
|
|
398
414
|
onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
|
|
399
415
|
persistAuth?: unknown;
|
|
400
416
|
plugins?: ((...args: unknown[]) => {
|
|
401
417
|
name: string;
|
|
402
|
-
views
|
|
403
|
-
'request.section'
|
|
418
|
+
views?: {
|
|
419
|
+
'request.section'?: {
|
|
404
420
|
title?: string | undefined;
|
|
405
421
|
component?: unknown;
|
|
406
422
|
props?: Record<string, any> | undefined;
|
|
407
|
-
}[];
|
|
408
|
-
'response.section'
|
|
423
|
+
}[] | undefined;
|
|
424
|
+
'response.section'?: {
|
|
409
425
|
title?: string | undefined;
|
|
410
426
|
component?: unknown;
|
|
411
427
|
props?: Record<string, any> | undefined;
|
|
412
|
-
}[];
|
|
413
|
-
};
|
|
414
|
-
hooks
|
|
415
|
-
onBeforeRequest
|
|
416
|
-
|
|
428
|
+
}[] | undefined;
|
|
429
|
+
} | undefined;
|
|
430
|
+
hooks?: {
|
|
431
|
+
onBeforeRequest?: ((args_0: {
|
|
432
|
+
request: Request;
|
|
433
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
434
|
+
onResponseReceived?: ((args_0: {
|
|
417
435
|
response: Response;
|
|
418
436
|
operation: Record<string, any>;
|
|
419
|
-
}, ...args: unknown[]) => void | Promise<void
|
|
420
|
-
};
|
|
437
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
438
|
+
} | undefined;
|
|
421
439
|
})[] | undefined;
|
|
422
440
|
}>;
|
|
423
441
|
export type ApiClientConfiguration = z.infer<typeof apiClientConfigurationSchema>;
|
|
@@ -559,8 +577,8 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
|
|
|
559
577
|
/** Plugins for the API client */
|
|
560
578
|
plugins: z.ZodOptional<z.ZodArray<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodObject<{
|
|
561
579
|
name: z.ZodString;
|
|
562
|
-
views: z.ZodObject<{
|
|
563
|
-
'request.section': z.ZodArray<z.ZodObject<{
|
|
580
|
+
views: z.ZodOptional<z.ZodObject<{
|
|
581
|
+
'request.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
564
582
|
title: z.ZodOptional<z.ZodString>;
|
|
565
583
|
component: z.ZodUnknown;
|
|
566
584
|
props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
@@ -572,8 +590,8 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
|
|
|
572
590
|
title?: string | undefined;
|
|
573
591
|
component?: unknown;
|
|
574
592
|
props?: Record<string, any> | undefined;
|
|
575
|
-
}>, "many"
|
|
576
|
-
'response.section': z.ZodArray<z.ZodObject<{
|
|
593
|
+
}>, "many">>;
|
|
594
|
+
'response.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
577
595
|
title: z.ZodOptional<z.ZodString>;
|
|
578
596
|
component: z.ZodUnknown;
|
|
579
597
|
props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
@@ -585,33 +603,39 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
|
|
|
585
603
|
title?: string | undefined;
|
|
586
604
|
component?: unknown;
|
|
587
605
|
props?: Record<string, any> | undefined;
|
|
588
|
-
}>, "many"
|
|
606
|
+
}>, "many">>;
|
|
589
607
|
}, "strip", z.ZodTypeAny, {
|
|
590
|
-
'request.section'
|
|
608
|
+
'request.section'?: {
|
|
591
609
|
title?: string | undefined;
|
|
592
610
|
component?: unknown;
|
|
593
611
|
props?: Record<string, any> | undefined;
|
|
594
|
-
}[];
|
|
595
|
-
'response.section'
|
|
612
|
+
}[] | undefined;
|
|
613
|
+
'response.section'?: {
|
|
596
614
|
title?: string | undefined;
|
|
597
615
|
component?: unknown;
|
|
598
616
|
props?: Record<string, any> | undefined;
|
|
599
|
-
}[];
|
|
617
|
+
}[] | undefined;
|
|
600
618
|
}, {
|
|
601
|
-
'request.section'
|
|
619
|
+
'request.section'?: {
|
|
602
620
|
title?: string | undefined;
|
|
603
621
|
component?: unknown;
|
|
604
622
|
props?: Record<string, any> | undefined;
|
|
605
|
-
}[];
|
|
606
|
-
'response.section'
|
|
623
|
+
}[] | undefined;
|
|
624
|
+
'response.section'?: {
|
|
607
625
|
title?: string | undefined;
|
|
608
626
|
component?: unknown;
|
|
609
627
|
props?: Record<string, any> | undefined;
|
|
610
|
-
}[];
|
|
611
|
-
}
|
|
612
|
-
hooks: z.ZodObject<{
|
|
613
|
-
onBeforeRequest: z.
|
|
614
|
-
|
|
628
|
+
}[] | undefined;
|
|
629
|
+
}>>;
|
|
630
|
+
hooks: z.ZodOptional<z.ZodObject<{
|
|
631
|
+
onBeforeRequest: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
|
|
632
|
+
request: z.ZodType<Request, z.ZodTypeDef, Request>;
|
|
633
|
+
}, "strip", z.ZodTypeAny, {
|
|
634
|
+
request: Request;
|
|
635
|
+
}, {
|
|
636
|
+
request: Request;
|
|
637
|
+
}>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
|
|
638
|
+
onResponseReceived: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
|
|
615
639
|
response: z.ZodType<Response, z.ZodTypeDef, Response>;
|
|
616
640
|
operation: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
617
641
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -620,62 +644,70 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
|
|
|
620
644
|
}, {
|
|
621
645
|
response: Response;
|
|
622
646
|
operation: Record<string, any>;
|
|
623
|
-
}>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]
|
|
647
|
+
}>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
|
|
624
648
|
}, "strip", z.ZodTypeAny, {
|
|
625
|
-
onBeforeRequest
|
|
626
|
-
|
|
649
|
+
onBeforeRequest?: ((args_0: {
|
|
650
|
+
request: Request;
|
|
651
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
652
|
+
onResponseReceived?: ((args_0: {
|
|
627
653
|
response: Response;
|
|
628
654
|
operation: Record<string, any>;
|
|
629
|
-
}, ...args: unknown[]) => void | Promise<void
|
|
655
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
630
656
|
}, {
|
|
631
|
-
onBeforeRequest
|
|
632
|
-
|
|
657
|
+
onBeforeRequest?: ((args_0: {
|
|
658
|
+
request: Request;
|
|
659
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
660
|
+
onResponseReceived?: ((args_0: {
|
|
633
661
|
response: Response;
|
|
634
662
|
operation: Record<string, any>;
|
|
635
|
-
}, ...args: unknown[]) => void | Promise<void
|
|
636
|
-
}
|
|
663
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
664
|
+
}>>;
|
|
637
665
|
}, "strip", z.ZodTypeAny, {
|
|
638
666
|
name: string;
|
|
639
|
-
views
|
|
640
|
-
'request.section'
|
|
667
|
+
views?: {
|
|
668
|
+
'request.section'?: {
|
|
641
669
|
title?: string | undefined;
|
|
642
670
|
component?: unknown;
|
|
643
671
|
props?: Record<string, any> | undefined;
|
|
644
|
-
}[];
|
|
645
|
-
'response.section'
|
|
672
|
+
}[] | undefined;
|
|
673
|
+
'response.section'?: {
|
|
646
674
|
title?: string | undefined;
|
|
647
675
|
component?: unknown;
|
|
648
676
|
props?: Record<string, any> | undefined;
|
|
649
|
-
}[];
|
|
650
|
-
};
|
|
651
|
-
hooks
|
|
652
|
-
onBeforeRequest
|
|
653
|
-
|
|
677
|
+
}[] | undefined;
|
|
678
|
+
} | undefined;
|
|
679
|
+
hooks?: {
|
|
680
|
+
onBeforeRequest?: ((args_0: {
|
|
681
|
+
request: Request;
|
|
682
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
683
|
+
onResponseReceived?: ((args_0: {
|
|
654
684
|
response: Response;
|
|
655
685
|
operation: Record<string, any>;
|
|
656
|
-
}, ...args: unknown[]) => void | Promise<void
|
|
657
|
-
};
|
|
686
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
687
|
+
} | undefined;
|
|
658
688
|
}, {
|
|
659
689
|
name: string;
|
|
660
|
-
views
|
|
661
|
-
'request.section'
|
|
690
|
+
views?: {
|
|
691
|
+
'request.section'?: {
|
|
662
692
|
title?: string | undefined;
|
|
663
693
|
component?: unknown;
|
|
664
694
|
props?: Record<string, any> | undefined;
|
|
665
|
-
}[];
|
|
666
|
-
'response.section'
|
|
695
|
+
}[] | undefined;
|
|
696
|
+
'response.section'?: {
|
|
667
697
|
title?: string | undefined;
|
|
668
698
|
component?: unknown;
|
|
669
699
|
props?: Record<string, any> | undefined;
|
|
670
|
-
}[];
|
|
671
|
-
};
|
|
672
|
-
hooks
|
|
673
|
-
onBeforeRequest
|
|
674
|
-
|
|
700
|
+
}[] | undefined;
|
|
701
|
+
} | undefined;
|
|
702
|
+
hooks?: {
|
|
703
|
+
onBeforeRequest?: ((args_0: {
|
|
704
|
+
request: Request;
|
|
705
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
706
|
+
onResponseReceived?: ((args_0: {
|
|
675
707
|
response: Response;
|
|
676
708
|
operation: Record<string, any>;
|
|
677
|
-
}, ...args: unknown[]) => void | Promise<void
|
|
678
|
-
};
|
|
709
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
710
|
+
} | undefined;
|
|
679
711
|
}>>, "many">>;
|
|
680
712
|
}, {
|
|
681
713
|
/**
|
|
@@ -784,13 +816,13 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
|
|
|
784
816
|
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>]>>;
|
|
785
817
|
/** Determine the HTTP client that's selected by default */
|
|
786
818
|
defaultHttpClient: z.ZodOptional<z.ZodObject<{
|
|
787
|
-
targetKey: z.ZodType<"c" | "clojure" | "csharp" | "
|
|
819
|
+
targetKey: z.ZodType<"c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift", z.ZodTypeDef, "c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift">;
|
|
788
820
|
clientKey: z.ZodString;
|
|
789
821
|
}, "strip", z.ZodTypeAny, {
|
|
790
|
-
targetKey: "c" | "clojure" | "csharp" | "
|
|
822
|
+
targetKey: "c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift";
|
|
791
823
|
clientKey: string;
|
|
792
824
|
}, {
|
|
793
|
-
targetKey: "c" | "clojure" | "csharp" | "
|
|
825
|
+
targetKey: "c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift";
|
|
794
826
|
clientKey: string;
|
|
795
827
|
}>>;
|
|
796
828
|
/** Custom CSS to be added to the page */
|
|
@@ -803,6 +835,14 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
|
|
|
803
835
|
onDocumentSelect: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
|
|
804
836
|
/** Callback fired when the reference is fully loaded */
|
|
805
837
|
onLoaded: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
|
|
838
|
+
/** onBeforeRequest is fired before the request is sent. You can modify the request here. */
|
|
839
|
+
onBeforeRequest: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
|
|
840
|
+
request: z.ZodType<Request, z.ZodTypeDef, Request>;
|
|
841
|
+
}, "strip", z.ZodTypeAny, {
|
|
842
|
+
request: Request;
|
|
843
|
+
}, {
|
|
844
|
+
request: Request;
|
|
845
|
+
}>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
|
|
806
846
|
/**
|
|
807
847
|
* onShowMore is fired when the user clicks the "Show more" button on the references
|
|
808
848
|
* @param tagId - The ID of the tag that was clicked
|
|
@@ -957,6 +997,9 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
|
|
|
957
997
|
hideDarkModeToggle: boolean;
|
|
958
998
|
withDefaultFonts: boolean;
|
|
959
999
|
title?: string | undefined;
|
|
1000
|
+
onBeforeRequest?: ((args_0: {
|
|
1001
|
+
request: Request;
|
|
1002
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
960
1003
|
url?: string | undefined;
|
|
961
1004
|
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
962
1005
|
slug?: string | undefined;
|
|
@@ -971,7 +1014,7 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
|
|
|
971
1014
|
proxyUrl?: string | undefined;
|
|
972
1015
|
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;
|
|
973
1016
|
servers?: any[] | undefined;
|
|
974
|
-
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "
|
|
1017
|
+
_integration?: "go" | "rust" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "svelte" | "vue" | null | undefined;
|
|
975
1018
|
onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
|
|
976
1019
|
plugins?: ((...args: unknown[]) => {
|
|
977
1020
|
name: string;
|
|
@@ -989,7 +1032,7 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
|
|
|
989
1032
|
favicon?: string | undefined;
|
|
990
1033
|
hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
|
|
991
1034
|
defaultHttpClient?: {
|
|
992
|
-
targetKey: "c" | "clojure" | "csharp" | "
|
|
1035
|
+
targetKey: "c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift";
|
|
993
1036
|
clientKey: string;
|
|
994
1037
|
} | undefined;
|
|
995
1038
|
customCss?: string | undefined;
|
|
@@ -1027,6 +1070,9 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
|
|
|
1027
1070
|
operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
1028
1071
|
}, {
|
|
1029
1072
|
title?: string | undefined;
|
|
1073
|
+
onBeforeRequest?: ((args_0: {
|
|
1074
|
+
request: Request;
|
|
1075
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
1030
1076
|
url?: string | undefined;
|
|
1031
1077
|
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1032
1078
|
slug?: string | undefined;
|
|
@@ -1044,7 +1090,7 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
|
|
|
1044
1090
|
servers?: any[] | undefined;
|
|
1045
1091
|
showSidebar?: unknown;
|
|
1046
1092
|
theme?: unknown;
|
|
1047
|
-
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "
|
|
1093
|
+
_integration?: "go" | "rust" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "svelte" | "vue" | null | undefined;
|
|
1048
1094
|
onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
|
|
1049
1095
|
persistAuth?: unknown;
|
|
1050
1096
|
plugins?: ((...args: unknown[]) => {
|
|
@@ -1071,7 +1117,7 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
|
|
|
1071
1117
|
favicon?: string | undefined;
|
|
1072
1118
|
hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
|
|
1073
1119
|
defaultHttpClient?: {
|
|
1074
|
-
targetKey: "c" | "clojure" | "csharp" | "
|
|
1120
|
+
targetKey: "c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift";
|
|
1075
1121
|
clientKey: string;
|
|
1076
1122
|
} | undefined;
|
|
1077
1123
|
customCss?: string | undefined;
|
|
@@ -1247,8 +1293,8 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1247
1293
|
/** Plugins for the API client */
|
|
1248
1294
|
plugins: z.ZodOptional<z.ZodArray<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodObject<{
|
|
1249
1295
|
name: z.ZodString;
|
|
1250
|
-
views: z.ZodObject<{
|
|
1251
|
-
'request.section': z.ZodArray<z.ZodObject<{
|
|
1296
|
+
views: z.ZodOptional<z.ZodObject<{
|
|
1297
|
+
'request.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1252
1298
|
title: z.ZodOptional<z.ZodString>;
|
|
1253
1299
|
component: z.ZodUnknown;
|
|
1254
1300
|
props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
@@ -1260,8 +1306,8 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1260
1306
|
title?: string | undefined;
|
|
1261
1307
|
component?: unknown;
|
|
1262
1308
|
props?: Record<string, any> | undefined;
|
|
1263
|
-
}>, "many"
|
|
1264
|
-
'response.section': z.ZodArray<z.ZodObject<{
|
|
1309
|
+
}>, "many">>;
|
|
1310
|
+
'response.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1265
1311
|
title: z.ZodOptional<z.ZodString>;
|
|
1266
1312
|
component: z.ZodUnknown;
|
|
1267
1313
|
props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
@@ -1273,33 +1319,39 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1273
1319
|
title?: string | undefined;
|
|
1274
1320
|
component?: unknown;
|
|
1275
1321
|
props?: Record<string, any> | undefined;
|
|
1276
|
-
}>, "many"
|
|
1322
|
+
}>, "many">>;
|
|
1277
1323
|
}, "strip", z.ZodTypeAny, {
|
|
1278
|
-
'request.section'
|
|
1324
|
+
'request.section'?: {
|
|
1279
1325
|
title?: string | undefined;
|
|
1280
1326
|
component?: unknown;
|
|
1281
1327
|
props?: Record<string, any> | undefined;
|
|
1282
|
-
}[];
|
|
1283
|
-
'response.section'
|
|
1328
|
+
}[] | undefined;
|
|
1329
|
+
'response.section'?: {
|
|
1284
1330
|
title?: string | undefined;
|
|
1285
1331
|
component?: unknown;
|
|
1286
1332
|
props?: Record<string, any> | undefined;
|
|
1287
|
-
}[];
|
|
1333
|
+
}[] | undefined;
|
|
1288
1334
|
}, {
|
|
1289
|
-
'request.section'
|
|
1335
|
+
'request.section'?: {
|
|
1290
1336
|
title?: string | undefined;
|
|
1291
1337
|
component?: unknown;
|
|
1292
1338
|
props?: Record<string, any> | undefined;
|
|
1293
|
-
}[];
|
|
1294
|
-
'response.section'
|
|
1339
|
+
}[] | undefined;
|
|
1340
|
+
'response.section'?: {
|
|
1295
1341
|
title?: string | undefined;
|
|
1296
1342
|
component?: unknown;
|
|
1297
1343
|
props?: Record<string, any> | undefined;
|
|
1298
|
-
}[];
|
|
1299
|
-
}
|
|
1300
|
-
hooks: z.ZodObject<{
|
|
1301
|
-
onBeforeRequest: z.
|
|
1302
|
-
|
|
1344
|
+
}[] | undefined;
|
|
1345
|
+
}>>;
|
|
1346
|
+
hooks: z.ZodOptional<z.ZodObject<{
|
|
1347
|
+
onBeforeRequest: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
|
|
1348
|
+
request: z.ZodType<Request, z.ZodTypeDef, Request>;
|
|
1349
|
+
}, "strip", z.ZodTypeAny, {
|
|
1350
|
+
request: Request;
|
|
1351
|
+
}, {
|
|
1352
|
+
request: Request;
|
|
1353
|
+
}>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
|
|
1354
|
+
onResponseReceived: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
|
|
1303
1355
|
response: z.ZodType<Response, z.ZodTypeDef, Response>;
|
|
1304
1356
|
operation: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
1305
1357
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -1308,62 +1360,70 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1308
1360
|
}, {
|
|
1309
1361
|
response: Response;
|
|
1310
1362
|
operation: Record<string, any>;
|
|
1311
|
-
}>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]
|
|
1363
|
+
}>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
|
|
1312
1364
|
}, "strip", z.ZodTypeAny, {
|
|
1313
|
-
onBeforeRequest
|
|
1314
|
-
|
|
1365
|
+
onBeforeRequest?: ((args_0: {
|
|
1366
|
+
request: Request;
|
|
1367
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
1368
|
+
onResponseReceived?: ((args_0: {
|
|
1315
1369
|
response: Response;
|
|
1316
1370
|
operation: Record<string, any>;
|
|
1317
|
-
}, ...args: unknown[]) => void | Promise<void
|
|
1371
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
1318
1372
|
}, {
|
|
1319
|
-
onBeforeRequest
|
|
1320
|
-
|
|
1373
|
+
onBeforeRequest?: ((args_0: {
|
|
1374
|
+
request: Request;
|
|
1375
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
1376
|
+
onResponseReceived?: ((args_0: {
|
|
1321
1377
|
response: Response;
|
|
1322
1378
|
operation: Record<string, any>;
|
|
1323
|
-
}, ...args: unknown[]) => void | Promise<void
|
|
1324
|
-
}
|
|
1379
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
1380
|
+
}>>;
|
|
1325
1381
|
}, "strip", z.ZodTypeAny, {
|
|
1326
1382
|
name: string;
|
|
1327
|
-
views
|
|
1328
|
-
'request.section'
|
|
1383
|
+
views?: {
|
|
1384
|
+
'request.section'?: {
|
|
1329
1385
|
title?: string | undefined;
|
|
1330
1386
|
component?: unknown;
|
|
1331
1387
|
props?: Record<string, any> | undefined;
|
|
1332
|
-
}[];
|
|
1333
|
-
'response.section'
|
|
1388
|
+
}[] | undefined;
|
|
1389
|
+
'response.section'?: {
|
|
1334
1390
|
title?: string | undefined;
|
|
1335
1391
|
component?: unknown;
|
|
1336
1392
|
props?: Record<string, any> | undefined;
|
|
1337
|
-
}[];
|
|
1338
|
-
};
|
|
1339
|
-
hooks
|
|
1340
|
-
onBeforeRequest
|
|
1341
|
-
|
|
1393
|
+
}[] | undefined;
|
|
1394
|
+
} | undefined;
|
|
1395
|
+
hooks?: {
|
|
1396
|
+
onBeforeRequest?: ((args_0: {
|
|
1397
|
+
request: Request;
|
|
1398
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
1399
|
+
onResponseReceived?: ((args_0: {
|
|
1342
1400
|
response: Response;
|
|
1343
1401
|
operation: Record<string, any>;
|
|
1344
|
-
}, ...args: unknown[]) => void | Promise<void
|
|
1345
|
-
};
|
|
1402
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
1403
|
+
} | undefined;
|
|
1346
1404
|
}, {
|
|
1347
1405
|
name: string;
|
|
1348
|
-
views
|
|
1349
|
-
'request.section'
|
|
1406
|
+
views?: {
|
|
1407
|
+
'request.section'?: {
|
|
1350
1408
|
title?: string | undefined;
|
|
1351
1409
|
component?: unknown;
|
|
1352
1410
|
props?: Record<string, any> | undefined;
|
|
1353
|
-
}[];
|
|
1354
|
-
'response.section'
|
|
1411
|
+
}[] | undefined;
|
|
1412
|
+
'response.section'?: {
|
|
1355
1413
|
title?: string | undefined;
|
|
1356
1414
|
component?: unknown;
|
|
1357
1415
|
props?: Record<string, any> | undefined;
|
|
1358
|
-
}[];
|
|
1359
|
-
};
|
|
1360
|
-
hooks
|
|
1361
|
-
onBeforeRequest
|
|
1362
|
-
|
|
1416
|
+
}[] | undefined;
|
|
1417
|
+
} | undefined;
|
|
1418
|
+
hooks?: {
|
|
1419
|
+
onBeforeRequest?: ((args_0: {
|
|
1420
|
+
request: Request;
|
|
1421
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
1422
|
+
onResponseReceived?: ((args_0: {
|
|
1363
1423
|
response: Response;
|
|
1364
1424
|
operation: Record<string, any>;
|
|
1365
|
-
}, ...args: unknown[]) => void | Promise<void
|
|
1366
|
-
};
|
|
1425
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
1426
|
+
} | undefined;
|
|
1367
1427
|
}>>, "many">>;
|
|
1368
1428
|
}, {
|
|
1369
1429
|
/**
|
|
@@ -1472,13 +1532,13 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1472
1532
|
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>]>>;
|
|
1473
1533
|
/** Determine the HTTP client that's selected by default */
|
|
1474
1534
|
defaultHttpClient: z.ZodOptional<z.ZodObject<{
|
|
1475
|
-
targetKey: z.ZodType<"c" | "clojure" | "csharp" | "
|
|
1535
|
+
targetKey: z.ZodType<"c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift", z.ZodTypeDef, "c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift">;
|
|
1476
1536
|
clientKey: z.ZodString;
|
|
1477
1537
|
}, "strip", z.ZodTypeAny, {
|
|
1478
|
-
targetKey: "c" | "clojure" | "csharp" | "
|
|
1538
|
+
targetKey: "c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift";
|
|
1479
1539
|
clientKey: string;
|
|
1480
1540
|
}, {
|
|
1481
|
-
targetKey: "c" | "clojure" | "csharp" | "
|
|
1541
|
+
targetKey: "c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift";
|
|
1482
1542
|
clientKey: string;
|
|
1483
1543
|
}>>;
|
|
1484
1544
|
/** Custom CSS to be added to the page */
|
|
@@ -1491,6 +1551,14 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1491
1551
|
onDocumentSelect: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
|
|
1492
1552
|
/** Callback fired when the reference is fully loaded */
|
|
1493
1553
|
onLoaded: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
|
|
1554
|
+
/** onBeforeRequest is fired before the request is sent. You can modify the request here. */
|
|
1555
|
+
onBeforeRequest: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
|
|
1556
|
+
request: z.ZodType<Request, z.ZodTypeDef, Request>;
|
|
1557
|
+
}, "strip", z.ZodTypeAny, {
|
|
1558
|
+
request: Request;
|
|
1559
|
+
}, {
|
|
1560
|
+
request: Request;
|
|
1561
|
+
}>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
|
|
1494
1562
|
/**
|
|
1495
1563
|
* onShowMore is fired when the user clicks the "Show more" button on the references
|
|
1496
1564
|
* @param tagId - The ID of the tag that was clicked
|
|
@@ -1645,6 +1713,9 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1645
1713
|
hideDarkModeToggle: boolean;
|
|
1646
1714
|
withDefaultFonts: boolean;
|
|
1647
1715
|
title?: string | undefined;
|
|
1716
|
+
onBeforeRequest?: ((args_0: {
|
|
1717
|
+
request: Request;
|
|
1718
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
1648
1719
|
url?: string | undefined;
|
|
1649
1720
|
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1650
1721
|
slug?: string | undefined;
|
|
@@ -1659,7 +1730,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1659
1730
|
proxyUrl?: string | undefined;
|
|
1660
1731
|
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;
|
|
1661
1732
|
servers?: any[] | undefined;
|
|
1662
|
-
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "
|
|
1733
|
+
_integration?: "go" | "rust" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "svelte" | "vue" | null | undefined;
|
|
1663
1734
|
onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
|
|
1664
1735
|
plugins?: ((...args: unknown[]) => {
|
|
1665
1736
|
name: string;
|
|
@@ -1677,7 +1748,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1677
1748
|
favicon?: string | undefined;
|
|
1678
1749
|
hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
|
|
1679
1750
|
defaultHttpClient?: {
|
|
1680
|
-
targetKey: "c" | "clojure" | "csharp" | "
|
|
1751
|
+
targetKey: "c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift";
|
|
1681
1752
|
clientKey: string;
|
|
1682
1753
|
} | undefined;
|
|
1683
1754
|
customCss?: string | undefined;
|
|
@@ -1715,6 +1786,9 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1715
1786
|
operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
1716
1787
|
}, {
|
|
1717
1788
|
title?: string | undefined;
|
|
1789
|
+
onBeforeRequest?: ((args_0: {
|
|
1790
|
+
request: Request;
|
|
1791
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
1718
1792
|
url?: string | undefined;
|
|
1719
1793
|
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1720
1794
|
slug?: string | undefined;
|
|
@@ -1732,7 +1806,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1732
1806
|
servers?: any[] | undefined;
|
|
1733
1807
|
showSidebar?: unknown;
|
|
1734
1808
|
theme?: unknown;
|
|
1735
|
-
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "
|
|
1809
|
+
_integration?: "go" | "rust" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "svelte" | "vue" | null | undefined;
|
|
1736
1810
|
onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
|
|
1737
1811
|
persistAuth?: unknown;
|
|
1738
1812
|
plugins?: ((...args: unknown[]) => {
|
|
@@ -1759,7 +1833,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1759
1833
|
favicon?: string | undefined;
|
|
1760
1834
|
hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
|
|
1761
1835
|
defaultHttpClient?: {
|
|
1762
|
-
targetKey: "c" | "clojure" | "csharp" | "
|
|
1836
|
+
targetKey: "c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift";
|
|
1763
1837
|
clientKey: string;
|
|
1764
1838
|
} | undefined;
|
|
1765
1839
|
customCss?: string | undefined;
|
|
@@ -1811,6 +1885,9 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1811
1885
|
hideDarkModeToggle: boolean;
|
|
1812
1886
|
withDefaultFonts: boolean;
|
|
1813
1887
|
title?: string | undefined;
|
|
1888
|
+
onBeforeRequest?: ((args_0: {
|
|
1889
|
+
request: Request;
|
|
1890
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
1814
1891
|
url?: string | undefined;
|
|
1815
1892
|
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1816
1893
|
slug?: string | undefined;
|
|
@@ -1825,7 +1902,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1825
1902
|
proxyUrl?: string | undefined;
|
|
1826
1903
|
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;
|
|
1827
1904
|
servers?: any[] | undefined;
|
|
1828
|
-
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "
|
|
1905
|
+
_integration?: "go" | "rust" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "svelte" | "vue" | null | undefined;
|
|
1829
1906
|
onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
|
|
1830
1907
|
plugins?: ((...args: unknown[]) => {
|
|
1831
1908
|
name: string;
|
|
@@ -1843,7 +1920,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1843
1920
|
favicon?: string | undefined;
|
|
1844
1921
|
hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
|
|
1845
1922
|
defaultHttpClient?: {
|
|
1846
|
-
targetKey: "c" | "clojure" | "csharp" | "
|
|
1923
|
+
targetKey: "c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift";
|
|
1847
1924
|
clientKey: string;
|
|
1848
1925
|
} | undefined;
|
|
1849
1926
|
customCss?: string | undefined;
|
|
@@ -1881,6 +1958,9 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1881
1958
|
operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
|
|
1882
1959
|
}, {
|
|
1883
1960
|
title?: string | undefined;
|
|
1961
|
+
onBeforeRequest?: ((args_0: {
|
|
1962
|
+
request: Request;
|
|
1963
|
+
}, ...args: unknown[]) => void | Promise<void>) | undefined;
|
|
1884
1964
|
url?: string | undefined;
|
|
1885
1965
|
content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
|
|
1886
1966
|
slug?: string | undefined;
|
|
@@ -1898,7 +1978,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1898
1978
|
servers?: any[] | undefined;
|
|
1899
1979
|
showSidebar?: unknown;
|
|
1900
1980
|
theme?: unknown;
|
|
1901
|
-
_integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "
|
|
1981
|
+
_integration?: "go" | "rust" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "svelte" | "vue" | null | undefined;
|
|
1902
1982
|
onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
|
|
1903
1983
|
persistAuth?: unknown;
|
|
1904
1984
|
plugins?: ((...args: unknown[]) => {
|
|
@@ -1925,7 +2005,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
|
|
|
1925
2005
|
favicon?: string | undefined;
|
|
1926
2006
|
hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
|
|
1927
2007
|
defaultHttpClient?: {
|
|
1928
|
-
targetKey: "c" | "clojure" | "csharp" | "
|
|
2008
|
+
targetKey: "c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift";
|
|
1929
2009
|
clientKey: string;
|
|
1930
2010
|
} | undefined;
|
|
1931
2011
|
customCss?: string | undefined;
|