@scalar/oas-utils 0.2.74 → 0.2.76

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

@@ -2,14 +2,18 @@ import { z } from 'zod';
 import type { RequestParameter } from './parameters.js';
 import type { Request } from './requests.js';
 import type { Server } from './server.js';
+/**
+ * TODO: Deprecate this.
+ *
+ * The request schema should be stored in the request and any
+ * parameters should be validated against that
+ */
 export declare const requestExampleParametersSchema: z.ZodObject<{
     key: z.ZodDefault<z.ZodString>;
     value: z.ZodDefault<z.ZodString>;
     enabled: z.ZodDefault<z.ZodBoolean>;
     file: z.ZodOptional<z.ZodAny>;
     description: z.ZodOptional<z.ZodString>;
-    /** Params are linked to parents such as path params and global headers/cookies */
-    refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
     required: z.ZodOptional<z.ZodBoolean>;
     enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     type: z.ZodOptional<z.ZodString>;
@@ -31,7 +35,6 @@ export declare const requestExampleParametersSchema: z.ZodObject<{
     enum?: string[] | undefined;
     format?: string | undefined;
     file?: any;
-    refUid?: string | undefined;
     nullable?: boolean | undefined;
 }, {
     minimum?: number | undefined;
@@ -46,11 +49,65 @@ export declare const requestExampleParametersSchema: z.ZodObject<{
     key?: string | undefined;
     enabled?: boolean | undefined;
     file?: any;
-    refUid?: string | undefined;
     nullable?: boolean | undefined;
 }>;
 /** Request examples - formerly known as instances - are "children" of requests */
 export type RequestExampleParameter = z.infer<typeof requestExampleParametersSchema>;
+export declare const xScalarFileValueSchema: z.ZodNullable<z.ZodObject<{
+    url: z.ZodString;
+    base64: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    url: string;
+    base64?: string | undefined;
+}, {
+    url: string;
+    base64?: string | undefined;
+}>>;
+/**
+ * When files are required for an example we provide the options
+ * to provide a public URL or a base64 encoded string
+ */
+export type XScalarFileValue = z.infer<typeof xScalarFileValueSchema>;
+/**
+ * Schema for the OAS serialization of request example parameters
+ *
+ * File values can be optionally fetched on import OR inserted as a base64 encoded string
+ */
+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;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"file">;
+    file: z.ZodNullable<z.ZodObject<{
+        url: z.ZodString;
+        base64: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        base64?: string | undefined;
+    }, {
+        url: string;
+        base64?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    type: "file";
+    file: {
+        url: string;
+        base64?: string | undefined;
+    } | null;
+}, {
+    type: "file";
+    file: {
+        url: string;
+        base64?: string | undefined;
+    } | null;
+}>]>;
+export type XScalarFormDataValue = z.infer<typeof xScalarFormDataValue>;
 /**
  * Possible encodings for example request bodies when using text formats
  *
@@ -58,6 +115,13 @@ export type RequestExampleParameter = z.infer<typeof requestExampleParametersSch
  */
 export declare const exampleRequestBodyEncoding: readonly ["json", "text", "html", "javascript", "xml", "yaml", "edn"];
 export type BodyEncoding = (typeof exampleRequestBodyEncoding)[number];
+export declare const exampleBodyMime: readonly ["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"];
+export type BodyMime = (typeof exampleBodyMime)[number];
+/**
+ * TODO: Migrate away from this layout to the format used in the extension
+ *
+ * If a user changes the encoding of the body we expect the content to change as well
+ */
 export declare const exampleRequestBodySchema: z.ZodObject<{
     raw: z.ZodOptional<z.ZodObject<{
         encoding: z.ZodDefault<z.ZodEnum<["json", "text", "html", "javascript", "xml", "yaml", "edn"]>>;
@@ -77,8 +141,6 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
             enabled: z.ZodDefault<z.ZodBoolean>;
             file: z.ZodOptional<z.ZodAny>;
             description: z.ZodOptional<z.ZodString>;
-            /** Params are linked to parents such as path params and global headers/cookies */
-            refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
             required: z.ZodOptional<z.ZodBoolean>;
             enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
             type: z.ZodOptional<z.ZodString>;
@@ -100,7 +162,6 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
             enum?: string[] | undefined;
             format?: string | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }, {
             minimum?: number | undefined;
@@ -115,7 +176,6 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
             key?: string | undefined;
             enabled?: boolean | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }>, "many">>;
     }, "strip", z.ZodTypeAny, {
@@ -132,7 +192,6 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
             enum?: string[] | undefined;
             format?: string | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[];
         encoding: "form-data" | "urlencoded";
@@ -150,7 +209,6 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
             key?: string | undefined;
             enabled?: boolean | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[] | undefined;
         encoding?: "form-data" | "urlencoded" | undefined;
@@ -158,7 +216,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: "formData" | "raw" | "binary";
+    activeBody: "formData" | "binary" | "raw";
     formData?: {
         value: {
             value: string;
@@ -173,16 +231,15 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
             enum?: string[] | undefined;
             format?: string | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[];
         encoding: "form-data" | "urlencoded";
     } | undefined;
+    binary?: Blob | undefined;
     raw?: {
         value: string;
         encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
     } | undefined;
-    binary?: Blob | undefined;
 }, {
     formData?: {
         value?: {
@@ -198,22 +255,57 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
             key?: string | undefined;
             enabled?: boolean | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[] | undefined;
         encoding?: "form-data" | "urlencoded" | undefined;
     } | undefined;
+    binary?: Blob | undefined;
     raw?: {
         value?: string | undefined;
         encoding?: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn" | undefined;
     } | undefined;
-    binary?: Blob | undefined;
-    activeBody?: "formData" | "raw" | "binary" | undefined;
+    activeBody?: "formData" | "binary" | "raw" | undefined;
 }>;
 export type ExampleRequestBody = z.infer<typeof exampleRequestBodySchema>;
+/** Schema for the OAS serialization of request example bodies */
+export declare const xScalarExampleBodySchema: z.ZodObject<{
+    encoding: z.ZodDefault<z.ZodEnum<["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"]>>;
+    /**
+     * Body content as an object with a separately specified encoding or a simple pre-encoded string value
+     *
+     * Ideally we would convert any objects into the proper encoding on import
+     */
+    content: z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodString]>;
+    /** When the encoding is `binary` this will be used to link to the file */
+    file: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        url: z.ZodString;
+        base64: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        base64?: string | undefined;
+    }, {
+        url: string;
+        base64?: string | undefined;
+    }>>>;
+}, "strip", z.ZodTypeAny, {
+    content: string | Record<string, any>;
+    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>;
+    file?: {
+        url: string;
+        base64?: string | undefined;
+    } | null | undefined;
+    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" | undefined;
+}>;
+export type XScalarExampleBody = z.infer<typeof xScalarExampleBodySchema>;
 export declare const requestExampleSchema: z.ZodObject<{
-    type: z.ZodDefault<z.ZodOptional<z.ZodLiteral<"requestExample">>>;
     uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    type: z.ZodDefault<z.ZodOptional<z.ZodLiteral<"requestExample">>>;
     requestUid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     name: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     body: z.ZodDefault<z.ZodOptional<z.ZodObject<{
@@ -235,8 +327,6 @@ export declare const requestExampleSchema: z.ZodObject<{
                 enabled: z.ZodDefault<z.ZodBoolean>;
                 file: z.ZodOptional<z.ZodAny>;
                 description: z.ZodOptional<z.ZodString>;
-                /** Params are linked to parents such as path params and global headers/cookies */
-                refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
                 required: z.ZodOptional<z.ZodBoolean>;
                 enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
                 type: z.ZodOptional<z.ZodString>;
@@ -258,7 +348,6 @@ export declare const requestExampleSchema: z.ZodObject<{
                 enum?: string[] | undefined;
                 format?: string | undefined;
                 file?: any;
-                refUid?: string | undefined;
                 nullable?: boolean | undefined;
             }, {
                 minimum?: number | undefined;
@@ -273,7 +362,6 @@ export declare const requestExampleSchema: z.ZodObject<{
                 key?: string | undefined;
                 enabled?: boolean | undefined;
                 file?: any;
-                refUid?: string | undefined;
                 nullable?: boolean | undefined;
             }>, "many">>;
         }, "strip", z.ZodTypeAny, {
@@ -290,7 +378,6 @@ export declare const requestExampleSchema: z.ZodObject<{
                 enum?: string[] | undefined;
                 format?: string | undefined;
                 file?: any;
-                refUid?: string | undefined;
                 nullable?: boolean | undefined;
             }[];
             encoding: "form-data" | "urlencoded";
@@ -308,7 +395,6 @@ export declare const requestExampleSchema: z.ZodObject<{
                 key?: string | undefined;
                 enabled?: boolean | undefined;
                 file?: any;
-                refUid?: string | undefined;
                 nullable?: boolean | undefined;
             }[] | undefined;
             encoding?: "form-data" | "urlencoded" | undefined;
@@ -316,7 +402,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: "formData" | "raw" | "binary";
+        activeBody: "formData" | "binary" | "raw";
         formData?: {
             value: {
                 value: string;
@@ -331,16 +417,15 @@ export declare const requestExampleSchema: z.ZodObject<{
                 enum?: string[] | undefined;
                 format?: string | undefined;
                 file?: any;
-                refUid?: string | undefined;
                 nullable?: boolean | undefined;
             }[];
             encoding: "form-data" | "urlencoded";
         } | undefined;
+        binary?: Blob | undefined;
         raw?: {
             value: string;
             encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
         } | undefined;
-        binary?: Blob | undefined;
     }, {
         formData?: {
             value?: {
@@ -356,17 +441,16 @@ export declare const requestExampleSchema: z.ZodObject<{
                 key?: string | undefined;
                 enabled?: boolean | undefined;
                 file?: any;
-                refUid?: string | undefined;
                 nullable?: boolean | undefined;
             }[] | undefined;
             encoding?: "form-data" | "urlencoded" | undefined;
         } | undefined;
+        binary?: Blob | undefined;
         raw?: {
             value?: string | undefined;
             encoding?: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn" | undefined;
         } | undefined;
-        binary?: Blob | undefined;
-        activeBody?: "formData" | "raw" | "binary" | undefined;
+        activeBody?: "formData" | "binary" | "raw" | undefined;
     }>>>;
     parameters: z.ZodDefault<z.ZodOptional<z.ZodObject<{
         path: z.ZodDefault<z.ZodArray<z.ZodObject<{
@@ -375,8 +459,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             enabled: z.ZodDefault<z.ZodBoolean>;
             file: z.ZodOptional<z.ZodAny>;
             description: z.ZodOptional<z.ZodString>;
-            /** Params are linked to parents such as path params and global headers/cookies */
-            refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
             required: z.ZodOptional<z.ZodBoolean>;
             enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
             type: z.ZodOptional<z.ZodString>;
@@ -398,7 +480,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             enum?: string[] | undefined;
             format?: string | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }, {
             minimum?: number | undefined;
@@ -413,7 +494,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             key?: string | undefined;
             enabled?: boolean | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }>, "many">>;
         query: z.ZodDefault<z.ZodArray<z.ZodObject<{
@@ -422,8 +502,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             enabled: z.ZodDefault<z.ZodBoolean>;
             file: z.ZodOptional<z.ZodAny>;
             description: z.ZodOptional<z.ZodString>;
-            /** Params are linked to parents such as path params and global headers/cookies */
-            refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
             required: z.ZodOptional<z.ZodBoolean>;
             enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
             type: z.ZodOptional<z.ZodString>;
@@ -445,7 +523,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             enum?: string[] | undefined;
             format?: string | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }, {
             minimum?: number | undefined;
@@ -460,7 +537,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             key?: string | undefined;
             enabled?: boolean | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }>, "many">>;
         headers: z.ZodDefault<z.ZodArray<z.ZodObject<{
@@ -469,8 +545,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             enabled: z.ZodDefault<z.ZodBoolean>;
             file: z.ZodOptional<z.ZodAny>;
             description: z.ZodOptional<z.ZodString>;
-            /** Params are linked to parents such as path params and global headers/cookies */
-            refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
             required: z.ZodOptional<z.ZodBoolean>;
             enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
             type: z.ZodOptional<z.ZodString>;
@@ -492,7 +566,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             enum?: string[] | undefined;
             format?: string | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }, {
             minimum?: number | undefined;
@@ -507,7 +580,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             key?: string | undefined;
             enabled?: boolean | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }>, "many">>;
         cookies: z.ZodDefault<z.ZodArray<z.ZodObject<{
@@ -516,8 +588,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             enabled: z.ZodDefault<z.ZodBoolean>;
             file: z.ZodOptional<z.ZodAny>;
             description: z.ZodOptional<z.ZodString>;
-            /** Params are linked to parents such as path params and global headers/cookies */
-            refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
             required: z.ZodOptional<z.ZodBoolean>;
             enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
             type: z.ZodOptional<z.ZodString>;
@@ -539,7 +609,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             enum?: string[] | undefined;
             format?: string | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }, {
             minimum?: number | undefined;
@@ -554,7 +623,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             key?: string | undefined;
             enabled?: boolean | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }>, "many">>;
     }, "strip", z.ZodTypeAny, {
@@ -571,7 +639,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             enum?: string[] | undefined;
             format?: string | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[];
         cookies: {
@@ -587,7 +654,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             enum?: string[] | undefined;
             format?: string | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[];
         query: {
@@ -603,7 +669,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             enum?: string[] | undefined;
             format?: string | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[];
         headers: {
@@ -619,7 +684,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             enum?: string[] | undefined;
             format?: string | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[];
     }, {
@@ -636,7 +700,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             key?: string | undefined;
             enabled?: boolean | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[] | undefined;
         cookies?: {
@@ -652,7 +715,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             key?: string | undefined;
             enabled?: boolean | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[] | undefined;
         query?: {
@@ -668,7 +730,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             key?: string | undefined;
             enabled?: boolean | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[] | undefined;
         headers?: {
@@ -684,17 +745,17 @@ export declare const requestExampleSchema: z.ZodObject<{
             key?: string | undefined;
             enabled?: boolean | undefined;
             file?: any;
-            refUid?: string | undefined;
             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;
     name: string;
     body: {
-        activeBody: "formData" | "raw" | "binary";
+        activeBody: "formData" | "binary" | "raw";
         formData?: {
             value: {
                 value: string;
@@ -709,16 +770,15 @@ export declare const requestExampleSchema: z.ZodObject<{
                 enum?: string[] | undefined;
                 format?: string | undefined;
                 file?: any;
-                refUid?: string | undefined;
                 nullable?: boolean | undefined;
             }[];
             encoding: "form-data" | "urlencoded";
         } | undefined;
+        binary?: Blob | undefined;
         raw?: {
             value: string;
             encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
         } | undefined;
-        binary?: Blob | undefined;
     };
     requestUid: string;
     parameters: {
@@ -735,7 +795,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             enum?: string[] | undefined;
             format?: string | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[];
         cookies: {
@@ -751,7 +810,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             enum?: string[] | undefined;
             format?: string | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[];
         query: {
@@ -767,7 +825,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             enum?: string[] | undefined;
             format?: string | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[];
         headers: {
@@ -783,7 +840,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             enum?: string[] | undefined;
             format?: string | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[];
     };
@@ -807,17 +863,16 @@ export declare const requestExampleSchema: z.ZodObject<{
                 key?: string | undefined;
                 enabled?: boolean | undefined;
                 file?: any;
-                refUid?: string | undefined;
                 nullable?: boolean | undefined;
             }[] | undefined;
             encoding?: "form-data" | "urlencoded" | undefined;
         } | undefined;
+        binary?: Blob | undefined;
         raw?: {
             value?: string | undefined;
             encoding?: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn" | undefined;
         } | undefined;
-        binary?: Blob | undefined;
-        activeBody?: "formData" | "raw" | "binary" | undefined;
+        activeBody?: "formData" | "binary" | "raw" | undefined;
     } | undefined;
     requestUid?: string | undefined;
     parameters?: {
@@ -834,7 +889,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             key?: string | undefined;
             enabled?: boolean | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[] | undefined;
         cookies?: {
@@ -850,7 +904,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             key?: string | undefined;
             enabled?: boolean | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[] | undefined;
         query?: {
@@ -866,7 +919,6 @@ export declare const requestExampleSchema: z.ZodObject<{
             key?: string | undefined;
             enabled?: boolean | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[] | undefined;
         headers?: {
@@ -882,15 +934,122 @@ export declare const requestExampleSchema: z.ZodObject<{
             key?: string | undefined;
             enabled?: boolean | undefined;
             file?: any;
-            refUid?: string | undefined;
             nullable?: boolean | undefined;
         }[] | undefined;
     } | undefined;
     serverVariables?: Record<string, string[]> | undefined;
 }>;
-/** A single set 23of params for a request example */
 export type RequestExample = z.infer<typeof requestExampleSchema>;
-export type RequestExamplePayload = z.input<typeof requestExampleSchema>;
+/** Schema for the OAS serialization of request examples */
+export declare const xScalarExampleSchema: z.ZodObject<{
+    /** TODO: Should this be required? */
+    name: z.ZodOptional<z.ZodString>;
+    body: z.ZodOptional<z.ZodObject<{
+        encoding: z.ZodDefault<z.ZodEnum<["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"]>>;
+        /**
+         * Body content as an object with a separately specified encoding or a simple pre-encoded string value
+         *
+         * Ideally we would convert any objects into the proper encoding on import
+         */
+        content: z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodString]>;
+        /** When the encoding is `binary` this will be used to link to the file */
+        file: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            url: z.ZodString;
+            base64: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            url: string;
+            base64?: string | undefined;
+        }, {
+            url: string;
+            base64?: string | undefined;
+        }>>>;
+    }, "strip", z.ZodTypeAny, {
+        content: string | Record<string, any>;
+        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>;
+        file?: {
+            url: string;
+            base64?: string | undefined;
+        } | null | undefined;
+        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" | undefined;
+    }>>;
+    parameters: z.ZodObject<{
+        path: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        query: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        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;
+    }, {
+        path?: Record<string, string> | undefined;
+        cookies?: Record<string, string> | undefined;
+        query?: Record<string, string> | undefined;
+        headers?: 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;
+    };
+    name?: string | undefined;
+    body?: {
+        content: string | Record<string, any>;
+        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;
+    } | undefined;
+}, {
+    parameters: {
+        path?: Record<string, string> | undefined;
+        cookies?: Record<string, string> | undefined;
+        query?: Record<string, string> | undefined;
+        headers?: Record<string, string> | undefined;
+    };
+    name?: string | undefined;
+    body?: {
+        content: string | Record<string, any>;
+        file?: {
+            url: string;
+            base64?: string | undefined;
+        } | null | undefined;
+        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" | undefined;
+    } | undefined;
+}>;
+export type XScalarExample = z.infer<typeof xScalarExampleSchema>;
+/**
+ * Convert a request example to the xScalar serialized format
+ *
+ * TODO: The base format should be migrated to align MUCH closer to the serialized format
+ */
+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;
+    };
+    name?: string | undefined;
+    body?: {
+        content: string | Record<string, any>;
+        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;
+    } | undefined;
+};
 /** Create new instance parameter from a request parameter */
 export declare function createParamInstance(param: RequestParameter): {
     value: string;
@@ -905,7 +1064,6 @@ export declare function createParamInstance(param: RequestParameter): {
     enum?: string[] | undefined;
     format?: string | undefined;
     file?: any;
-    refUid?: string | undefined;
     nullable?: boolean | undefined;
 };
 /**