AutoBE
    Preparing search index...

    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, AutoBeOpenApi forcibly converts it to oneOf type.

    interface IOneOf {
        description: string;
        discriminator?: IDiscriminator;
        oneOf: (
            | AutoBeOpenApi.IJsonSchema.IInteger
            | AutoBeOpenApi.IJsonSchema.INumber
            | AutoBeOpenApi.IJsonSchema.IString
            | AutoBeOpenApi.IJsonSchema.IConstant
            | AutoBeOpenApi.IJsonSchema.IBoolean
            | AutoBeOpenApi.IJsonSchema.IArray
            | AutoBeOpenApi.IJsonSchema.IObject
            | AutoBeOpenApi.IJsonSchema.IReference
            | AutoBeOpenApi.IJsonSchema.INull
        )[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    description: string

    Description about the type.

    CRITICAL: This description MUST be extensively detailed and MUST reference and align with the description comments from the corresponding Prisma DB schema tables and columns.

    The description MUST be organized into MULTIPLE PARAGRAPHS (separated by line breaks) based on different aspects of the type:

    • The purpose and business meaning of the type
    • Relationships to other entities in the system
    • Validation rules, constraints, and edge cases
    • Usage context and examples when helpful

    This structured approach improves readability and helps readers better understand the type's various characteristics and use cases. The description should be so comprehensive that anyone reading it can fully understand the type without needing to reference other documentation.

    MUST be written in English. Never use other languages.

    discriminator?: IDiscriminator

    Discriminator info of the union type.

    List of the union types.