Interface IOneOf

Union type.

IOneOf represents an union type of the TypeScript (A | B | C`).

For reference, even though your Swagger (or OpenAPI) document has defined anyOf instead of the oneOf, OpenApi forcibly converts it to oneOf type.

interface IOneOf {
    deprecated?: boolean;
    description?: string;
    discriminator?: IClaudeSchema.IOneOf.IDiscriminator;
    example?: any;
    examples?: Record<string, any>;
    oneOf: (
        | IClaudeSchema.IObject
        | IClaudeSchema.IConstant
        | IClaudeSchema.IBoolean
        | IClaudeSchema.IInteger
        | IClaudeSchema.INumber
        | IClaudeSchema.IString
        | IClaudeSchema.IArray
        | IClaudeSchema.IReference
        | IClaudeSchema.INull
        | IClaudeSchema.IUnknown
    )[];
    title?: string;
}

Hierarchy (View Summary)

Properties

deprecated? description? discriminator? example? examples? oneOf title?

Properties

Optionaldeprecated

deprecated?: boolean

Whether the type is deprecated or not.

Optionaldescription

description?: string

Detailed description of the schema.

Optionaldiscriminator

discriminator?: IClaudeSchema.IOneOf.IDiscriminator

Discriminator info of the union type.

Optionalexample

example?: any

Example value.

Optionalexamples

examples?: Record<string, any>

List of example values as key-value pairs.

oneOf

oneOf: (
    | IClaudeSchema.IObject
    | IClaudeSchema.IConstant
    | IClaudeSchema.IBoolean
    | IClaudeSchema.IInteger
    | IClaudeSchema.INumber
    | IClaudeSchema.IString
    | IClaudeSchema.IArray
    | IClaudeSchema.IReference
    | IClaudeSchema.INull
    | IClaudeSchema.IUnknown
)[]

List of the union types.

Optionaltitle

title?: string

Title of the schema.

Settings

Member Visibility

On This Page

Properties