Interface AutoBeInterfaceSchemaPropertyDepict

Update documentation of an existing property without changing its type.

Use when the JSON Schema type is correct but documentation fields (databaseSchemaProperty, specification, description) need fixing.

If you discover the schema type is wrong while writing specification, use update instead.

Samchon

interface AutoBeInterfaceSchemaPropertyDepict {
    databaseSchemaProperty: string | null;
    description: string;
    key: string;
    reason: string;
    specification: string;
    type: "depict";
}

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 update documentation for.

reason: string

Evidence and reasoning for documentation update.

Describe what was missing or incorrect.

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: "depict"

Discriminator for property revision type.