AutoBE
    Preparing search index...

    Interface AutoBeInterfaceSchemaPropertyCreate

    Add a new property to a DTO schema.

    Use when a property is missing: database field not included, relation not exposed, or computed property needed.

    Samchon

    interface AutoBeInterfaceSchemaPropertyCreate {
        databaseSchemaProperty: string | null;
        description: string;
        key: string;
        reason: string;
        required: boolean;
        schema:
            | AutoBeOpenApi.IJsonSchema.IInteger
            | AutoBeOpenApi.IJsonSchema.INumber
            | AutoBeOpenApi.IJsonSchema.IString
            | AutoBeOpenApi.IJsonSchema.IConstant
            | AutoBeOpenApi.IJsonSchema.IBoolean
            | AutoBeOpenApi.IJsonSchema.IArray
            | AutoBeOpenApi.IJsonSchema.IReference
            | AutoBeOpenApi.IJsonSchema.IOneOf
            | AutoBeOpenApi.IJsonSchema.INull;
        specification: string;
        type: "create";
    }
    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.

    key: string

    Property key to add.

    reason: string

    Evidence and reasoning for adding this property.

    Describe what you found that requires this addition.

    required: boolean

    Whether property should be in required array.

    Schema definition for the new 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.

    type: "create"

    Discriminator for property revision type.