Interface IAnyOf

Union type.

IAnyOf represents a union type in TypeScript (A | B | C).

For reference, even if your Swagger (or OpenAPI) document defines oneOf instead of anyOf, ILlmSchema forcibly converts it to the anyOf-based ILlmSchema.IAnyOf type.

interface IAnyOf {
    anyOf: (
        | ILlmSchema.IObject
        | ILlmSchema.IBoolean
        | ILlmSchema.IInteger
        | ILlmSchema.INumber
        | ILlmSchema.IString
        | ILlmSchema.IArray
        | ILlmSchema.IReference
        | ILlmSchema.INull
        | ILlmSchema.IUnknown
    )[];
    deprecated?: boolean;
    description?: string;
    example?: any;
    examples?: Record<string, any>;
    readOnly?: boolean;
    title?: string;
    writeOnly?: boolean;
    "x-discriminator"?: ILlmSchema.IAnyOf.IDiscriminator;
}

Hierarchy (View Summary)

Properties

anyOf deprecated? description? example? examples? readOnly? title? writeOnly? x-discriminator?

Properties

anyOf

anyOf: (
    | ILlmSchema.IObject
    | ILlmSchema.IBoolean
    | ILlmSchema.IInteger
    | ILlmSchema.INumber
    | ILlmSchema.IString
    | ILlmSchema.IArray
    | ILlmSchema.IReference
    | ILlmSchema.INull
    | ILlmSchema.IUnknown
)[]

List of the union types.

Optionaldeprecated

deprecated?: boolean

Whether the type is deprecated or not.

Optionaldescription

description?: string

Detailed description of the schema.

Optionalexample

example?: any

Example value.

Optionalexamples

examples?: Record<string, any>

List of example values as key-value pairs.

OptionalreadOnly

readOnly?: boolean

Whether the property is read-only.

Optionaltitle

title?: string

Title of the schema.

OptionalwriteOnly

writeOnly?: boolean

Whether the property is write-only.

Optionalx-discriminator

"x-discriminator"?: ILlmSchema.IAnyOf.IDiscriminator

Discriminator info of the union type.

This discriminator is used to determine which type in the union should be used based on the value of a specific property.

Settings

Member Visibility

On This Page

Properties