npm - @scalar/oas-utils - Versions diffs - 0.2.121 → 0.2.123 - Mend

@scalar/oas-utils 0.2.121 → 0.2.123

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 (202) hide show

package/dist/entities/spec/request-examples.d.ts CHANGED Viewed

@@ -1,7 +1,7 @@
 import { z } from 'zod';
-import type { RequestParameter } from './parameters.js';
-import type { Request } from './requests.js';
-import type { Server } from './server.js';
+import type { RequestParameter } from './parameters.ts';
+import type { Request } from './requests.ts';
+import type { Server } from './server.ts';
 /**
  * TODO: Deprecate this.
  *
@@ -30,28 +30,28 @@ export declare const requestExampleParametersSchema: z.ZodEffects<z.ZodObject<{
     minimum?: number | undefined;
     type?: string | string[] | undefined;
     maximum?: number | undefined;
+    description?: string | undefined;
     default?: any;
     required?: boolean | undefined;
-    description?: string | undefined;
-    enum?: string[] | undefined;
     examples?: string[] | undefined;
     format?: string | undefined;
+    enum?: string[] | undefined;
     file?: any;
     nullable?: boolean | undefined;
 }, {
+    value?: string | undefined;
     minimum?: number | undefined;
     type?: string | string[] | undefined;
     maximum?: number | undefined;
-    value?: string | undefined;
+    description?: string | undefined;
     default?: any;
     required?: boolean | undefined;
-    description?: string | undefined;
-    enum?: string[] | undefined;
     examples?: string[] | undefined;
     format?: string | undefined;
-    file?: any;
+    enum?: string[] | undefined;
     key?: string | undefined;
     enabled?: boolean | undefined;
+    file?: any;
     nullable?: boolean | undefined;
 }>, {
     value: string;
@@ -60,28 +60,28 @@ export declare const requestExampleParametersSchema: z.ZodEffects<z.ZodObject<{
     minimum?: number | undefined;
     type?: string | string[] | undefined;
     maximum?: number | undefined;
+    description?: string | undefined;
     default?: any;
     required?: boolean | undefined;
-    description?: string | undefined;
-    enum?: string[] | undefined;
     examples?: string[] | undefined;
     format?: string | undefined;
+    enum?: string[] | undefined;
     file?: any;
     nullable?: boolean | undefined;
 }, {
+    value?: string | undefined;
     minimum?: number | undefined;
     type?: string | string[] | undefined;
     maximum?: number | undefined;
-    value?: string | undefined;
+    description?: string | undefined;
     default?: any;
     required?: boolean | undefined;
-    description?: string | undefined;
-    enum?: string[] | undefined;
     examples?: string[] | undefined;
     format?: string | undefined;
-    file?: any;
+    enum?: string[] | undefined;
     key?: string | undefined;
     enabled?: boolean | undefined;
+    file?: any;
     nullable?: boolean | undefined;
 }>;
 /** Convert the array of parameters to an object keyed by the parameter name */
@@ -112,11 +112,11 @@ export declare const xScalarFormDataValue: z.ZodUnion<[z.ZodObject<{
     type: z.ZodLiteral<"string">;
     value: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    type: "string";
     value: string;
-}, {
     type: "string";
+}, {
     value: string;
+    type: "string";
 }>, z.ZodObject<{
     type: z.ZodLiteral<"file">;
     file: z.ZodNullable<z.ZodObject<{
@@ -195,28 +195,28 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }, {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }>, {
             value: string;
@@ -225,28 +225,28 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }, {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }>, "many">>;
     }, "strip", z.ZodTypeAny, {
@@ -257,31 +257,31 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }[];
         encoding: "form-data" | "urlencoded";
     }, {
         value?: {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }[] | undefined;
         encoding?: "form-data" | "urlencoded" | undefined;
@@ -289,8 +289,7 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
     binary: z.ZodOptional<z.ZodType<Blob, z.ZodTypeDef, Blob>>;
     activeBody: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"raw">, z.ZodLiteral<"formData">, z.ZodLiteral<"binary">]>>;
 }, "strip", z.ZodTypeAny, {
-    activeBody: "binary" | "formData" | "raw";
-    binary?: Blob | undefined;
+    activeBody: "formData" | "binary" | "raw";
     formData?: {
         value: {
             value: string;
@@ -299,49 +298,50 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }[];
         encoding: "form-data" | "urlencoded";
     } | undefined;
+    binary?: Blob | undefined;
     raw?: {
         value: string;
         encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
         mimeType?: string | undefined;
     } | undefined;
 }, {
-    binary?: Blob | undefined;
     formData?: {
         value?: {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }[] | undefined;
         encoding?: "form-data" | "urlencoded" | undefined;
     } | undefined;
+    binary?: Blob | undefined;
     raw?: {
         encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
         value?: string | undefined;
         mimeType?: string | undefined;
     } | undefined;
-    activeBody?: "binary" | "formData" | "raw" | undefined;
+    activeBody?: "formData" | "binary" | "raw" | undefined;
 }>;
 export type ExampleRequestBody = z.infer<typeof exampleRequestBodySchema>;
 /** Schema for the OAS serialization of request example bodies */
@@ -366,14 +366,14 @@ export declare const xScalarExampleBodySchema: z.ZodObject<{
     }>>>;
 }, "strip", z.ZodTypeAny, {
     content: string | Record<string, any>;
-    encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+    encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
     file?: {
         url: string;
         base64?: string | undefined;
     } | null | undefined;
 }, {
     content: string | Record<string, any>;
-    encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+    encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
     file?: {
         url: string;
         base64?: string | undefined;
@@ -423,28 +423,28 @@ export declare const requestExampleSchema: z.ZodObject<{
                 minimum?: number | undefined;
                 type?: string | string[] | undefined;
                 maximum?: number | undefined;
+                description?: string | undefined;
                 default?: any;
                 required?: boolean | undefined;
-                description?: string | undefined;
-                enum?: string[] | undefined;
                 examples?: string[] | undefined;
                 format?: string | undefined;
+                enum?: string[] | undefined;
                 file?: any;
                 nullable?: boolean | undefined;
             }, {
+                value?: string | undefined;
                 minimum?: number | undefined;
                 type?: string | string[] | undefined;
                 maximum?: number | undefined;
-                value?: string | undefined;
+                description?: string | undefined;
                 default?: any;
                 required?: boolean | undefined;
-                description?: string | undefined;
-                enum?: string[] | undefined;
                 examples?: string[] | undefined;
                 format?: string | undefined;
-                file?: any;
+                enum?: string[] | undefined;
                 key?: string | undefined;
                 enabled?: boolean | undefined;
+                file?: any;
                 nullable?: boolean | undefined;
             }>, {
                 value: string;
@@ -453,28 +453,28 @@ export declare const requestExampleSchema: z.ZodObject<{
                 minimum?: number | undefined;
                 type?: string | string[] | undefined;
                 maximum?: number | undefined;
+                description?: string | undefined;
                 default?: any;
                 required?: boolean | undefined;
-                description?: string | undefined;
-                enum?: string[] | undefined;
                 examples?: string[] | undefined;
                 format?: string | undefined;
+                enum?: string[] | undefined;
                 file?: any;
                 nullable?: boolean | undefined;
             }, {
+                value?: string | undefined;
                 minimum?: number | undefined;
                 type?: string | string[] | undefined;
                 maximum?: number | undefined;
-                value?: string | undefined;
+                description?: string | undefined;
                 default?: any;
                 required?: boolean | undefined;
-                description?: string | undefined;
-                enum?: string[] | undefined;
                 examples?: string[] | undefined;
                 format?: string | undefined;
-                file?: any;
+                enum?: string[] | undefined;
                 key?: string | undefined;
                 enabled?: boolean | undefined;
+                file?: any;
                 nullable?: boolean | undefined;
             }>, "many">>;
         }, "strip", z.ZodTypeAny, {
@@ -485,31 +485,31 @@ export declare const requestExampleSchema: z.ZodObject<{
                 minimum?: number | undefined;
                 type?: string | string[] | undefined;
                 maximum?: number | undefined;
+                description?: string | undefined;
                 default?: any;
                 required?: boolean | undefined;
-                description?: string | undefined;
-                enum?: string[] | undefined;
                 examples?: string[] | undefined;
                 format?: string | undefined;
+                enum?: string[] | undefined;
                 file?: any;
                 nullable?: boolean | undefined;
             }[];
             encoding: "form-data" | "urlencoded";
         }, {
             value?: {
+                value?: string | undefined;
                 minimum?: number | undefined;
                 type?: string | string[] | undefined;
                 maximum?: number | undefined;
-                value?: string | undefined;
+                description?: string | undefined;
                 default?: any;
                 required?: boolean | undefined;
-                description?: string | undefined;
-                enum?: string[] | undefined;
                 examples?: string[] | undefined;
                 format?: string | undefined;
-                file?: any;
+                enum?: string[] | undefined;
                 key?: string | undefined;
                 enabled?: boolean | undefined;
+                file?: any;
                 nullable?: boolean | undefined;
             }[] | undefined;
             encoding?: "form-data" | "urlencoded" | undefined;
@@ -517,8 +517,7 @@ export declare const requestExampleSchema: z.ZodObject<{
         binary: z.ZodOptional<z.ZodType<Blob, z.ZodTypeDef, Blob>>;
         activeBody: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"raw">, z.ZodLiteral<"formData">, z.ZodLiteral<"binary">]>>;
     }, "strip", z.ZodTypeAny, {
-        activeBody: "binary" | "formData" | "raw";
-        binary?: Blob | undefined;
+        activeBody: "formData" | "binary" | "raw";
         formData?: {
             value: {
                 value: string;
@@ -527,49 +526,50 @@ export declare const requestExampleSchema: z.ZodObject<{
                 minimum?: number | undefined;
                 type?: string | string[] | undefined;
                 maximum?: number | undefined;
+                description?: string | undefined;
                 default?: any;
                 required?: boolean | undefined;
-                description?: string | undefined;
-                enum?: string[] | undefined;
                 examples?: string[] | undefined;
                 format?: string | undefined;
+                enum?: string[] | undefined;
                 file?: any;
                 nullable?: boolean | undefined;
             }[];
             encoding: "form-data" | "urlencoded";
         } | undefined;
+        binary?: Blob | undefined;
         raw?: {
             value: string;
             encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
             mimeType?: string | undefined;
         } | undefined;
     }, {
-        binary?: Blob | undefined;
         formData?: {
             value?: {
+                value?: string | undefined;
                 minimum?: number | undefined;
                 type?: string | string[] | undefined;
                 maximum?: number | undefined;
-                value?: string | undefined;
+                description?: string | undefined;
                 default?: any;
                 required?: boolean | undefined;
-                description?: string | undefined;
-                enum?: string[] | undefined;
                 examples?: string[] | undefined;
                 format?: string | undefined;
-                file?: any;
+                enum?: string[] | undefined;
                 key?: string | undefined;
                 enabled?: boolean | undefined;
+                file?: any;
                 nullable?: boolean | undefined;
             }[] | undefined;
             encoding?: "form-data" | "urlencoded" | undefined;
         } | undefined;
+        binary?: Blob | undefined;
         raw?: {
             encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
             value?: string | undefined;
             mimeType?: string | undefined;
         } | undefined;
-        activeBody?: "binary" | "formData" | "raw" | undefined;
+        activeBody?: "formData" | "binary" | "raw" | undefined;
     }>>>;
     parameters: z.ZodDefault<z.ZodOptional<z.ZodObject<{
         path: z.ZodDefault<z.ZodArray<z.ZodEffects<z.ZodObject<{
@@ -594,28 +594,28 @@ export declare const requestExampleSchema: z.ZodObject<{
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }, {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }>, {
             value: string;
@@ -624,28 +624,28 @@ export declare const requestExampleSchema: z.ZodObject<{
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }, {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }>, "many">>;
         query: z.ZodDefault<z.ZodArray<z.ZodEffects<z.ZodObject<{
@@ -670,28 +670,28 @@ export declare const requestExampleSchema: z.ZodObject<{
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }, {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }>, {
             value: string;
@@ -700,28 +700,28 @@ export declare const requestExampleSchema: z.ZodObject<{
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }, {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }>, "many">>;
         headers: z.ZodDefault<z.ZodArray<z.ZodEffects<z.ZodObject<{
@@ -746,28 +746,28 @@ export declare const requestExampleSchema: z.ZodObject<{
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }, {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }>, {
             value: string;
@@ -776,28 +776,28 @@ export declare const requestExampleSchema: z.ZodObject<{
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }, {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }>, "many">>;
         cookies: z.ZodDefault<z.ZodArray<z.ZodEffects<z.ZodObject<{
@@ -822,28 +822,28 @@ export declare const requestExampleSchema: z.ZodObject<{
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }, {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }>, {
             value: string;
@@ -852,28 +852,28 @@ export declare const requestExampleSchema: z.ZodObject<{
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }, {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }>, "many">>;
     }, "strip", z.ZodTypeAny, {
@@ -884,135 +884,163 @@ export declare const requestExampleSchema: z.ZodObject<{
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }[];
-        cookies: {
+        query: {
             value: string;
             key: string;
             enabled: boolean;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }[];
-        query: {
+        headers: {
             value: string;
             key: string;
             enabled: boolean;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }[];
-        headers: {
+        cookies: {
             value: string;
             key: string;
             enabled: boolean;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }[];
     }, {
         path?: {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }[] | undefined;
-        cookies?: {
+        query?: {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }[] | undefined;
-        query?: {
+        headers?: {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }[] | undefined;
-        headers?: {
+        cookies?: {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }[] | undefined;
     }>>>;
     /** TODO: Should this be deprecated? */
     serverVariables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "many">>>;
 }, "strip", z.ZodTypeAny, {
-    type: "requestExample";
     uid: string & z.BRAND<"example">;
     name: string;
+    type: "requestExample";
+    body: {
+        activeBody: "formData" | "binary" | "raw";
+        formData?: {
+            value: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | string[] | undefined;
+                maximum?: number | undefined;
+                description?: string | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                examples?: string[] | undefined;
+                format?: string | undefined;
+                enum?: string[] | undefined;
+                file?: any;
+                nullable?: boolean | undefined;
+            }[];
+            encoding: "form-data" | "urlencoded";
+        } | undefined;
+        binary?: Blob | undefined;
+        raw?: {
+            value: string;
+            encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
+            mimeType?: string | undefined;
+        } | undefined;
+    };
     parameters: {
         path: {
             value: string;
@@ -1021,193 +1049,165 @@ export declare const requestExampleSchema: z.ZodObject<{
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }[];
-        cookies: {
+        query: {
             value: string;
             key: string;
             enabled: boolean;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }[];
-        query: {
+        headers: {
             value: string;
             key: string;
             enabled: boolean;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }[];
-        headers: {
+        cookies: {
             value: string;
             key: string;
             enabled: boolean;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
+            enum?: string[] | undefined;
             file?: any;
             nullable?: boolean | undefined;
         }[];
     };
-    body: {
-        activeBody: "binary" | "formData" | "raw";
-        binary?: Blob | undefined;
+    requestUid?: (string & z.BRAND<"operation">) | undefined;
+    serverVariables?: Record<string, string[]> | undefined;
+}, {
+    uid?: string | undefined;
+    name?: string | undefined;
+    type?: "requestExample" | undefined;
+    body?: {
         formData?: {
-            value: {
-                value: string;
-                key: string;
-                enabled: boolean;
+            value?: {
+                value?: string | undefined;
                 minimum?: number | undefined;
                 type?: string | string[] | undefined;
                 maximum?: number | undefined;
+                description?: string | undefined;
                 default?: any;
                 required?: boolean | undefined;
-                description?: string | undefined;
-                enum?: string[] | undefined;
                 examples?: string[] | undefined;
                 format?: string | undefined;
+                enum?: string[] | undefined;
+                key?: string | undefined;
+                enabled?: boolean | undefined;
                 file?: any;
                 nullable?: boolean | undefined;
-            }[];
-            encoding: "form-data" | "urlencoded";
+            }[] | undefined;
+            encoding?: "form-data" | "urlencoded" | undefined;
         } | undefined;
+        binary?: Blob | undefined;
         raw?: {
-            value: string;
             encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
+            value?: string | undefined;
             mimeType?: string | undefined;
         } | undefined;
-    };
-    requestUid?: (string & z.BRAND<"operation">) | undefined;
-    serverVariables?: Record<string, string[]> | undefined;
-}, {
-    type?: "requestExample" | undefined;
-    uid?: string | undefined;
-    name?: string | undefined;
+        activeBody?: "formData" | "binary" | "raw" | undefined;
+    } | undefined;
+    requestUid?: string | undefined;
     parameters?: {
         path?: {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }[] | undefined;
-        cookies?: {
+        query?: {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }[] | undefined;
-        query?: {
+        headers?: {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }[] | undefined;
-        headers?: {
+        cookies?: {
+            value?: string | undefined;
             minimum?: number | undefined;
             type?: string | string[] | undefined;
             maximum?: number | undefined;
-            value?: string | undefined;
+            description?: string | undefined;
             default?: any;
             required?: boolean | undefined;
-            description?: string | undefined;
-            enum?: string[] | undefined;
             examples?: string[] | undefined;
             format?: string | undefined;
-            file?: any;
+            enum?: string[] | undefined;
             key?: string | undefined;
             enabled?: boolean | undefined;
+            file?: any;
             nullable?: boolean | undefined;
         }[] | undefined;
     } | undefined;
-    body?: {
-        binary?: Blob | undefined;
-        formData?: {
-            value?: {
-                minimum?: number | undefined;
-                type?: string | string[] | undefined;
-                maximum?: number | undefined;
-                value?: string | undefined;
-                default?: any;
-                required?: boolean | undefined;
-                description?: string | undefined;
-                enum?: string[] | undefined;
-                examples?: string[] | undefined;
-                format?: string | undefined;
-                file?: any;
-                key?: string | undefined;
-                enabled?: boolean | undefined;
-                nullable?: boolean | undefined;
-            }[] | undefined;
-            encoding?: "form-data" | "urlencoded" | undefined;
-        } | undefined;
-        raw?: {
-            encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
-            value?: string | undefined;
-            mimeType?: string | undefined;
-        } | undefined;
-        activeBody?: "binary" | "formData" | "raw" | undefined;
-    } | undefined;
-    requestUid?: string | undefined;
     serverVariables?: Record<string, string[]> | undefined;
 }>;
 export type RequestExample = z.infer<typeof requestExampleSchema>;
@@ -1236,14 +1236,14 @@ export declare const xScalarExampleSchema: z.ZodObject<{
         }>>>;
     }, "strip", z.ZodTypeAny, {
         content: string | Record<string, any>;
-        encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+        encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
         file?: {
             url: string;
             base64?: string | undefined;
         } | null | undefined;
     }, {
         content: string | Record<string, any>;
-        encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+        encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
         file?: {
             url: string;
             base64?: string | undefined;
@@ -1256,26 +1256,26 @@ export declare const xScalarExampleSchema: z.ZodObject<{
         cookies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
         path?: Record<string, string> | undefined;
-        cookies?: Record<string, string> | undefined;
         query?: Record<string, string> | undefined;
         headers?: Record<string, string> | undefined;
+        cookies?: Record<string, string> | undefined;
     }, {
         path?: Record<string, string> | undefined;
-        cookies?: Record<string, string> | undefined;
         query?: Record<string, string> | undefined;
         headers?: Record<string, string> | undefined;
+        cookies?: Record<string, string> | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
     parameters: {
         path?: Record<string, string> | undefined;
-        cookies?: Record<string, string> | undefined;
         query?: Record<string, string> | undefined;
         headers?: Record<string, string> | undefined;
+        cookies?: Record<string, string> | undefined;
     };
     name?: string | undefined;
     body?: {
         content: string | Record<string, any>;
-        encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+        encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
         file?: {
             url: string;
             base64?: string | undefined;
@@ -1284,14 +1284,14 @@ export declare const xScalarExampleSchema: z.ZodObject<{
 }, {
     parameters: {
         path?: Record<string, string> | undefined;
-        cookies?: Record<string, string> | undefined;
         query?: Record<string, string> | undefined;
         headers?: Record<string, string> | undefined;
+        cookies?: Record<string, string> | undefined;
     };
     name?: string | undefined;
     body?: {
         content: string | Record<string, any>;
-        encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+        encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
         file?: {
             url: string;
             base64?: string | undefined;
@@ -1307,14 +1307,14 @@ export type XScalarExample = z.infer<typeof xScalarExampleSchema>;
 export declare function convertExampleToXScalar(example: RequestExample): {
     parameters: {
         path?: Record<string, string> | undefined;
-        cookies?: Record<string, string> | undefined;
         query?: Record<string, string> | undefined;
         headers?: Record<string, string> | undefined;
+        cookies?: Record<string, string> | undefined;
     };
     name?: string | undefined;
     body?: {
         content: string | Record<string, any>;
-        encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+        encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
         file?: {
             url: string;
             base64?: string | undefined;
@@ -1329,12 +1329,12 @@ export declare function createParamInstance(param: RequestParameter): {
     minimum?: number | undefined;
     type?: string | string[] | undefined;
     maximum?: number | undefined;
+    description?: string | undefined;
     default?: any;
     required?: boolean | undefined;
-    description?: string | undefined;
-    enum?: string[] | undefined;
     examples?: string[] | undefined;
     format?: string | undefined;
+    enum?: string[] | undefined;
     file?: any;
     nullable?: boolean | undefined;
 };