AutoBE
    Preparing search index...

    Interface AutoBeInterfaceEndpointDesign

    Endpoint design with description, authorization, and endpoint definition.

    Michael

    Samchon

    interface AutoBeInterfaceEndpointDesign {
        authorizationActors: (string & CamelCasePattern & MinLength<1>)[];
        authorizationType:
            | "login"
            | "join"
            | "refresh"
            | "password"
            | "session"
            | "withdraw"
            | "management"
            | null;
        description: string;
        endpoint: IEndpoint;
    }
    Index

    Properties

    authorizationActors authorizationType description endpoint

    Properties

    authorizationActors: (string & CamelCasePattern & MinLength<1>)[]

    Authorization actors associated with this endpoint (camelCase).

    Include an actor if it can call this endpoint or the endpoint is semantically related to it (e.g., /auth/users/login → ["user"]). Empty array for public endpoints.

    Each actor may generate a separate endpoint — minimize to prevent endpoint explosion.

    authorizationType:
        | "login"
        | "join"
        | "refresh"
        | "password"
        | "session"
        | "withdraw"
        | "management"
        | null

    Authorization type of the endpoint.

    • "login": Credential validation
    • "join": Account registration
    • "withdraw": Account deactivation
    • "refresh": Token renewal
    • "session": Session management (logout, etc.)
    • "password": Password reset/change
    • "management": Other auth-related (2FA, OAuth, verification)
    • null: All other endpoints
    description: string

    Functional description of what this endpoint does and why. Keep concise.

    endpoint: IEndpoint

    The endpoint definition containing path and HTTP method.

    Settings

    Member Visibility

    On This Page

    Properties