AutoBE
    Preparing search index...

    Interface AutoBeRealizeOperationFunction

    API operation provider function implementation.

    Represents a generated provider function that implements the business logic for a specific API operation endpoint. Each operation function handles the complete request-response lifecycle including validation, authorization, database interactions, and response formatting.

    Kakasoo

    interface AutoBeRealizeOperationFunction {
        content: string;
        endpoint: IEndpoint;
        location: string;
        name: string;
        placeholderContent?: string;
        queryIR?: AutoBeRealizeQueryIR[];
        returnType: string;
        type: "operation";
    }
    Index

    Properties

    content: string

    Generated provider source before query placeholders are materialized.

    Operation functions persist the language-neutral queryIR placeholder form so later phases can parse database access without depending on TypeScript Prisma calls. TypeScript file generation materializes this source with queryIR before compilation or archive output.

    endpoint: IEndpoint

    OpenAPI endpoint specification

    Contains the complete OpenAPI specification for this endpoint including HTTP method, path, request/response schemas, and documentation.

    location: string

    File path where the provider function is generated

    The relative path to the TypeScript file containing the provider function. Always located under "src/providers/" directory with the function name as filename.

    Format: "src/providers/${name}.ts" Example: "src/providers/delete__discussionBoard_administrators_$id.ts"

    name: string

    Provider function name

    The TypeScript function name generated from the OpenAPI path. Follows special naming convention: HTTP method + path segments joined by double underscores. Path parameters are prefixed with $.

    NOTE: This does NOT follow camelCase convention due to its special format. Instead, it uses a specific pattern for provider function naming:

    • HTTP method in lowercase
    • Double underscores (__) as segment separator
    • Path segments separated by single underscores (_)
    • Path parameters prefixed with dollar sign ($)

    Pattern: method__segment1_segment2_$param Example: "delete__discussionBoard_administrators_$id"

    placeholderContent?: string

    Provider source before query placeholders are materialized into Prisma calls.

    Older archives may carry this field separately from content. New operation histories keep content in this placeholder form as well.

    Canonical query calls referenced by placeholderContent.

    returnType: string

    Provider return type fixed by the Interface phase.

    This is operation.responseBody.typeName when a response body exists, or "void" for operations without a response body. It records the contract used when generating and validating the provider implementation.

    type: "operation"

    Type discriminator for operation function.