@scalar/oas-utils 0.2.9 → 0.2.11

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 +12 -0
  2. package/dist/entities/workspace/spec/request-examples.d.ts +230 -0
  3. package/dist/entities/workspace/spec/request-examples.d.ts.map +1 -1
  4. package/dist/entities/workspace/spec/request-examples.js +5 -0
  5. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @scalar/oas-utils
2
2
 
3
+ ## 0.2.11
4
+
5
+ ### Patch Changes
6
+
7
+ - ad7fd7e: feat: add min max to request example parameters schema
8
+
9
+ ## 0.2.10
10
+
11
+ ### Patch Changes
12
+
13
+ - d58841b: feat: type, format and default to request example parameters schema
14
+
3
15
  ## 0.2.9
4
16
 
5
17
  ### Patch Changes
package/dist/entities/workspace/spec/request-examples.d.ts CHANGED
@@ -9,17 +9,31 @@ 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
+ minimum: z.ZodOptional<z.ZodNumber>;
15
+ maximum: z.ZodOptional<z.ZodNumber>;
16
+ default: z.ZodOptional<z.ZodAny>;
12
17
  }, "strip", z.ZodTypeAny, {
13
18
  value: string;
14
19
  key: string;
15
20
  enabled: boolean;
21
+ minimum?: number | undefined;
22
+ type?: string | undefined;
23
+ maximum?: number | undefined;
24
+ default?: any;
16
25
  description?: string | undefined;
17
26
  enum?: string[] | undefined;
18
27
  required?: boolean | undefined;
19
28
  file?: File | undefined;
20
29
  refUid?: string | undefined;
30
+ format?: string | undefined;
21
31
  }, {
32
+ minimum?: number | undefined;
33
+ type?: string | undefined;
34
+ maximum?: number | undefined;
22
35
  value?: string | number | undefined;
36
+ default?: any;
23
37
  description?: string | undefined;
24
38
  key?: string | undefined;
25
39
  enum?: string[] | undefined;
@@ -27,6 +41,7 @@ declare const requestExampleParametersSchema: z.ZodObject<{
27
41
  enabled?: boolean | undefined;
28
42
  file?: File | undefined;
29
43
  refUid?: string | undefined;
44
+ format?: string | undefined;
30
45
  }>;
31
46
  /** Request examples - formerly known as instances - are "children" of requests */
32
47
  export type RequestExampleParameter = z.infer<typeof requestExampleParametersSchema>;
@@ -36,11 +51,16 @@ export declare const createRequestExampleParameter: (payload: RequestExamplePara
36
51
  value: string;
37
52
  key: string;
38
53
  enabled: boolean;
54
+ minimum?: number | undefined;
55
+ type?: string | undefined;
56
+ maximum?: number | undefined;
57
+ default?: any;
39
58
  description?: string | undefined;
40
59
  enum?: string[] | undefined;
41
60
  required?: boolean | undefined;
42
61
  file?: File | undefined;
43
62
  refUid?: string | undefined;
63
+ format?: string | undefined;
44
64
  };
45
65
  declare const requestExampleSchema: z.ZodObject<{
46
66
  uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
@@ -69,17 +89,31 @@ declare const requestExampleSchema: z.ZodObject<{
69
89
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
70
90
  required: z.ZodOptional<z.ZodBoolean>;
71
91
  enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
92
+ type: z.ZodOptional<z.ZodString>;
93
+ format: z.ZodOptional<z.ZodString>;
94
+ minimum: z.ZodOptional<z.ZodNumber>;
95
+ maximum: z.ZodOptional<z.ZodNumber>;
96
+ default: z.ZodOptional<z.ZodAny>;
72
97
  }, "strip", z.ZodTypeAny, {
73
98
  value: string;
74
99
  key: string;
75
100
  enabled: boolean;
101
+ minimum?: number | undefined;
102
+ type?: string | undefined;
103
+ maximum?: number | undefined;
104
+ default?: any;
76
105
  description?: string | undefined;
77
106
  enum?: string[] | undefined;
78
107
  required?: boolean | undefined;
79
108
  file?: File | undefined;
80
109
  refUid?: string | undefined;
110
+ format?: string | undefined;
81
111
  }, {
112
+ minimum?: number | undefined;
113
+ type?: string | undefined;
114
+ maximum?: number | undefined;
82
115
  value?: string | number | undefined;
116
+ default?: any;
83
117
  description?: string | undefined;
84
118
  key?: string | undefined;
85
119
  enum?: string[] | undefined;
@@ -87,22 +121,32 @@ declare const requestExampleSchema: z.ZodObject<{
87
121
  enabled?: boolean | undefined;
88
122
  file?: File | undefined;
89
123
  refUid?: string | undefined;
124
+ format?: string | undefined;
90
125
  }>, "many">>;
91
126
  }, "strip", z.ZodTypeAny, {
92
127
  value: {
93
128
  value: string;
94
129
  key: string;
95
130
  enabled: boolean;
131
+ minimum?: number | undefined;
132
+ type?: string | undefined;
133
+ maximum?: number | undefined;
134
+ default?: any;
96
135
  description?: string | undefined;
97
136
  enum?: string[] | undefined;
98
137
  required?: boolean | undefined;
99
138
  file?: File | undefined;
100
139
  refUid?: string | undefined;
140
+ format?: string | undefined;
101
141
  }[];
102
142
  encoding: "form-data" | "urlencoded";
103
143
  }, {
104
144
  value?: {
145
+ minimum?: number | undefined;
146
+ type?: string | undefined;
147
+ maximum?: number | undefined;
105
148
  value?: string | number | undefined;
149
+ default?: any;
106
150
  description?: string | undefined;
107
151
  key?: string | undefined;
108
152
  enum?: string[] | undefined;
@@ -110,6 +154,7 @@ declare const requestExampleSchema: z.ZodObject<{
110
154
  enabled?: boolean | undefined;
111
155
  file?: File | undefined;
112
156
  refUid?: string | undefined;
157
+ format?: string | undefined;
113
158
  }[] | undefined;
114
159
  encoding?: "form-data" | "urlencoded" | undefined;
115
160
  }>>;
@@ -125,11 +170,16 @@ declare const requestExampleSchema: z.ZodObject<{
125
170
  value: string;
126
171
  key: string;
127
172
  enabled: boolean;
173
+ minimum?: number | undefined;
174
+ type?: string | undefined;
175
+ maximum?: number | undefined;
176
+ default?: any;
128
177
  description?: string | undefined;
129
178
  enum?: string[] | undefined;
130
179
  required?: boolean | undefined;
131
180
  file?: File | undefined;
132
181
  refUid?: string | undefined;
182
+ format?: string | undefined;
133
183
  }[];
134
184
  encoding: "form-data" | "urlencoded";
135
185
  };
@@ -142,7 +192,11 @@ declare const requestExampleSchema: z.ZodObject<{
142
192
  } | undefined;
143
193
  formData?: {
144
194
  value?: {
195
+ minimum?: number | undefined;
196
+ type?: string | undefined;
197
+ maximum?: number | undefined;
145
198
  value?: string | number | undefined;
199
+ default?: any;
146
200
  description?: string | undefined;
147
201
  key?: string | undefined;
148
202
  enum?: string[] | undefined;
@@ -150,6 +204,7 @@ declare const requestExampleSchema: z.ZodObject<{
150
204
  enabled?: boolean | undefined;
151
205
  file?: File | undefined;
152
206
  refUid?: string | undefined;
207
+ format?: string | undefined;
153
208
  }[] | undefined;
154
209
  encoding?: "form-data" | "urlencoded" | undefined;
155
210
  } | undefined;
@@ -167,17 +222,31 @@ declare const requestExampleSchema: z.ZodObject<{
167
222
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
168
223
  required: z.ZodOptional<z.ZodBoolean>;
169
224
  enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
225
+ type: z.ZodOptional<z.ZodString>;
226
+ format: z.ZodOptional<z.ZodString>;
227
+ minimum: z.ZodOptional<z.ZodNumber>;
228
+ maximum: z.ZodOptional<z.ZodNumber>;
229
+ default: z.ZodOptional<z.ZodAny>;
170
230
  }, "strip", z.ZodTypeAny, {
171
231
  value: string;
172
232
  key: string;
173
233
  enabled: boolean;
234
+ minimum?: number | undefined;
235
+ type?: string | undefined;
236
+ maximum?: number | undefined;
237
+ default?: any;
174
238
  description?: string | undefined;
175
239
  enum?: string[] | undefined;
176
240
  required?: boolean | undefined;
177
241
  file?: File | undefined;
178
242
  refUid?: string | undefined;
243
+ format?: string | undefined;
179
244
  }, {
245
+ minimum?: number | undefined;
246
+ type?: string | undefined;
247
+ maximum?: number | undefined;
180
248
  value?: string | number | undefined;
249
+ default?: any;
181
250
  description?: string | undefined;
182
251
  key?: string | undefined;
183
252
  enum?: string[] | undefined;
@@ -185,6 +254,7 @@ declare const requestExampleSchema: z.ZodObject<{
185
254
  enabled?: boolean | undefined;
186
255
  file?: File | undefined;
187
256
  refUid?: string | undefined;
257
+ format?: string | undefined;
188
258
  }>, "many">>;
189
259
  query: z.ZodDefault<z.ZodArray<z.ZodObject<{
190
260
  key: z.ZodDefault<z.ZodString>;
@@ -196,17 +266,31 @@ declare const requestExampleSchema: z.ZodObject<{
196
266
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
197
267
  required: z.ZodOptional<z.ZodBoolean>;
198
268
  enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
269
+ type: z.ZodOptional<z.ZodString>;
270
+ format: z.ZodOptional<z.ZodString>;
271
+ minimum: z.ZodOptional<z.ZodNumber>;
272
+ maximum: z.ZodOptional<z.ZodNumber>;
273
+ default: z.ZodOptional<z.ZodAny>;
199
274
  }, "strip", z.ZodTypeAny, {
200
275
  value: string;
201
276
  key: string;
202
277
  enabled: boolean;
278
+ minimum?: number | undefined;
279
+ type?: string | undefined;
280
+ maximum?: number | undefined;
281
+ default?: any;
203
282
  description?: string | undefined;
204
283
  enum?: string[] | undefined;
205
284
  required?: boolean | undefined;
206
285
  file?: File | undefined;
207
286
  refUid?: string | undefined;
287
+ format?: string | undefined;
208
288
  }, {
289
+ minimum?: number | undefined;
290
+ type?: string | undefined;
291
+ maximum?: number | undefined;
209
292
  value?: string | number | undefined;
293
+ default?: any;
210
294
  description?: string | undefined;
211
295
  key?: string | undefined;
212
296
  enum?: string[] | undefined;
@@ -214,6 +298,7 @@ declare const requestExampleSchema: z.ZodObject<{
214
298
  enabled?: boolean | undefined;
215
299
  file?: File | undefined;
216
300
  refUid?: string | undefined;
301
+ format?: string | undefined;
217
302
  }>, "many">>;
218
303
  headers: z.ZodDefault<z.ZodArray<z.ZodObject<{
219
304
  key: z.ZodDefault<z.ZodString>;
@@ -225,17 +310,31 @@ declare const requestExampleSchema: z.ZodObject<{
225
310
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
226
311
  required: z.ZodOptional<z.ZodBoolean>;
227
312
  enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
313
+ type: z.ZodOptional<z.ZodString>;
314
+ format: z.ZodOptional<z.ZodString>;
315
+ minimum: z.ZodOptional<z.ZodNumber>;
316
+ maximum: z.ZodOptional<z.ZodNumber>;
317
+ default: z.ZodOptional<z.ZodAny>;
228
318
  }, "strip", z.ZodTypeAny, {
229
319
  value: string;
230
320
  key: string;
231
321
  enabled: boolean;
322
+ minimum?: number | undefined;
323
+ type?: string | undefined;
324
+ maximum?: number | undefined;
325
+ default?: any;
232
326
  description?: string | undefined;
233
327
  enum?: string[] | undefined;
234
328
  required?: boolean | undefined;
235
329
  file?: File | undefined;
236
330
  refUid?: string | undefined;
331
+ format?: string | undefined;
237
332
  }, {
333
+ minimum?: number | undefined;
334
+ type?: string | undefined;
335
+ maximum?: number | undefined;
238
336
  value?: string | number | undefined;
337
+ default?: any;
239
338
  description?: string | undefined;
240
339
  key?: string | undefined;
241
340
  enum?: string[] | undefined;
@@ -243,6 +342,7 @@ declare const requestExampleSchema: z.ZodObject<{
243
342
  enabled?: boolean | undefined;
244
343
  file?: File | undefined;
245
344
  refUid?: string | undefined;
345
+ format?: string | undefined;
246
346
  }>, "many">>;
247
347
  cookies: z.ZodDefault<z.ZodArray<z.ZodObject<{
248
348
  key: z.ZodDefault<z.ZodString>;
@@ -254,17 +354,31 @@ declare const requestExampleSchema: z.ZodObject<{
254
354
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
255
355
  required: z.ZodOptional<z.ZodBoolean>;
256
356
  enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
357
+ type: z.ZodOptional<z.ZodString>;
358
+ format: z.ZodOptional<z.ZodString>;
359
+ minimum: z.ZodOptional<z.ZodNumber>;
360
+ maximum: z.ZodOptional<z.ZodNumber>;
361
+ default: z.ZodOptional<z.ZodAny>;
257
362
  }, "strip", z.ZodTypeAny, {
258
363
  value: string;
259
364
  key: string;
260
365
  enabled: boolean;
366
+ minimum?: number | undefined;
367
+ type?: string | undefined;
368
+ maximum?: number | undefined;
369
+ default?: any;
261
370
  description?: string | undefined;
262
371
  enum?: string[] | undefined;
263
372
  required?: boolean | undefined;
264
373
  file?: File | undefined;
265
374
  refUid?: string | undefined;
375
+ format?: string | undefined;
266
376
  }, {
377
+ minimum?: number | undefined;
378
+ type?: string | undefined;
379
+ maximum?: number | undefined;
267
380
  value?: string | number | undefined;
381
+ default?: any;
268
382
  description?: string | undefined;
269
383
  key?: string | undefined;
270
384
  enum?: string[] | undefined;
@@ -272,51 +386,76 @@ declare const requestExampleSchema: z.ZodObject<{
272
386
  enabled?: boolean | undefined;
273
387
  file?: File | undefined;
274
388
  refUid?: string | undefined;
389
+ format?: string | undefined;
275
390
  }>, "many">>;
276
391
  }, "strip", z.ZodTypeAny, {
277
392
  path: {
278
393
  value: string;
279
394
  key: string;
280
395
  enabled: boolean;
396
+ minimum?: number | undefined;
397
+ type?: string | undefined;
398
+ maximum?: number | undefined;
399
+ default?: any;
281
400
  description?: string | undefined;
282
401
  enum?: string[] | undefined;
283
402
  required?: boolean | undefined;
284
403
  file?: File | undefined;
285
404
  refUid?: string | undefined;
405
+ format?: string | undefined;
286
406
  }[];
287
407
  query: {
288
408
  value: string;
289
409
  key: string;
290
410
  enabled: boolean;
411
+ minimum?: number | undefined;
412
+ type?: string | undefined;
413
+ maximum?: number | undefined;
414
+ default?: any;
291
415
  description?: string | undefined;
292
416
  enum?: string[] | undefined;
293
417
  required?: boolean | undefined;
294
418
  file?: File | undefined;
295
419
  refUid?: string | undefined;
420
+ format?: string | undefined;
296
421
  }[];
297
422
  cookies: {
298
423
  value: string;
299
424
  key: string;
300
425
  enabled: boolean;
426
+ minimum?: number | undefined;
427
+ type?: string | undefined;
428
+ maximum?: number | undefined;
429
+ default?: any;
301
430
  description?: string | undefined;
302
431
  enum?: string[] | undefined;
303
432
  required?: boolean | undefined;
304
433
  file?: File | undefined;
305
434
  refUid?: string | undefined;
435
+ format?: string | undefined;
306
436
  }[];
307
437
  headers: {
308
438
  value: string;
309
439
  key: string;
310
440
  enabled: boolean;
441
+ minimum?: number | undefined;
442
+ type?: string | undefined;
443
+ maximum?: number | undefined;
444
+ default?: any;
311
445
  description?: string | undefined;
312
446
  enum?: string[] | undefined;
313
447
  required?: boolean | undefined;
314
448
  file?: File | undefined;
315
449
  refUid?: string | undefined;
450
+ format?: string | undefined;
316
451
  }[];
317
452
  }, {
318
453
  path?: {
454
+ minimum?: number | undefined;
455
+ type?: string | undefined;
456
+ maximum?: number | undefined;
319
457
  value?: string | number | undefined;
458
+ default?: any;
320
459
  description?: string | undefined;
321
460
  key?: string | undefined;
322
461
  enum?: string[] | undefined;
@@ -324,9 +463,14 @@ declare const requestExampleSchema: z.ZodObject<{
324
463
  enabled?: boolean | undefined;
325
464
  file?: File | undefined;
326
465
  refUid?: string | undefined;
466
+ format?: string | undefined;
327
467
  }[] | undefined;
328
468
  query?: {
469
+ minimum?: number | undefined;
470
+ type?: string | undefined;
471
+ maximum?: number | undefined;
329
472
  value?: string | number | undefined;
473
+ default?: any;
330
474
  description?: string | undefined;
331
475
  key?: string | undefined;
332
476
  enum?: string[] | undefined;
@@ -334,9 +478,14 @@ declare const requestExampleSchema: z.ZodObject<{
334
478
  enabled?: boolean | undefined;
335
479
  file?: File | undefined;
336
480
  refUid?: string | undefined;
481
+ format?: string | undefined;
337
482
  }[] | undefined;
338
483
  cookies?: {
484
+ minimum?: number | undefined;
485
+ type?: string | undefined;
486
+ maximum?: number | undefined;
339
487
  value?: string | number | undefined;
488
+ default?: any;
340
489
  description?: string | undefined;
341
490
  key?: string | undefined;
342
491
  enum?: string[] | undefined;
@@ -344,9 +493,14 @@ declare const requestExampleSchema: z.ZodObject<{
344
493
  enabled?: boolean | undefined;
345
494
  file?: File | undefined;
346
495
  refUid?: string | undefined;
496
+ format?: string | undefined;
347
497
  }[] | undefined;
348
498
  headers?: {
499
+ minimum?: number | undefined;
500
+ type?: string | undefined;
501
+ maximum?: number | undefined;
349
502
  value?: string | number | undefined;
503
+ default?: any;
350
504
  description?: string | undefined;
351
505
  key?: string | undefined;
352
506
  enum?: string[] | undefined;
@@ -354,6 +508,7 @@ declare const requestExampleSchema: z.ZodObject<{
354
508
  enabled?: boolean | undefined;
355
509
  file?: File | undefined;
356
510
  refUid?: string | undefined;
511
+ format?: string | undefined;
357
512
  }[] | undefined;
358
513
  }>>>;
359
514
  auth: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodAny>>;
@@ -365,41 +520,61 @@ declare const requestExampleSchema: z.ZodObject<{
365
520
  value: string;
366
521
  key: string;
367
522
  enabled: boolean;
523
+ minimum?: number | undefined;
524
+ type?: string | undefined;
525
+ maximum?: number | undefined;
526
+ default?: any;
368
527
  description?: string | undefined;
369
528
  enum?: string[] | undefined;
370
529
  required?: boolean | undefined;
371
530
  file?: File | undefined;
372
531
  refUid?: string | undefined;
532
+ format?: string | undefined;
373
533
  }[];
374
534
  query: {
375
535
  value: string;
376
536
  key: string;
377
537
  enabled: boolean;
538
+ minimum?: number | undefined;
539
+ type?: string | undefined;
540
+ maximum?: number | undefined;
541
+ default?: any;
378
542
  description?: string | undefined;
379
543
  enum?: string[] | undefined;
380
544
  required?: boolean | undefined;
381
545
  file?: File | undefined;
382
546
  refUid?: string | undefined;
547
+ format?: string | undefined;
383
548
  }[];
384
549
  cookies: {
385
550
  value: string;
386
551
  key: string;
387
552
  enabled: boolean;
553
+ minimum?: number | undefined;
554
+ type?: string | undefined;
555
+ maximum?: number | undefined;
556
+ default?: any;
388
557
  description?: string | undefined;
389
558
  enum?: string[] | undefined;
390
559
  required?: boolean | undefined;
391
560
  file?: File | undefined;
392
561
  refUid?: string | undefined;
562
+ format?: string | undefined;
393
563
  }[];
394
564
  headers: {
395
565
  value: string;
396
566
  key: string;
397
567
  enabled: boolean;
568
+ minimum?: number | undefined;
569
+ type?: string | undefined;
570
+ maximum?: number | undefined;
571
+ default?: any;
398
572
  description?: string | undefined;
399
573
  enum?: string[] | undefined;
400
574
  required?: boolean | undefined;
401
575
  file?: File | undefined;
402
576
  refUid?: string | undefined;
577
+ format?: string | undefined;
403
578
  }[];
404
579
  };
405
580
  requestUid: string;
@@ -413,11 +588,16 @@ declare const requestExampleSchema: z.ZodObject<{
413
588
  value: string;
414
589
  key: string;
415
590
  enabled: boolean;
591
+ minimum?: number | undefined;
592
+ type?: string | undefined;
593
+ maximum?: number | undefined;
594
+ default?: any;
416
595
  description?: string | undefined;
417
596
  enum?: string[] | undefined;
418
597
  required?: boolean | undefined;
419
598
  file?: File | undefined;
420
599
  refUid?: string | undefined;
600
+ format?: string | undefined;
421
601
  }[];
422
602
  encoding: "form-data" | "urlencoded";
423
603
  };
@@ -431,7 +611,11 @@ declare const requestExampleSchema: z.ZodObject<{
431
611
  name?: string | undefined;
432
612
  parameters?: {
433
613
  path?: {
614
+ minimum?: number | undefined;
615
+ type?: string | undefined;
616
+ maximum?: number | undefined;
434
617
  value?: string | number | undefined;
618
+ default?: any;
435
619
  description?: string | undefined;
436
620
  key?: string | undefined;
437
621
  enum?: string[] | undefined;
@@ -439,9 +623,14 @@ declare const requestExampleSchema: z.ZodObject<{
439
623
  enabled?: boolean | undefined;
440
624
  file?: File | undefined;
441
625
  refUid?: string | undefined;
626
+ format?: string | undefined;
442
627
  }[] | undefined;
443
628
  query?: {
629
+ minimum?: number | undefined;
630
+ type?: string | undefined;
631
+ maximum?: number | undefined;
444
632
  value?: string | number | undefined;
633
+ default?: any;
445
634
  description?: string | undefined;
446
635
  key?: string | undefined;
447
636
  enum?: string[] | undefined;
@@ -449,9 +638,14 @@ declare const requestExampleSchema: z.ZodObject<{
449
638
  enabled?: boolean | undefined;
450
639
  file?: File | undefined;
451
640
  refUid?: string | undefined;
641
+ format?: string | undefined;
452
642
  }[] | undefined;
453
643
  cookies?: {
644
+ minimum?: number | undefined;
645
+ type?: string | undefined;
646
+ maximum?: number | undefined;
454
647
  value?: string | number | undefined;
648
+ default?: any;
455
649
  description?: string | undefined;
456
650
  key?: string | undefined;
457
651
  enum?: string[] | undefined;
@@ -459,9 +653,14 @@ declare const requestExampleSchema: z.ZodObject<{
459
653
  enabled?: boolean | undefined;
460
654
  file?: File | undefined;
461
655
  refUid?: string | undefined;
656
+ format?: string | undefined;
462
657
  }[] | undefined;
463
658
  headers?: {
659
+ minimum?: number | undefined;
660
+ type?: string | undefined;
661
+ maximum?: number | undefined;
464
662
  value?: string | number | undefined;
663
+ default?: any;
465
664
  description?: string | undefined;
466
665
  key?: string | undefined;
467
666
  enum?: string[] | undefined;
@@ -469,6 +668,7 @@ declare const requestExampleSchema: z.ZodObject<{
469
668
  enabled?: boolean | undefined;
470
669
  file?: File | undefined;
471
670
  refUid?: string | undefined;
671
+ format?: string | undefined;
472
672
  }[] | undefined;
473
673
  } | undefined;
474
674
  body?: {
@@ -478,7 +678,11 @@ declare const requestExampleSchema: z.ZodObject<{
478
678
  } | undefined;
479
679
  formData?: {
480
680
  value?: {
681
+ minimum?: number | undefined;
682
+ type?: string | undefined;
683
+ maximum?: number | undefined;
481
684
  value?: string | number | undefined;
685
+ default?: any;
482
686
  description?: string | undefined;
483
687
  key?: string | undefined;
484
688
  enum?: string[] | undefined;
@@ -486,6 +690,7 @@ declare const requestExampleSchema: z.ZodObject<{
486
690
  enabled?: boolean | undefined;
487
691
  file?: File | undefined;
488
692
  refUid?: string | undefined;
693
+ format?: string | undefined;
489
694
  }[] | undefined;
490
695
  encoding?: "form-data" | "urlencoded" | undefined;
491
696
  } | undefined;
@@ -506,41 +711,61 @@ export declare const createRequestExample: (payload: RequestExamplePayload) => {
506
711
  value: string;
507
712
  key: string;
508
713
  enabled: boolean;
714
+ minimum?: number | undefined;
715
+ type?: string | undefined;
716
+ maximum?: number | undefined;
717
+ default?: any;
509
718
  description?: string | undefined;
510
719
  enum?: string[] | undefined;
511
720
  required?: boolean | undefined;
512
721
  file?: File | undefined;
513
722
  refUid?: string | undefined;
723
+ format?: string | undefined;
514
724
  }[];
515
725
  query: {
516
726
  value: string;
517
727
  key: string;
518
728
  enabled: boolean;
729
+ minimum?: number | undefined;
730
+ type?: string | undefined;
731
+ maximum?: number | undefined;
732
+ default?: any;
519
733
  description?: string | undefined;
520
734
  enum?: string[] | undefined;
521
735
  required?: boolean | undefined;
522
736
  file?: File | undefined;
523
737
  refUid?: string | undefined;
738
+ format?: string | undefined;
524
739
  }[];
525
740
  cookies: {
526
741
  value: string;
527
742
  key: string;
528
743
  enabled: boolean;
744
+ minimum?: number | undefined;
745
+ type?: string | undefined;
746
+ maximum?: number | undefined;
747
+ default?: any;
529
748
  description?: string | undefined;
530
749
  enum?: string[] | undefined;
531
750
  required?: boolean | undefined;
532
751
  file?: File | undefined;
533
752
  refUid?: string | undefined;
753
+ format?: string | undefined;
534
754
  }[];
535
755
  headers: {
536
756
  value: string;
537
757
  key: string;
538
758
  enabled: boolean;
759
+ minimum?: number | undefined;
760
+ type?: string | undefined;
761
+ maximum?: number | undefined;
762
+ default?: any;
539
763
  description?: string | undefined;
540
764
  enum?: string[] | undefined;
541
765
  required?: boolean | undefined;
542
766
  file?: File | undefined;
543
767
  refUid?: string | undefined;
768
+ format?: string | undefined;
544
769
  }[];
545
770
  };
546
771
  requestUid: string;
@@ -554,11 +779,16 @@ export declare const createRequestExample: (payload: RequestExamplePayload) => {
554
779
  value: string;
555
780
  key: string;
556
781
  enabled: boolean;
782
+ minimum?: number | undefined;
783
+ type?: string | undefined;
784
+ maximum?: number | undefined;
785
+ default?: any;
557
786
  description?: string | undefined;
558
787
  enum?: string[] | undefined;
559
788
  required?: boolean | undefined;
560
789
  file?: File | undefined;
561
790
  refUid?: string | undefined;
791
+ format?: string | undefined;
562
792
  }[];
563
793
  encoding: "form-data" | "urlencoded";
564
794
  };
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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASlF,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;;;;;;;;;;;;;;;;;;;;;;;gBAxBxB,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwElF,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,11 @@ 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
+ minimum: z.number().optional(),
18
+ maximum: z.number().optional(),
19
+ default: z.any().optional(),
15
20
  });
16
21
  /** Create request example parameter helper */
17
22
  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.11",
20
20
  "engines": {
21
21
  "node": ">=18"
22
22
  },