AutoBE
    Preparing search index...

    Interface AutoBeInterfaceSchemaContentReviewEvent

    Event fired during the content completeness and consistency review phase of OpenAPI schema generation process.

    This event represents the final quality assurance activity of the Interface Schema Content Review Agent, which focuses exclusively on ensuring DTOs accurately and completely represent their business entities. The agent validates field completeness, type accuracy, required field settings, and documentation quality after security and relationship reviews are complete.

    The Interface Schema Content Review Agent performs comprehensive validation including:

    • Field completeness verification against Prisma schema
    • Data type accuracy (Prisma to OpenAPI type mappings)
    • Required field arrays alignment with Prisma nullability
    • Description quality and business context documentation
    • Cross-variant consistency (IEntity, ICreate, IUpdate, ISummary)
    • Missing variant detection and creation

    Content quality standards enforced:

    • Field Completeness: Every Prisma field represented in appropriate DTOs
    • Type Accuracy: Correct mappings (Int→integer, Decimal→number, DateTime→string)
    • Required Fields: Accurate reflection of Prisma nullable settings
    • Documentation: Comprehensive descriptions for all schemas and properties
    • Variant Consistency: Same field has identical type across all variants

    Key characteristics of the content review:

    • Final quality gate ensuring business domain accuracy
    • Complete field coverage from database schema
    • Consistent type definitions across all DTO variants
    • Meaningful documentation for developer experience

    The review ensures that all DTOs are complete, consistent, and accurately represent the business domain with comprehensive documentation, serving as the final quality checkpoint before API implementation.

    Kakasoo

    interface AutoBeInterfaceSchemaContentReviewEvent {
        completed: number;
        content: Record<string, AutoBeOpenApi.IJsonSchemaDescriptive>;
        created_at: string & Format<"date-time">;
        id: string;
        plan: string;
        review: string;
        schemas: Record<string, AutoBeOpenApi.IJsonSchemaDescriptive>;
        step: number;
        tokenUsage: IAutoBeTokenUsageJson.IComponent;
        total: number;
        type: "interfaceSchemaContentReview";
    }

    Hierarchy (View Summary)

    Index

    Properties

    completed: number

    Number of items completed.

    Tracks how many items have been successfully processed so far in the current operation. This value increments as each item is completed, providing real-time progress indication.

    The ratio of completed to total gives the completion percentage: progress = (completed / total) * 100

    content: Record<string, AutoBeOpenApi.IJsonSchemaDescriptive>

    Schemas modified for content completeness.

    Contains ONLY the schemas that were actively modified for content reasons, including field additions, type corrections, required array fixes, description enhancements, and newly created variant schemas.

    An empty object {} indicates all content was already complete and consistent.

    created_at: string & Format<"date-time">

    Timestamp when the event was created.

    ISO 8601 formatted date-time string indicating when this event was emitted by the system. This timestamp is crucial for event ordering, performance analysis, and debugging the agent workflow execution timeline.

    Format: "YYYY-MM-DDTHH:mm:ss.sssZ" (e.g., "2024-01-15T14:30:45.123Z")

    id: string

    A unique identifier for the event.

    plan: string

    Content improvement plan applied.

    Outlines the specific content fixes implemented including:

    • Fields added to match Prisma schema
    • Type mappings corrected
    • Required arrays aligned with nullability
    • Descriptions enhanced for clarity
    • Variant consistency resolved
    • Missing variants created

    If content was already complete and accurate, explicitly states that no fixes were required.

    review: string

    Content completeness findings from the review.

    Documents all content issues discovered, categorized by type:

    • Field Completeness: Missing fields from Prisma schema
    • Type Accuracy: Incorrect type mappings
    • Required Fields: Misaligned with Prisma nullability
    • Description Quality: Missing or inadequate descriptions
    • Variant Consistency: Type inconsistencies across variants
    • Missing Variants: Required DTO variants not present

    Each issue includes the affected schema and specific problem identified.

    schemas: Record<string, AutoBeOpenApi.IJsonSchemaDescriptive>

    Schemas submitted for content completeness review.

    Contains the OpenAPI schemas that have passed security and relationship reviews, now requiring validation for field completeness, type accuracy, and documentation quality.

    step: number

    Current iteration number of the schema generation being reviewed.

    Indicates which version of the schemas is undergoing content review, representing the final quality assurance step in the iterative refinement process.

    Detailed token usage metrics for the current operation.

    Contains comprehensive token consumption data including total usage, input token breakdown with cache statistics, and output token categorization by generation type. This component-level tracking enables precise analysis of resource utilization for specific agent operations such as schema generation, test writing, or code implementation.

    The token usage data helps identify optimization opportunities, monitor operational costs, and ensure efficient use of AI resources throughout the automated backend development process.

    total: number

    Total number of items to process.

    Represents the complete count of operations, files, endpoints, or other entities that need to be processed in the current workflow step. This value is typically determined at the beginning of an operation and remains constant throughout the process.

    Used together with the completed field to calculate progress percentage and estimate time to completion.

    type: "interfaceSchemaContentReview"

    Unique identifier for the event type.

    A literal string that discriminates between different event types in the AutoBE system. This field enables TypeScript's discriminated union feature, allowing type-safe event handling through switch statements or conditional checks.

    Examples: "analyzeWrite", "prismaSchema", "interfaceOperation", "testScenario"