AutoBE
    Preparing search index...

    Interface AutoBeTestAuthorizeFunction

    Authorization function for E2E test code.

    Michael

    interface AutoBeTestAuthorizeFunction {
        actor: string;
        authType: string;
        content: string;
        endpoint: IEndpoint;
        location: string;
        name: string;
        recipe?: IRecipe;
        type: "authorize";
    }

    Hierarchy

    • AutoBeTestFunctionBase<"authorize">
      • AutoBeTestAuthorizeFunction
    Index

    Properties

    actor authType content endpoint location name recipe? type

    Properties

    actor: string

    Actor name (e.g., "admin", "user").

    authType: string

    Authentication type, matching AutoBeOpenApi.IAuthorizationLifecycle.type:

    • "login": Authenticate existing user
    • "join": Register new user
    • "refresh": Renew expired token

    content

    content: string

    The complete source code content of the test function. Contains the full implementation including function signature and body.

    endpoint: IEndpoint

    Source API endpoint this authorization function was generated from.

    location: string

    The file system location where this test function will be written. Should be an absolute or relative path to the target test file.

    name: string

    The name identifier of the function. Used to reference the function within the test suite.

    recipe?: IRecipe

    Machine-readable authorization recipe represented by this helper.

    Deterministic helpers are a single OpenAPI authorization operation. More complex helpers may also describe additional actor connections and dependency operations required to make the returned connection usable. When omitted, consumers must treat the helper as legacy metadata with unknown role guarantees.

    type: "authorize"

    Discriminator field that identifies the specific type of test function. Used for discriminated union pattern to distinguish between different test function types.

    Settings

    Member Visibility

    On This Page

    Properties