AutoBE
    Preparing search index...

    Interface IOneOf

    Union type.

    IOneOf represents a union type in 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.IReference
            | AutoBeOpenApi.IJsonSchema.INull
        )[];
        "x-autobe-database-schema-property"?: string
        | null;
        "x-autobe-required-parent-composition"?: boolean;
        "x-autobe-security"?:
            | "password"
            | "token"
            | "externalCredential"
            | "sensitive"
            | "role"
            | null;
        "x-autobe-specification"?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    description discriminator? oneOf x-autobe-database-schema-property? x-autobe-required-parent-composition? x-autobe-security? x-autobe-specification?

    Properties

    description: string
    discriminator?: IDiscriminator

    Discriminator info of the union type.

    oneOf: (
        | AutoBeOpenApi.IJsonSchema.IInteger
        | AutoBeOpenApi.IJsonSchema.INumber
        | AutoBeOpenApi.IJsonSchema.IString
        | AutoBeOpenApi.IJsonSchema.IConstant
        | AutoBeOpenApi.IJsonSchema.IBoolean
        | AutoBeOpenApi.IJsonSchema.IArray
        | AutoBeOpenApi.IJsonSchema.IReference
        | AutoBeOpenApi.IJsonSchema.INull
    )[]

    List of the union types.

    "x-autobe-database-schema-property"?: string | null
    "x-autobe-required-parent-composition"?: boolean

    true when the interface composition marker pass stamped this nested *.ICreate property as a required parent composition (AutoBeDatabase.IParentComposition with presence: "required") that the parent's create/IJoin body must co-create. A producer-asserted structural marker so realize detects the children to co-create by it instead of by the referenced DTO's name; absent/false for every other property, including optional compositions.

    "x-autobe-security"?:
        | "password"
        | "token"
        | "externalCredential"
        | "sensitive"
        | "role"
        | null

    Field-level security classification propagated from the mapped database column (AutoBeDatabase.IPlainField.security); null/absent for an ordinary column or a property with no database column. Inline literal by contract — never aliased to a named type.

    "x-autobe-specification"?: string

    Settings

    Member Visibility

    On This Page

    Properties