AutoBE
    Preparing search index...

    Interface AutoBeInterfaceEndpointsEvent

    Event fired when the Interface agent creates the complete list of API endpoints during the RESTful API design process.

    This event occurs early in the API design workflow, after the Interface agent has analyzed the requirements and database schema to determine what API endpoints are needed for the application. The endpoint creation establishes the fundamental structure of the API surface area before detailed operation definitions and schema components are developed.

    The endpoints list provides the architectural foundation for the API design, ensuring comprehensive coverage of the business functionality while maintaining RESTful principles and consistency with the underlying data model.

    Samchon

    interface AutoBeInterfaceEndpointsEvent {
        completed: number;
        created_at: string & Format<"date-time">;
        endpoints: IEndpoint[];
        id: string;
        step: number;
        tokenUsage: IAutoBeTokenUsageJson.IComponent;
        total: number;
        type: "interfaceEndpoints";
    }

    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

    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")

    endpoints: IEndpoint[]

    Array of API endpoints that have been defined for the application.

    Contains the complete list of AutoBeOpenApi.IEndpoint definitions that establish the API surface area for the application. Each endpoint represents a specific URL path and HTTP method combination that will be available in the final API, covering all necessary business operations and data access patterns.

    The endpoints are designed to provide comprehensive coverage of the business functionality while following RESTful conventions and maintaining consistency with the database schema. This foundational structure guides the subsequent development of detailed operation specifications and schema definitions.

    id: string

    A unique identifier for the event.

    step: number

    Iteration number of the requirements analysis this endpoint creation was performed for.

    Indicates which version of the requirements analysis this endpoint design reflects. This step number ensures that the API endpoints are aligned with the current requirements and helps track the evolution of the API surface area as requirements change.

    The step value enables proper synchronization between endpoint definitions and the underlying requirements, ensuring that the API structure remains relevant to the current project scope and business objectives.

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

    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"