AutoBE
    Preparing search index...

    Interface IRecipe

    How an authorization helper obtains a usable actor connection.

    interface IRecipe {
        kind: "deterministic" | "generated";
        operations: IOperationCall[];
        provides: IProvidedAuthorization;
        requiredConnections: IRequiredConnection[];
    }
    Index

    Properties

    kind operations provides requiredConnections

    Properties

    kind: "deterministic" | "generated"

    Provenance of the recipe body.

    • deterministic: emitted from the source OpenAPI auth operation only
    • generated: inferred from the contract when the actor needs a multi-step join/login/grant/approval flow
    operations: IOperationCall[]

    API operations used by the helper, in execution order.

    Accessors come directly from AutoBeOpenApi.IOperation.accessor; generated SDK names or prose must not be used as the source of truth.

    provides: IProvidedAuthorization

    Authorization state provided for the first connection parameter after this helper resolves.

    requiredConnections: IRequiredConnection[]

    Additional actor connections the helper expects inside its props object, such as props.admin.connection for an admin that grants a user role. Empty for simple one-step join/login/refresh helpers.

    Settings

    Member Visibility

    On This Page

    Properties