UNPKG

@scalar/openapi-types

Version:
728 lines 31.9 kB
import { z } from 'zod'; /** * Media Type Object * * Each Media Type Object provides schema and examples for the media type identified by its key. * * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#media-type-object */ export declare const MediaTypeObjectSchema: z.ZodObject<z.objectUtil.extendShape<{ schema: z.ZodOptional<z.ZodType<Record<string, any>, z.ZodTypeDef, Record<string, any>>>; example: z.ZodOptional<z.ZodAny>; examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{ summary: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; value: z.ZodOptional<z.ZodAny>; externalValue: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }>>>; encoding: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{ contentType: z.ZodString; headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{ description: z.ZodOptional<z.ZodString>; required: z.ZodOptional<z.ZodBoolean>; deprecated: z.ZodOptional<z.ZodBoolean>; style: z.ZodOptional<z.ZodEnum<["matrix", "label", "simple", "form", "spaceDelimited", "pipeDelimited", "deepObject"]>>; explode: z.ZodOptional<z.ZodBoolean>; schema: z.ZodOptional<z.ZodType<Record<string, any>, z.ZodTypeDef, Record<string, any>>>; example: z.ZodOptional<z.ZodAny>; examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{ summary: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; value: z.ZodOptional<z.ZodAny>; externalValue: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }>>>; content: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{ schema: z.ZodOptional<z.ZodType<Record<string, any>, z.ZodTypeDef, Record<string, any>>>; example: z.ZodOptional<z.ZodAny>; examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{ summary: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; value: z.ZodOptional<z.ZodAny>; externalValue: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }>>>; }, "strip", z.ZodTypeAny, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }>>>; }, "strip", z.ZodTypeAny, { description?: string | undefined; deprecated?: boolean | undefined; content?: Record<string, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }> | undefined; required?: boolean | undefined; example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; style?: "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined; explode?: boolean | undefined; }, { description?: string | undefined; deprecated?: boolean | undefined; content?: Record<string, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }> | undefined; required?: boolean | undefined; example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; style?: "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined; explode?: boolean | undefined; }>>>; }, "strip", z.ZodTypeAny, { contentType: string; headers?: Record<string, { description?: string | undefined; deprecated?: boolean | undefined; content?: Record<string, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }> | undefined; required?: boolean | undefined; example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; style?: "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined; explode?: boolean | undefined; }> | undefined; }, { contentType: string; headers?: Record<string, { description?: string | undefined; deprecated?: boolean | undefined; content?: Record<string, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }> | undefined; required?: boolean | undefined; example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; style?: "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined; explode?: boolean | undefined; }> | undefined; }>>>; }, { /** * The schema defining the content of the request, response, or parameter. */ schema: z.ZodOptional<z.ZodType<any, z.ZodTypeDef, any>>; /** * Example of the media type. The example object SHOULD be in the correct format as specified by the media type. * The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains * an example, the example value SHALL override the example provided by the schema. */ example: z.ZodOptional<z.ZodAny>; /** * Examples of the media type. Each example object SHOULD match the media type and specified schema if present. * The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains * an example, the examples value SHALL override the example provided by the schema. */ examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{ $ref: z.ZodString; summary: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { $ref: string; description?: string | undefined; summary?: string | undefined; }, { $ref: string; description?: string | undefined; summary?: string | undefined; }>, z.ZodObject<{ summary: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; value: z.ZodOptional<z.ZodAny>; externalValue: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }>]>>>; /** * A map between a property name and its encoding information. The key, being the property name, MUST exist in the * schema as a property. The encoding object SHALL only apply to requestBody objects when the media type is * multipart or application/x-www-form-urlencoded. */ encoding: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<z.objectUtil.extendShape<{ contentType: z.ZodString; headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{ description: z.ZodOptional<z.ZodString>; required: z.ZodOptional<z.ZodBoolean>; deprecated: z.ZodOptional<z.ZodBoolean>; style: z.ZodOptional<z.ZodEnum<["matrix", "label", "simple", "form", "spaceDelimited", "pipeDelimited", "deepObject"]>>; explode: z.ZodOptional<z.ZodBoolean>; schema: z.ZodOptional<z.ZodType<Record<string, any>, z.ZodTypeDef, Record<string, any>>>; example: z.ZodOptional<z.ZodAny>; examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{ summary: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; value: z.ZodOptional<z.ZodAny>; externalValue: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }>>>; content: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{ schema: z.ZodOptional<z.ZodType<Record<string, any>, z.ZodTypeDef, Record<string, any>>>; example: z.ZodOptional<z.ZodAny>; examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{ summary: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; value: z.ZodOptional<z.ZodAny>; externalValue: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }>>>; }, "strip", z.ZodTypeAny, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }>>>; }, "strip", z.ZodTypeAny, { description?: string | undefined; deprecated?: boolean | undefined; content?: Record<string, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }> | undefined; required?: boolean | undefined; example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; style?: "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined; explode?: boolean | undefined; }, { description?: string | undefined; deprecated?: boolean | undefined; content?: Record<string, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }> | undefined; required?: boolean | undefined; example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; style?: "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined; explode?: boolean | undefined; }>>>; }, { headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{ $ref: z.ZodString; summary: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { $ref: string; description?: string | undefined; summary?: string | undefined; }, { $ref: string; description?: string | undefined; summary?: string | undefined; }>, z.ZodObject<z.objectUtil.extendShape<{ description: z.ZodOptional<z.ZodString>; required: z.ZodOptional<z.ZodBoolean>; deprecated: z.ZodOptional<z.ZodBoolean>; style: z.ZodOptional<z.ZodEnum<["matrix", "label", "simple", "form", "spaceDelimited", "pipeDelimited", "deepObject"]>>; explode: z.ZodOptional<z.ZodBoolean>; schema: z.ZodOptional<z.ZodType<Record<string, any>, z.ZodTypeDef, Record<string, any>>>; example: z.ZodOptional<z.ZodAny>; examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{ summary: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; value: z.ZodOptional<z.ZodAny>; externalValue: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }>>>; content: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{ schema: z.ZodOptional<z.ZodType<Record<string, any>, z.ZodTypeDef, Record<string, any>>>; example: z.ZodOptional<z.ZodAny>; examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{ summary: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; value: z.ZodOptional<z.ZodAny>; externalValue: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }>>>; }, "strip", z.ZodTypeAny, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }>>>; }, { schema: z.ZodOptional<z.ZodType<any, z.ZodTypeDef, any>>; examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{ $ref: z.ZodString; summary: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { $ref: string; description?: string | undefined; summary?: string | undefined; }, { $ref: string; description?: string | undefined; summary?: string | undefined; }>, z.ZodObject<{ summary: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; value: z.ZodOptional<z.ZodAny>; externalValue: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }>]>>>; content: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{ schema: z.ZodOptional<z.ZodType<Record<string, any>, z.ZodTypeDef, Record<string, any>>>; example: z.ZodOptional<z.ZodAny>; examples: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{ summary: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; value: z.ZodOptional<z.ZodAny>; externalValue: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }>>>; }, "strip", z.ZodTypeAny, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }>>>; }>, "strip", z.ZodTypeAny, { description?: string | undefined; deprecated?: boolean | undefined; content?: Record<string, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }> | undefined; required?: boolean | undefined; example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; } | { $ref: string; description?: string | undefined; summary?: string | undefined; }> | undefined; schema?: any; style?: "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined; explode?: boolean | undefined; }, { description?: string | undefined; deprecated?: boolean | undefined; content?: Record<string, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }> | undefined; required?: boolean | undefined; example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; } | { $ref: string; description?: string | undefined; summary?: string | undefined; }> | undefined; schema?: any; style?: "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined; explode?: boolean | undefined; }>]>>>; }>, "strip", z.ZodTypeAny, { contentType: string; headers?: Record<string, { $ref: string; description?: string | undefined; summary?: string | undefined; } | { description?: string | undefined; deprecated?: boolean | undefined; content?: Record<string, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }> | undefined; required?: boolean | undefined; example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; } | { $ref: string; description?: string | undefined; summary?: string | undefined; }> | undefined; schema?: any; style?: "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined; explode?: boolean | undefined; }> | undefined; }, { contentType: string; headers?: Record<string, { $ref: string; description?: string | undefined; summary?: string | undefined; } | { description?: string | undefined; deprecated?: boolean | undefined; content?: Record<string, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }> | undefined; required?: boolean | undefined; example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; } | { $ref: string; description?: string | undefined; summary?: string | undefined; }> | undefined; schema?: any; style?: "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined; explode?: boolean | undefined; }> | undefined; }>>>; }>, "strip", z.ZodTypeAny, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; } | { $ref: string; description?: string | undefined; summary?: string | undefined; }> | undefined; schema?: any; encoding?: Record<string, { contentType: string; headers?: Record<string, { $ref: string; description?: string | undefined; summary?: string | undefined; } | { description?: string | undefined; deprecated?: boolean | undefined; content?: Record<string, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }> | undefined; required?: boolean | undefined; example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; } | { $ref: string; description?: string | undefined; summary?: string | undefined; }> | undefined; schema?: any; style?: "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined; explode?: boolean | undefined; }> | undefined; }> | undefined; }, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; } | { $ref: string; description?: string | undefined; summary?: string | undefined; }> | undefined; schema?: any; encoding?: Record<string, { contentType: string; headers?: Record<string, { $ref: string; description?: string | undefined; summary?: string | undefined; } | { description?: string | undefined; deprecated?: boolean | undefined; content?: Record<string, { example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; }> | undefined; schema?: Record<string, any> | undefined; }> | undefined; required?: boolean | undefined; example?: any; examples?: Record<string, { description?: string | undefined; summary?: string | undefined; value?: any; externalValue?: string | undefined; } | { $ref: string; description?: string | undefined; summary?: string | undefined; }> | undefined; schema?: any; style?: "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined; explode?: boolean | undefined; }> | undefined; }> | undefined; }>; //# sourceMappingURL=media-type-object.d.ts.map