@scalar/oas-utils - npm Package Compare versions

Comparing version 0.2.9 to 0.2.10

CHANGELOG.md

 # @scalar/oas-utils
 
+## 0.2.10
+
+### Patch Changes
+
+- d58841b: feat: type, format and default to request example parameters schema
+
 ## 0.2.9
@@ -4,0 +10,0 @@

dist/entities/workspace/spec/request-examples.d.ts

@@ -12,2 +12,5 @@ import { z } from 'zod';
     enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    type: z.ZodOptional<z.ZodString>;
+    format: z.ZodOptional<z.ZodString>;
+    default: z.ZodOptional<z.ZodAny>;
 }, "strip", z.ZodTypeAny, {
@@ -17,2 +20,4 @@ value: string;
     enabled: boolean;
+    type?: string | undefined;
+    default?: any;
     description?: string | undefined;
@@ -23,4 +28,7 @@ enum?: string[] | undefined;
     refUid?: string | undefined;
+    format?: string | undefined;
 }, {
+    type?: string | undefined;
     value?: string | number | undefined;
+    default?: any;
     description?: string | undefined;
@@ -33,2 +41,3 @@ key?: string | undefined;
     refUid?: string | undefined;
+    format?: string | undefined;
 }>;
@@ -43,2 +52,4 @@ /** Request examples - formerly known as instances - are "children" of requests */
     enabled: boolean;
+    type?: string | undefined;
+    default?: any;
     description?: string | undefined;
@@ -49,2 +60,3 @@ enum?: string[] | undefined;
     refUid?: string | undefined;
+    format?: string | undefined;
 };
@@ -78,2 +90,5 @@ declare const requestExampleSchema: z.ZodObject<{
                 enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                type: z.ZodOptional<z.ZodString>;
+                format: z.ZodOptional<z.ZodString>;
+                default: z.ZodOptional<z.ZodAny>;
             }, "strip", z.ZodTypeAny, {
@@ -83,2 +98,4 @@ value: string;
                 enabled: boolean;
+                type?: string | undefined;
+                default?: any;
                 description?: string | undefined;
@@ -89,4 +106,7 @@ enum?: string[] | undefined;
                 refUid?: string | undefined;
+                format?: string | undefined;
             }, {
+                type?: string | undefined;
                 value?: string | number | undefined;
+                default?: any;
                 description?: string | undefined;
@@ -99,2 +119,3 @@ key?: string | undefined;
                 refUid?: string | undefined;
+                format?: string | undefined;
             }>, "many">>;
@@ -106,2 +127,4 @@ }, "strip", z.ZodTypeAny, {
                 enabled: boolean;
+                type?: string | undefined;
+                default?: any;
                 description?: string | undefined;
@@ -112,2 +135,3 @@ enum?: string[] | undefined;
                 refUid?: string | undefined;
+                format?: string | undefined;
             }[];
@@ -117,3 +141,5 @@ encoding: "form-data" | "urlencoded";
             value?: {
+                type?: string | undefined;
                 value?: string | number | undefined;
+                default?: any;
                 description?: string | undefined;
@@ -126,2 +152,3 @@ key?: string | undefined;
                 refUid?: string | undefined;
+                format?: string | undefined;
             }[] | undefined;
@@ -142,2 +169,4 @@ encoding?: "form-data" | "urlencoded" | undefined;
                 enabled: boolean;
+                type?: string | undefined;
+                default?: any;
                 description?: string | undefined;
@@ -148,2 +177,3 @@ enum?: string[] | undefined;
                 refUid?: string | undefined;
+                format?: string | undefined;
             }[];
@@ -161,3 +191,5 @@ encoding: "form-data" | "urlencoded";
             value?: {
+                type?: string | undefined;
                 value?: string | number | undefined;
+                default?: any;
                 description?: string | undefined;
@@ -170,2 +202,3 @@ key?: string | undefined;
                 refUid?: string | undefined;
+                format?: string | undefined;
             }[] | undefined;
@@ -188,2 +221,5 @@ encoding?: "form-data" | "urlencoded" | undefined;
             enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            type: z.ZodOptional<z.ZodString>;
+            format: z.ZodOptional<z.ZodString>;
+            default: z.ZodOptional<z.ZodAny>;
         }, "strip", z.ZodTypeAny, {
@@ -193,2 +229,4 @@ value: string;
             enabled: boolean;
+            type?: string | undefined;
+            default?: any;
             description?: string | undefined;
@@ -199,4 +237,7 @@ enum?: string[] | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }, {
+            type?: string | undefined;
             value?: string | number | undefined;
+            default?: any;
             description?: string | undefined;
@@ -209,2 +250,3 @@ key?: string | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }>, "many">>;
@@ -221,2 +263,5 @@ query: z.ZodDefault<z.ZodArray<z.ZodObject<{
             enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            type: z.ZodOptional<z.ZodString>;
+            format: z.ZodOptional<z.ZodString>;
+            default: z.ZodOptional<z.ZodAny>;
         }, "strip", z.ZodTypeAny, {
@@ -226,2 +271,4 @@ value: string;
             enabled: boolean;
+            type?: string | undefined;
+            default?: any;
             description?: string | undefined;
@@ -232,4 +279,7 @@ enum?: string[] | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }, {
+            type?: string | undefined;
             value?: string | number | undefined;
+            default?: any;
             description?: string | undefined;
@@ -242,2 +292,3 @@ key?: string | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }>, "many">>;
@@ -254,2 +305,5 @@ headers: z.ZodDefault<z.ZodArray<z.ZodObject<{
             enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            type: z.ZodOptional<z.ZodString>;
+            format: z.ZodOptional<z.ZodString>;
+            default: z.ZodOptional<z.ZodAny>;
         }, "strip", z.ZodTypeAny, {
@@ -259,2 +313,4 @@ value: string;
             enabled: boolean;
+            type?: string | undefined;
+            default?: any;
             description?: string | undefined;
@@ -265,4 +321,7 @@ enum?: string[] | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }, {
+            type?: string | undefined;
             value?: string | number | undefined;
+            default?: any;
             description?: string | undefined;
@@ -275,2 +334,3 @@ key?: string | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }>, "many">>;
@@ -287,2 +347,5 @@ cookies: z.ZodDefault<z.ZodArray<z.ZodObject<{
             enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            type: z.ZodOptional<z.ZodString>;
+            format: z.ZodOptional<z.ZodString>;
+            default: z.ZodOptional<z.ZodAny>;
         }, "strip", z.ZodTypeAny, {
@@ -292,2 +355,4 @@ value: string;
             enabled: boolean;
+            type?: string | undefined;
+            default?: any;
             description?: string | undefined;
@@ -298,4 +363,7 @@ enum?: string[] | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }, {
+            type?: string | undefined;
             value?: string | number | undefined;
+            default?: any;
             description?: string | undefined;
@@ -308,2 +376,3 @@ key?: string | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }>, "many">>;
@@ -315,2 +384,4 @@ }, "strip", z.ZodTypeAny, {
             enabled: boolean;
+            type?: string | undefined;
+            default?: any;
             description?: string | undefined;
@@ -321,2 +392,3 @@ enum?: string[] | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[];
@@ -327,2 +399,4 @@ query: {
             enabled: boolean;
+            type?: string | undefined;
+            default?: any;
             description?: string | undefined;
@@ -333,2 +407,3 @@ enum?: string[] | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[];
@@ -339,2 +414,4 @@ cookies: {
             enabled: boolean;
+            type?: string | undefined;
+            default?: any;
             description?: string | undefined;
@@ -345,2 +422,3 @@ enum?: string[] | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[];
@@ -351,2 +429,4 @@ headers: {
             enabled: boolean;
+            type?: string | undefined;
+            default?: any;
             description?: string | undefined;
@@ -357,6 +437,9 @@ enum?: string[] | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[];
     }, {
         path?: {
+            type?: string | undefined;
             value?: string | number | undefined;
+            default?: any;
             description?: string | undefined;
@@ -369,5 +452,8 @@ key?: string | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[] | undefined;
         query?: {
+            type?: string | undefined;
             value?: string | number | undefined;
+            default?: any;
             description?: string | undefined;
@@ -380,5 +466,8 @@ key?: string | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[] | undefined;
         cookies?: {
+            type?: string | undefined;
             value?: string | number | undefined;
+            default?: any;
             description?: string | undefined;
@@ -391,5 +480,8 @@ key?: string | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[] | undefined;
         headers?: {
+            type?: string | undefined;
             value?: string | number | undefined;
+            default?: any;
             description?: string | undefined;
@@ -402,2 +494,3 @@ key?: string | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[] | undefined;
@@ -414,2 +507,4 @@ }>>>;
             enabled: boolean;
+            type?: string | undefined;
+            default?: any;
             description?: string | undefined;
@@ -420,2 +515,3 @@ enum?: string[] | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[];
@@ -426,2 +522,4 @@ query: {
             enabled: boolean;
+            type?: string | undefined;
+            default?: any;
             description?: string | undefined;
@@ -432,2 +530,3 @@ enum?: string[] | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[];
@@ -438,2 +537,4 @@ cookies: {
             enabled: boolean;
+            type?: string | undefined;
+            default?: any;
             description?: string | undefined;
@@ -444,2 +545,3 @@ enum?: string[] | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[];
@@ -450,2 +552,4 @@ headers: {
             enabled: boolean;
+            type?: string | undefined;
+            default?: any;
             description?: string | undefined;
@@ -456,2 +560,3 @@ enum?: string[] | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[];
@@ -470,2 +575,4 @@ };
                 enabled: boolean;
+                type?: string | undefined;
+                default?: any;
                 description?: string | undefined;
@@ -476,2 +583,3 @@ enum?: string[] | undefined;
                 refUid?: string | undefined;
+                format?: string | undefined;
             }[];
@@ -490,3 +598,5 @@ encoding: "form-data" | "urlencoded";
         path?: {
+            type?: string | undefined;
             value?: string | number | undefined;
+            default?: any;
             description?: string | undefined;
@@ -499,5 +609,8 @@ key?: string | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[] | undefined;
         query?: {
+            type?: string | undefined;
             value?: string | number | undefined;
+            default?: any;
             description?: string | undefined;
@@ -510,5 +623,8 @@ key?: string | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[] | undefined;
         cookies?: {
+            type?: string | undefined;
             value?: string | number | undefined;
+            default?: any;
             description?: string | undefined;
@@ -521,5 +637,8 @@ key?: string | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[] | undefined;
         headers?: {
+            type?: string | undefined;
             value?: string | number | undefined;
+            default?: any;
             description?: string | undefined;
@@ -532,2 +651,3 @@ key?: string | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[] | undefined;
@@ -542,3 +662,5 @@ } | undefined;
             value?: {
+                type?: string | undefined;
                 value?: string | number | undefined;
+                default?: any;
                 description?: string | undefined;
@@ -551,2 +673,3 @@ key?: string | undefined;
                 refUid?: string | undefined;
+                format?: string | undefined;
             }[] | undefined;
@@ -572,2 +695,4 @@ encoding?: "form-data" | "urlencoded" | undefined;
             enabled: boolean;
+            type?: string | undefined;
+            default?: any;
             description?: string | undefined;
@@ -578,2 +703,3 @@ enum?: string[] | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[];
@@ -584,2 +710,4 @@ query: {
             enabled: boolean;
+            type?: string | undefined;
+            default?: any;
             description?: string | undefined;
@@ -590,2 +718,3 @@ enum?: string[] | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[];
@@ -596,2 +725,4 @@ cookies: {
             enabled: boolean;
+            type?: string | undefined;
+            default?: any;
             description?: string | undefined;
@@ -602,2 +733,3 @@ enum?: string[] | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[];
@@ -608,2 +740,4 @@ headers: {
             enabled: boolean;
+            type?: string | undefined;
+            default?: any;
             description?: string | undefined;
@@ -614,2 +748,3 @@ enum?: string[] | undefined;
             refUid?: string | undefined;
+            format?: string | undefined;
         }[];
@@ -628,2 +763,4 @@ };
                 enabled: boolean;
+                type?: string | undefined;
+                default?: any;
                 description?: string | undefined;
@@ -634,2 +771,3 @@ enum?: string[] | undefined;
                 refUid?: string | undefined;
+                format?: string | undefined;
             }[];
@@ -636,0 +774,0 @@ encoding: "form-data" | "urlencoded";

dist/entities/workspace/spec/request-examples.js

@@ -15,2 +15,5 @@ import { z } from 'zod';
     enum: z.array(z.string()).optional(),
+    type: z.string().optional(),
+    format: z.string().optional(),
+    default: z.any().optional(),
 });
@@ -17,0 +20,0 @@ /** Create request example parameter helper */

package.json

@@ -19,3 +19,3 @@ {
   ],
-  "version": "0.2.9",
+  "version": "0.2.10",
   "engines": {
@@ -22,0 +22,0 @@ "node": ">=18"

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

232128

increased by2.42%

Lines of code

5046

increased by2.87%

No dependency changes