AutoBE
    Preparing search index...

    Interface IReference

    Reference type directing named schema.

    interface IReference {
        $ref: string;
        description: string;
        "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

    $ref description x-autobe-database-schema-property? x-autobe-required-parent-composition? x-autobe-security? x-autobe-specification?

    Properties

    $ref: string

    JSON Pointer reference to a named schema (e.g., #/components/schemas/SomeObject).

    description: string
    "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