Interface IAnyOf

Union type.

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

For reference, even if your Swagger (or OpenAPI) document defines anyOf instead of oneOf, IGeminiSchema forcibly converts it to anyOf type.

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

Hierarchy (View Summary)

Properties

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

Properties

anyOf

anyOf: (
    | IGeminiSchema.IObject
    | IGeminiSchema.IBoolean
    | IGeminiSchema.IInteger
    | IGeminiSchema.INumber
    | IGeminiSchema.IString
    | IGeminiSchema.IArray
    | IGeminiSchema.IReference
    | IGeminiSchema.INull
    | IGeminiSchema.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.

Optionaltitle

title?: string

Title of the schema.

Optionalx-discriminator

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

Discriminator info of the union type.

Settings

Member Visibility

On This Page

Properties