AutoBE
    Preparing search index...

    Interface IString

    String type info.

    interface IString {
        contentMediaType?: string;
        description: string;
        format?:
            | "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";
        maxLength?: number;
        minLength?: number;
        pattern?: string;
        type: "string";
        "x-autobe-specification"?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    contentMediaType? description format? maxLength? minLength? pattern? type x-autobe-specification?

    Properties

    contentMediaType?: string

    Content media type restriction.

    For multiple media types, use oneOf with separate string schemas per contentMediaType value. Never use an array here.

    description: string
    format?:
        | "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"

    Format restriction.

    maxLength?: number
    minLength?: number
    pattern?: string

    Pattern restriction.

    type: "string"

    Discriminator value. MUST be a single string, NEVER an array.

    For nullable types, use IOneOf instead: { oneOf: [{ type: "string" }, { type: "null" }] }

    "x-autobe-specification"?: string

    Settings

    Member Visibility

    On This Page

    Properties