AutoBE
    Preparing search index...

    Interface AutoBeInterfaceSchemaPropertyDesign

    Designs one property of a DTO schema.

    Interface schema generation builds each DTO from an empty object shell. Therefore every visible DTO property is described here once; database properties that should not appear in the DTO are listed separately in excludes.

    Samchon

    interface AutoBeInterfaceSchemaPropertyDesign {
        databaseSchemaProperty: string | null;
        description: string;
        key: string;
        reason: string;
        required: boolean;
        schema: IJsonSchemaProperty;
        specification: string;
    }
    Index

    Properties

    databaseSchemaProperty: string | null

    Database schema property this maps to, or null for computed properties.

    When null, specification must explain the computation logic.

    description: string

    API documentation for consumers (Swagger UI). Explain what the property represents. No implementation details.

    Format: summary sentence first, \n\n, then paragraphs grouped by topic.

    key: string

    Property key to include in the DTO.

    reason: string

    Evidence and reasoning for including this property.

    Describe what you found that requires this property in the DTO.

    required: boolean

    Whether property should be in required array.

    Schema definition for the property.

    Must be consistent with specification. Inline objects forbidden; use $ref for nested structures.

    specification: string

    Implementation guidance for downstream agents.

    Internal documentation for Realize/Test agents. When databaseSchemaProperty is null, this must fully explain the computation logic.