AutoBE
    Preparing search index...

    Interface AutoBeInterfaceOperationsReviewEvent

    Event fired during the review and validation phase of API operation definitions.

    This event occurs when the Interface agent is reviewing and validating the generated API operations against business requirements, technical specifications, and OpenAPI standards. The review phase ensures that each operation properly implements the required functionality with correct request/response schemas, authentication, error handling, and documentation.

    The review process involves systematic validation where the agent evaluates operation completeness, parameter correctness, response accuracy, and overall API design consistency. Operations that fail validation are marked for revision to ensure the final API specification meets enterprise-level quality standards.

    Kakasoo

    interface AutoBeInterfaceOperationsReviewEvent {
        completed: number;
        content: IOperation[];
        created_at: string & Format<"date-time">;
        id: string;
        operations: IOperation[];
        plan: string;
        review: string;
        step: number;
        tokenUsage: IAutoBeTokenUsageJson.IComponent;
        total: number;
        type: "interfaceOperationsReview";
    }

    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: IOperation[]

    Revised operations based on the amendment plan.

    The final corrected API operations after applying all fixes from the improvement plan. If no issues were found during review, this contains the original operations unchanged. These enhanced operations are ready for schema generation and subsequent implementation phases.

    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.

    operations: IOperation[]

    Original API operations submitted for review.

    The complete set of operations generated by the Interface Operations Agent that require validation for security compliance, schema alignment, logical consistency, and adherence to AutoBE standards. These are the operations being evaluated for potential issues and improvements.

    plan: string

    Amendment plan based on the review feedback.

    Structured action plan outlining specific corrections needed for:

    • Security issues (password exposure, authorization bypasses)
    • Logic errors (mismatched return types, incorrect HTTP semantics)
    • Schema violations (missing fields, type mismatches)

    If operations are perfect, explicitly states no changes are required.

    review: string

    Detailed review feedback from the Interface Operations Review Agent.

    Contains comprehensive assessment results including:

    • Security vulnerability analysis
    • Schema compliance validation
    • Logical consistency verification
    • Standard adherence evaluation
    • Identified critical issues and recommendations
    step: number

    Current iteration number of the operation review process.

    Indicates which revision cycle of the API operation review is currently being executed. This step number helps track the iterative validation process and provides context for understanding how many review cycles have been completed to achieve the desired operation quality.

    The step value increments with each major review iteration, allowing stakeholders to monitor the progressive refinement of API operations and understand the validation rigor applied to the interface design.

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

    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", "prismaSchemas", "interfaceOperations", "testScenarios"