@scalar/oas-utils 0.2.9 → 0.2.10

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.
Files changed (5) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/dist/entities/workspace/spec/request-examples.d.ts +138 -0
  3. package/dist/entities/workspace/spec/request-examples.d.ts.map +1 -1
  4. package/dist/entities/workspace/spec/request-examples.js +3 -0
  5. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @scalar/oas-utils
2
2
 
3
+ ## 0.2.10
4
+
5
+ ### Patch Changes
6
+
7
+ - d58841b: feat: type, format and default to request example parameters schema
8
+
3
9
  ## 0.2.9
4
10
 
5
11
  ### Patch Changes
package/dist/entities/workspace/spec/request-examples.d.ts CHANGED
@@ -9,17 +9,25 @@ declare const requestExampleParametersSchema: z.ZodObject<{
9
9
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
10
10
  required: z.ZodOptional<z.ZodBoolean>;
11
11
  enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
12
+ type: z.ZodOptional<z.ZodString>;
13
+ format: z.ZodOptional<z.ZodString>;
14
+ default: z.ZodOptional<z.ZodAny>;
12
15
  }, "strip", z.ZodTypeAny, {
13
16
  value: string;
14
17
  key: string;
15
18
  enabled: boolean;
19
+ type?: string | undefined;
20
+ default?: any;
16
21
  description?: string | undefined;
17
22
  enum?: string[] | undefined;
18
23
  required?: boolean | undefined;
19
24
  file?: File | undefined;
20
25
  refUid?: string | undefined;
26
+ format?: string | undefined;
21
27
  }, {
28
+ type?: string | undefined;
22
29
  value?: string | number | undefined;
30
+ default?: any;
23
31
  description?: string | undefined;
24
32
  key?: string | undefined;
25
33
  enum?: string[] | undefined;
@@ -27,6 +35,7 @@ declare const requestExampleParametersSchema: z.ZodObject<{
27
35
  enabled?: boolean | undefined;
28
36
  file?: File | undefined;
29
37
  refUid?: string | undefined;
38
+ format?: string | undefined;
30
39
  }>;
31
40
  /** Request examples - formerly known as instances - are "children" of requests */
32
41
  export type RequestExampleParameter = z.infer<typeof requestExampleParametersSchema>;
@@ -36,11 +45,14 @@ export declare const createRequestExampleParameter: (payload: RequestExamplePara
36
45
  value: string;
37
46
  key: string;
38
47
  enabled: boolean;
48
+ type?: string | undefined;
49
+ default?: any;
39
50
  description?: string | undefined;
40
51
  enum?: string[] | undefined;
41
52
  required?: boolean | undefined;
42
53
  file?: File | undefined;
43
54
  refUid?: string | undefined;
55
+ format?: string | undefined;
44
56
  };
45
57
  declare const requestExampleSchema: z.ZodObject<{
46
58
  uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
@@ -69,17 +81,25 @@ declare const requestExampleSchema: z.ZodObject<{
69
81
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
70
82
  required: z.ZodOptional<z.ZodBoolean>;
71
83
  enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
84
+ type: z.ZodOptional<z.ZodString>;
85
+ format: z.ZodOptional<z.ZodString>;
86
+ default: z.ZodOptional<z.ZodAny>;
72
87
  }, "strip", z.ZodTypeAny, {
73
88
  value: string;
74
89
  key: string;
75
90
  enabled: boolean;
91
+ type?: string | undefined;
92
+ default?: any;
76
93
  description?: string | undefined;
77
94
  enum?: string[] | undefined;
78
95
  required?: boolean | undefined;
79
96
  file?: File | undefined;
80
97
  refUid?: string | undefined;
98
+ format?: string | undefined;
81
99
  }, {
100
+ type?: string | undefined;
82
101
  value?: string | number | undefined;
102
+ default?: any;
83
103
  description?: string | undefined;
84
104
  key?: string | undefined;
85
105
  enum?: string[] | undefined;
@@ -87,22 +107,28 @@ declare const requestExampleSchema: z.ZodObject<{
87
107
  enabled?: boolean | undefined;
88
108
  file?: File | undefined;
89
109
  refUid?: string | undefined;
110
+ format?: string | undefined;
90
111
  }>, "many">>;
91
112
  }, "strip", z.ZodTypeAny, {
92
113
  value: {
93
114
  value: string;
94
115
  key: string;
95
116
  enabled: boolean;
117
+ type?: string | undefined;
118
+ default?: any;
96
119
  description?: string | undefined;
97
120
  enum?: string[] | undefined;
98
121
  required?: boolean | undefined;
99
122
  file?: File | undefined;
100
123
  refUid?: string | undefined;
124
+ format?: string | undefined;
101
125
  }[];
102
126
  encoding: "form-data" | "urlencoded";
103
127
  }, {
104
128
  value?: {
129
+ type?: string | undefined;
105
130
  value?: string | number | undefined;
131
+ default?: any;
106
132
  description?: string | undefined;
107
133
  key?: string | undefined;
108
134
  enum?: string[] | undefined;
@@ -110,6 +136,7 @@ declare const requestExampleSchema: z.ZodObject<{
110
136
  enabled?: boolean | undefined;
111
137
  file?: File | undefined;
112
138
  refUid?: string | undefined;
139
+ format?: string | undefined;
113
140
  }[] | undefined;
114
141
  encoding?: "form-data" | "urlencoded" | undefined;
115
142
  }>>;
@@ -125,11 +152,14 @@ declare const requestExampleSchema: z.ZodObject<{
125
152
  value: string;
126
153
  key: string;
127
154
  enabled: boolean;
155
+ type?: string | undefined;
156
+ default?: any;
128
157
  description?: string | undefined;
129
158
  enum?: string[] | undefined;
130
159
  required?: boolean | undefined;
131
160
  file?: File | undefined;
132
161
  refUid?: string | undefined;
162
+ format?: string | undefined;
133
163
  }[];
134
164
  encoding: "form-data" | "urlencoded";
135
165
  };
@@ -142,7 +172,9 @@ declare const requestExampleSchema: z.ZodObject<{
142
172
  } | undefined;
143
173
  formData?: {
144
174
  value?: {
175
+ type?: string | undefined;
145
176
  value?: string | number | undefined;
177
+ default?: any;
146
178
  description?: string | undefined;
147
179
  key?: string | undefined;
148
180
  enum?: string[] | undefined;
@@ -150,6 +182,7 @@ declare const requestExampleSchema: z.ZodObject<{
150
182
  enabled?: boolean | undefined;
151
183
  file?: File | undefined;
152
184
  refUid?: string | undefined;
185
+ format?: string | undefined;
153
186
  }[] | undefined;
154
187
  encoding?: "form-data" | "urlencoded" | undefined;
155
188
  } | undefined;
@@ -167,17 +200,25 @@ declare const requestExampleSchema: z.ZodObject<{
167
200
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
168
201
  required: z.ZodOptional<z.ZodBoolean>;
169
202
  enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
203
+ type: z.ZodOptional<z.ZodString>;
204
+ format: z.ZodOptional<z.ZodString>;
205
+ default: z.ZodOptional<z.ZodAny>;
170
206
  }, "strip", z.ZodTypeAny, {
171
207
  value: string;
172
208
  key: string;
173
209
  enabled: boolean;
210
+ type?: string | undefined;
211
+ default?: any;
174
212
  description?: string | undefined;
175
213
  enum?: string[] | undefined;
176
214
  required?: boolean | undefined;
177
215
  file?: File | undefined;
178
216
  refUid?: string | undefined;
217
+ format?: string | undefined;
179
218
  }, {
219
+ type?: string | undefined;
180
220
  value?: string | number | undefined;
221
+ default?: any;
181
222
  description?: string | undefined;
182
223
  key?: string | undefined;
183
224
  enum?: string[] | undefined;
@@ -185,6 +226,7 @@ declare const requestExampleSchema: z.ZodObject<{
185
226
  enabled?: boolean | undefined;
186
227
  file?: File | undefined;
187
228
  refUid?: string | undefined;
229
+ format?: string | undefined;
188
230
  }>, "many">>;
189
231
  query: z.ZodDefault<z.ZodArray<z.ZodObject<{
190
232
  key: z.ZodDefault<z.ZodString>;
@@ -196,17 +238,25 @@ declare const requestExampleSchema: z.ZodObject<{
196
238
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
197
239
  required: z.ZodOptional<z.ZodBoolean>;
198
240
  enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
241
+ type: z.ZodOptional<z.ZodString>;
242
+ format: z.ZodOptional<z.ZodString>;
243
+ default: z.ZodOptional<z.ZodAny>;
199
244
  }, "strip", z.ZodTypeAny, {
200
245
  value: string;
201
246
  key: string;
202
247
  enabled: boolean;
248
+ type?: string | undefined;
249
+ default?: any;
203
250
  description?: string | undefined;
204
251
  enum?: string[] | undefined;
205
252
  required?: boolean | undefined;
206
253
  file?: File | undefined;
207
254
  refUid?: string | undefined;
255
+ format?: string | undefined;
208
256
  }, {
257
+ type?: string | undefined;
209
258
  value?: string | number | undefined;
259
+ default?: any;
210
260
  description?: string | undefined;
211
261
  key?: string | undefined;
212
262
  enum?: string[] | undefined;
@@ -214,6 +264,7 @@ declare const requestExampleSchema: z.ZodObject<{
214
264
  enabled?: boolean | undefined;
215
265
  file?: File | undefined;
216
266
  refUid?: string | undefined;
267
+ format?: string | undefined;
217
268
  }>, "many">>;
218
269
  headers: z.ZodDefault<z.ZodArray<z.ZodObject<{
219
270
  key: z.ZodDefault<z.ZodString>;
@@ -225,17 +276,25 @@ declare const requestExampleSchema: z.ZodObject<{
225
276
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
226
277
  required: z.ZodOptional<z.ZodBoolean>;
227
278
  enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
279
+ type: z.ZodOptional<z.ZodString>;
280
+ format: z.ZodOptional<z.ZodString>;
281
+ default: z.ZodOptional<z.ZodAny>;
228
282
  }, "strip", z.ZodTypeAny, {
229
283
  value: string;
230
284
  key: string;
231
285
  enabled: boolean;
286
+ type?: string | undefined;
287
+ default?: any;
232
288
  description?: string | undefined;
233
289
  enum?: string[] | undefined;
234
290
  required?: boolean | undefined;
235
291
  file?: File | undefined;
236
292
  refUid?: string | undefined;
293
+ format?: string | undefined;
237
294
  }, {
295
+ type?: string | undefined;
238
296
  value?: string | number | undefined;
297
+ default?: any;
239
298
  description?: string | undefined;
240
299
  key?: string | undefined;
241
300
  enum?: string[] | undefined;
@@ -243,6 +302,7 @@ declare const requestExampleSchema: z.ZodObject<{
243
302
  enabled?: boolean | undefined;
244
303
  file?: File | undefined;
245
304
  refUid?: string | undefined;
305
+ format?: string | undefined;
246
306
  }>, "many">>;
247
307
  cookies: z.ZodDefault<z.ZodArray<z.ZodObject<{
248
308
  key: z.ZodDefault<z.ZodString>;
@@ -254,17 +314,25 @@ declare const requestExampleSchema: z.ZodObject<{
254
314
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
255
315
  required: z.ZodOptional<z.ZodBoolean>;
256
316
  enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
317
+ type: z.ZodOptional<z.ZodString>;
318
+ format: z.ZodOptional<z.ZodString>;
319
+ default: z.ZodOptional<z.ZodAny>;
257
320
  }, "strip", z.ZodTypeAny, {
258
321
  value: string;
259
322
  key: string;
260
323
  enabled: boolean;
324
+ type?: string | undefined;
325
+ default?: any;
261
326
  description?: string | undefined;
262
327
  enum?: string[] | undefined;
263
328
  required?: boolean | undefined;
264
329
  file?: File | undefined;
265
330
  refUid?: string | undefined;
331
+ format?: string | undefined;
266
332
  }, {
333
+ type?: string | undefined;
267
334
  value?: string | number | undefined;
335
+ default?: any;
268
336
  description?: string | undefined;
269
337
  key?: string | undefined;
270
338
  enum?: string[] | undefined;
@@ -272,51 +340,66 @@ declare const requestExampleSchema: z.ZodObject<{
272
340
  enabled?: boolean | undefined;
273
341
  file?: File | undefined;
274
342
  refUid?: string | undefined;
343
+ format?: string | undefined;
275
344
  }>, "many">>;
276
345
  }, "strip", z.ZodTypeAny, {
277
346
  path: {
278
347
  value: string;
279
348
  key: string;
280
349
  enabled: boolean;
350
+ type?: string | undefined;
351
+ default?: any;
281
352
  description?: string | undefined;
282
353
  enum?: string[] | undefined;
283
354
  required?: boolean | undefined;
284
355
  file?: File | undefined;
285
356
  refUid?: string | undefined;
357
+ format?: string | undefined;
286
358
  }[];
287
359
  query: {
288
360
  value: string;
289
361
  key: string;
290
362
  enabled: boolean;
363
+ type?: string | undefined;
364
+ default?: any;
291
365
  description?: string | undefined;
292
366
  enum?: string[] | undefined;
293
367
  required?: boolean | undefined;
294
368
  file?: File | undefined;
295
369
  refUid?: string | undefined;
370
+ format?: string | undefined;
296
371
  }[];
297
372
  cookies: {
298
373
  value: string;
299
374
  key: string;
300
375
  enabled: boolean;
376
+ type?: string | undefined;
377
+ default?: any;
301
378
  description?: string | undefined;
302
379
  enum?: string[] | undefined;
303
380
  required?: boolean | undefined;
304
381
  file?: File | undefined;
305
382
  refUid?: string | undefined;
383
+ format?: string | undefined;
306
384
  }[];
307
385
  headers: {
308
386
  value: string;
309
387
  key: string;
310
388
  enabled: boolean;
389
+ type?: string | undefined;
390
+ default?: any;
311
391
  description?: string | undefined;
312
392
  enum?: string[] | undefined;
313
393
  required?: boolean | undefined;
314
394
  file?: File | undefined;
315
395
  refUid?: string | undefined;
396
+ format?: string | undefined;
316
397
  }[];
317
398
  }, {
318
399
  path?: {
400
+ type?: string | undefined;
319
401
  value?: string | number | undefined;
402
+ default?: any;
320
403
  description?: string | undefined;
321
404
  key?: string | undefined;
322
405
  enum?: string[] | undefined;
@@ -324,9 +407,12 @@ declare const requestExampleSchema: z.ZodObject<{
324
407
  enabled?: boolean | undefined;
325
408
  file?: File | undefined;
326
409
  refUid?: string | undefined;
410
+ format?: string | undefined;
327
411
  }[] | undefined;
328
412
  query?: {
413
+ type?: string | undefined;
329
414
  value?: string | number | undefined;
415
+ default?: any;
330
416
  description?: string | undefined;
331
417
  key?: string | undefined;
332
418
  enum?: string[] | undefined;
@@ -334,9 +420,12 @@ declare const requestExampleSchema: z.ZodObject<{
334
420
  enabled?: boolean | undefined;
335
421
  file?: File | undefined;
336
422
  refUid?: string | undefined;
423
+ format?: string | undefined;
337
424
  }[] | undefined;
338
425
  cookies?: {
426
+ type?: string | undefined;
339
427
  value?: string | number | undefined;
428
+ default?: any;
340
429
  description?: string | undefined;
341
430
  key?: string | undefined;
342
431
  enum?: string[] | undefined;
@@ -344,9 +433,12 @@ declare const requestExampleSchema: z.ZodObject<{
344
433
  enabled?: boolean | undefined;
345
434
  file?: File | undefined;
346
435
  refUid?: string | undefined;
436
+ format?: string | undefined;
347
437
  }[] | undefined;
348
438
  headers?: {
439
+ type?: string | undefined;
349
440
  value?: string | number | undefined;
441
+ default?: any;
350
442
  description?: string | undefined;
351
443
  key?: string | undefined;
352
444
  enum?: string[] | undefined;
@@ -354,6 +446,7 @@ declare const requestExampleSchema: z.ZodObject<{
354
446
  enabled?: boolean | undefined;
355
447
  file?: File | undefined;
356
448
  refUid?: string | undefined;
449
+ format?: string | undefined;
357
450
  }[] | undefined;
358
451
  }>>>;
359
452
  auth: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodAny>>;
@@ -365,41 +458,53 @@ declare const requestExampleSchema: z.ZodObject<{
365
458
  value: string;
366
459
  key: string;
367
460
  enabled: boolean;
461
+ type?: string | undefined;
462
+ default?: any;
368
463
  description?: string | undefined;
369
464
  enum?: string[] | undefined;
370
465
  required?: boolean | undefined;
371
466
  file?: File | undefined;
372
467
  refUid?: string | undefined;
468
+ format?: string | undefined;
373
469
  }[];
374
470
  query: {
375
471
  value: string;
376
472
  key: string;
377
473
  enabled: boolean;
474
+ type?: string | undefined;
475
+ default?: any;
378
476
  description?: string | undefined;
379
477
  enum?: string[] | undefined;
380
478
  required?: boolean | undefined;
381
479
  file?: File | undefined;
382
480
  refUid?: string | undefined;
481
+ format?: string | undefined;
383
482
  }[];
384
483
  cookies: {
385
484
  value: string;
386
485
  key: string;
387
486
  enabled: boolean;
487
+ type?: string | undefined;
488
+ default?: any;
388
489
  description?: string | undefined;
389
490
  enum?: string[] | undefined;
390
491
  required?: boolean | undefined;
391
492
  file?: File | undefined;
392
493
  refUid?: string | undefined;
494
+ format?: string | undefined;
393
495
  }[];
394
496
  headers: {
395
497
  value: string;
396
498
  key: string;
397
499
  enabled: boolean;
500
+ type?: string | undefined;
501
+ default?: any;
398
502
  description?: string | undefined;
399
503
  enum?: string[] | undefined;
400
504
  required?: boolean | undefined;
401
505
  file?: File | undefined;
402
506
  refUid?: string | undefined;
507
+ format?: string | undefined;
403
508
  }[];
404
509
  };
405
510
  requestUid: string;
@@ -413,11 +518,14 @@ declare const requestExampleSchema: z.ZodObject<{
413
518
  value: string;
414
519
  key: string;
415
520
  enabled: boolean;
521
+ type?: string | undefined;
522
+ default?: any;
416
523
  description?: string | undefined;
417
524
  enum?: string[] | undefined;
418
525
  required?: boolean | undefined;
419
526
  file?: File | undefined;
420
527
  refUid?: string | undefined;
528
+ format?: string | undefined;
421
529
  }[];
422
530
  encoding: "form-data" | "urlencoded";
423
531
  };
@@ -431,7 +539,9 @@ declare const requestExampleSchema: z.ZodObject<{
431
539
  name?: string | undefined;
432
540
  parameters?: {
433
541
  path?: {
542
+ type?: string | undefined;
434
543
  value?: string | number | undefined;
544
+ default?: any;
435
545
  description?: string | undefined;
436
546
  key?: string | undefined;
437
547
  enum?: string[] | undefined;
@@ -439,9 +549,12 @@ declare const requestExampleSchema: z.ZodObject<{
439
549
  enabled?: boolean | undefined;
440
550
  file?: File | undefined;
441
551
  refUid?: string | undefined;
552
+ format?: string | undefined;
442
553
  }[] | undefined;
443
554
  query?: {
555
+ type?: string | undefined;
444
556
  value?: string | number | undefined;
557
+ default?: any;
445
558
  description?: string | undefined;
446
559
  key?: string | undefined;
447
560
  enum?: string[] | undefined;
@@ -449,9 +562,12 @@ declare const requestExampleSchema: z.ZodObject<{
449
562
  enabled?: boolean | undefined;
450
563
  file?: File | undefined;
451
564
  refUid?: string | undefined;
565
+ format?: string | undefined;
452
566
  }[] | undefined;
453
567
  cookies?: {
568
+ type?: string | undefined;
454
569
  value?: string | number | undefined;
570
+ default?: any;
455
571
  description?: string | undefined;
456
572
  key?: string | undefined;
457
573
  enum?: string[] | undefined;
@@ -459,9 +575,12 @@ declare const requestExampleSchema: z.ZodObject<{
459
575
  enabled?: boolean | undefined;
460
576
  file?: File | undefined;
461
577
  refUid?: string | undefined;
578
+ format?: string | undefined;
462
579
  }[] | undefined;
463
580
  headers?: {
581
+ type?: string | undefined;
464
582
  value?: string | number | undefined;
583
+ default?: any;
465
584
  description?: string | undefined;
466
585
  key?: string | undefined;
467
586
  enum?: string[] | undefined;
@@ -469,6 +588,7 @@ declare const requestExampleSchema: z.ZodObject<{
469
588
  enabled?: boolean | undefined;
470
589
  file?: File | undefined;
471
590
  refUid?: string | undefined;
591
+ format?: string | undefined;
472
592
  }[] | undefined;
473
593
  } | undefined;
474
594
  body?: {
@@ -478,7 +598,9 @@ declare const requestExampleSchema: z.ZodObject<{
478
598
  } | undefined;
479
599
  formData?: {
480
600
  value?: {
601
+ type?: string | undefined;
481
602
  value?: string | number | undefined;
603
+ default?: any;
482
604
  description?: string | undefined;
483
605
  key?: string | undefined;
484
606
  enum?: string[] | undefined;
@@ -486,6 +608,7 @@ declare const requestExampleSchema: z.ZodObject<{
486
608
  enabled?: boolean | undefined;
487
609
  file?: File | undefined;
488
610
  refUid?: string | undefined;
611
+ format?: string | undefined;
489
612
  }[] | undefined;
490
613
  encoding?: "form-data" | "urlencoded" | undefined;
491
614
  } | undefined;
@@ -506,41 +629,53 @@ export declare const createRequestExample: (payload: RequestExamplePayload) => {
506
629
  value: string;
507
630
  key: string;
508
631
  enabled: boolean;
632
+ type?: string | undefined;
633
+ default?: any;
509
634
  description?: string | undefined;
510
635
  enum?: string[] | undefined;
511
636
  required?: boolean | undefined;
512
637
  file?: File | undefined;
513
638
  refUid?: string | undefined;
639
+ format?: string | undefined;
514
640
  }[];
515
641
  query: {
516
642
  value: string;
517
643
  key: string;
518
644
  enabled: boolean;
645
+ type?: string | undefined;
646
+ default?: any;
519
647
  description?: string | undefined;
520
648
  enum?: string[] | undefined;
521
649
  required?: boolean | undefined;
522
650
  file?: File | undefined;
523
651
  refUid?: string | undefined;
652
+ format?: string | undefined;
524
653
  }[];
525
654
  cookies: {
526
655
  value: string;
527
656
  key: string;
528
657
  enabled: boolean;
658
+ type?: string | undefined;
659
+ default?: any;
529
660
  description?: string | undefined;
530
661
  enum?: string[] | undefined;
531
662
  required?: boolean | undefined;
532
663
  file?: File | undefined;
533
664
  refUid?: string | undefined;
665
+ format?: string | undefined;
534
666
  }[];
535
667
  headers: {
536
668
  value: string;
537
669
  key: string;
538
670
  enabled: boolean;
671
+ type?: string | undefined;
672
+ default?: any;
539
673
  description?: string | undefined;
540
674
  enum?: string[] | undefined;
541
675
  required?: boolean | undefined;
542
676
  file?: File | undefined;
543
677
  refUid?: string | undefined;
678
+ format?: string | undefined;
544
679
  }[];
545
680
  };
546
681
  requestUid: string;
@@ -554,11 +689,14 @@ export declare const createRequestExample: (payload: RequestExamplePayload) => {
554
689
  value: string;
555
690
  key: string;
556
691
  enabled: boolean;
692
+ type?: string | undefined;
693
+ default?: any;
557
694
  description?: string | undefined;
558
695
  enum?: string[] | undefined;
559
696
  required?: boolean | undefined;
560
697
  file?: File | undefined;
561
698
  refUid?: string | undefined;
699
+ format?: string | undefined;
562
700
  }[];
563
701
  encoding: "form-data" | "urlencoded";
564
702
  };
package/dist/entities/workspace/spec/request-examples.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"request-examples.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/spec/request-examples.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,QAAA,MAAM,8BAA8B;;;;;;IAMlC,kFAAkF;;;;;;;;;;;;;;;;;;;;;;EAIlF,CAAA;AAEF,kFAAkF;AAClF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,8BAA8B,CACtC,CAAA;AACD,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED,8CAA8C;AAC9C,eAAO,MAAM,6BAA6B,YAC/B,8BAA8B;;;;;;;;;CACwB,CAAA;AAEjE,QAAA,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;gBAnBxB,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmElF,CAAA;AAEF,mDAAmD;AACnD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACjE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAExE,oCAAoC;AACpC,eAAO,MAAM,oBAAoB,YAAa,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAIhE,CAAA"}
1
+ {"version":3,"file":"request-examples.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/spec/request-examples.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,QAAA,MAAM,8BAA8B;;;;;;IAMlC,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAOlF,CAAA;AAEF,kFAAkF;AAClF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,8BAA8B,CACtC,CAAA;AACD,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED,8CAA8C;AAC9C,eAAO,MAAM,6BAA6B,YAC/B,8BAA8B;;;;;;;;;;;;CACwB,CAAA;AAEjE,QAAA,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;gBAtBxB,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsElF,CAAA;AAEF,mDAAmD;AACnD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACjE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAExE,oCAAoC;AACpC,eAAO,MAAM,oBAAoB,YAAa,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAIhE,CAAA"}
package/dist/entities/workspace/spec/request-examples.js CHANGED
@@ -12,6 +12,9 @@ const requestExampleParametersSchema = z.object({
12
12
  refUid: nanoidSchema.optional(),
13
13
  required: z.boolean().optional(),
14
14
  enum: z.array(z.string()).optional(),
15
+ type: z.string().optional(),
16
+ format: z.string().optional(),
17
+ default: z.any().optional(),
15
18
  });
16
19
  /** Create request example parameter helper */
17
20
  const createRequestExampleParameter = (payload) => deepMerge(requestExampleParametersSchema.parse({}), payload);
package/package.json CHANGED
@@ -16,7 +16,7 @@
16
16
  "specification",
17
17
  "yaml"
18
18
  ],
19
- "version": "0.2.9",
19
+ "version": "0.2.10",
20
20
  "engines": {
21
21
  "node": ">=18"
22
22
  },