Documentation
    Preparing search index...

    Interface IMixed

    Mixed type (multiple types in array).

    interface IMixed {
        $ref: string;
        additionalItems?: boolean | OpenApiV3_1.IJsonSchema;
        additionalProperties?: boolean | OpenApiV3_1.IJsonSchema;
        allOf: OpenApiV3_1.IJsonSchema[];
        anyOf: OpenApiV3_1.IJsonSchema[];
        const: string | number | boolean;
        contentMediaType?: string;
        default?: any[] | null;
        deprecated?: boolean;
        description?: string;
        discriminator?: OpenApiV3_1.IJsonSchema.IOneOf.IDiscriminator;
        enum?: any[];
        example?: any;
        examples?: any[] | Record<string, any>;
        exclusiveMaximum?: number | boolean;
        exclusiveMinimum?: number | boolean;
        format?:
            | "byte"
            | "password"
            | "regex"
            | "uuid"
            | "email"
            | "hostname"
            | "idn-email"
            | "idn-hostname"
            | "iri"
            | "iri-reference"
            | "ipv4"
            | "ipv6"
            | "uri"
            | "uri-reference"
            | "uri-template"
            | "url"
            | "date-time"
            | "date"
            | "time"
            | "duration"
            | "json-pointer"
            | "relative-json-pointer"
            | string & {}
            | "binary";
        items?: OpenApiV3_1.IJsonSchema
        | OpenApiV3_1.IJsonSchema[];
        maximum?: number;
        maxItems?: number & tags.Type<"uint64">;
        maxLength?: number & tags.Type<"uint64">;
        maxProperties?: number;
        minimum?: number;
        minItems?: number & tags.Type<"uint64">;
        minLength?: number & tags.Type<"uint64">;
        minProperties?: number;
        multipleOf?: number & tags.ExclusiveMinimum<0>;
        nullable?: boolean;
        oneOf: OpenApiV3_1.IJsonSchema[];
        pattern?: string;
        prefixItems?: OpenApiV3_1.IJsonSchema[];
        properties?: Record<string, OpenApiV3_1.IJsonSchema>;
        readOnly?: boolean;
        required?: string[];
        title?: string;
        type: (
            | "string"
            | "number"
            | "boolean"
            | "object"
            | "integer"
            | "array"
            | "null"
        )[];
        uniqueItems?: boolean;
        writeOnly?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    $ref additionalItems? additionalProperties? allOf anyOf const contentMediaType? default? deprecated? description? discriminator? enum? example? examples? exclusiveMaximum? exclusiveMinimum? format? items? maximum? maxItems? maxLength? maxProperties? minimum? minItems? minLength? minProperties? multipleOf? nullable? oneOf pattern? prefixItems? properties? readOnly? required? title? type uniqueItems? writeOnly?

    Properties

    $ref: string

    Reference path.

    additionalItems?: boolean | OpenApiV3_1.IJsonSchema

    Additional items schema.

    additionalProperties?: boolean | OpenApiV3_1.IJsonSchema

    Additional properties schema.

    allOf: OpenApiV3_1.IJsonSchema[]

    Schemas to combine.

    anyOf: OpenApiV3_1.IJsonSchema[]

    Union member schemas.

    const: string | number | boolean

    Constant value.

    contentMediaType?: string

    Content media type.

    default?: any[] | null

    Default value.

    deprecated?: boolean

    Whether this type is deprecated.

    When true, indicates the type should no longer be used and may be removed in future versions. Set via the @deprecated JSDoc tag.

    description?: string

    Detailed description of the schema.

    Full documentation for the type, explaining its purpose, constraints, and usage. Extracted from JSDoc comment body. Supports markdown formatting in many JSON Schema consumers.

    discriminator?: OpenApiV3_1.IJsonSchema.IOneOf.IDiscriminator

    Discriminator for tagged unions.

    enum?: any[]

    Allowed values.

    example?: any

    Single example value for the schema.

    A representative value that conforms to the schema, useful for documentation and testing. Set via the @example JSDoc tag.

    examples?: any[] | Record<string, any>

    Example values.

    exclusiveMaximum?: number | boolean

    Exclusive maximum.

    exclusiveMinimum?: number | boolean

    Exclusive minimum.

    format?:
        | "byte"
        | "password"
        | "regex"
        | "uuid"
        | "email"
        | "hostname"
        | "idn-email"
        | "idn-hostname"
        | "iri"
        | "iri-reference"
        | "ipv4"
        | "ipv6"
        | "uri"
        | "uri-reference"
        | "uri-template"
        | "url"
        | "date-time"
        | "date"
        | "time"
        | "duration"
        | "json-pointer"
        | "relative-json-pointer"
        | string & {}
        | "binary"

    String format.

    items?: OpenApiV3_1.IJsonSchema | OpenApiV3_1.IJsonSchema[]

    Element type (or tuple types).

    maximum?: number

    Maximum value.

    maxItems?: number & tags.Type<"uint64">

    Maximum items.

    maxLength?: number & tags.Type<"uint64">

    Maximum length.

    maxProperties?: number

    Maximum properties.

    minimum?: number

    Minimum value.

    minItems?: number & tags.Type<"uint64">

    Minimum items.

    minLength?: number & tags.Type<"uint64">

    Minimum length.

    minProperties?: number

    Minimum properties.

    multipleOf?: number & tags.ExclusiveMinimum<0>

    Multiple of constraint.

    nullable?: boolean

    Whether nullable.

    oneOf: OpenApiV3_1.IJsonSchema[]

    Union member schemas.

    pattern?: string

    Regex pattern.

    prefixItems?: OpenApiV3_1.IJsonSchema[]

    Tuple prefix items.

    properties?: Record<string, OpenApiV3_1.IJsonSchema>

    Property schemas.

    readOnly?: boolean

    Whether the property is read-only.

    When true, the property should not be modified by clients and is typically set by the server. Useful for generated IDs, timestamps, etc.

    required?: string[]

    Required property names.

    title?: string

    Short title for the schema.

    A brief, human-readable name for the type. Typically extracted from the first line of a JSDoc comment or the @title tag.

    type: (
        | "string"
        | "number"
        | "boolean"
        | "object"
        | "integer"
        | "array"
        | "null"
    )[]

    Array of type discriminators.

    uniqueItems?: boolean

    Whether elements must be unique.

    writeOnly?: boolean

    Whether the property is write-only.

    When true, the property is accepted on input but never returned in responses. Common for sensitive data like passwords.

    Settings

    Member Visibility

    On This Page

    Properties