AshPhoenixGenApi.Resource

Ash extension for generating PhoenixGenApi function configurations from Ash resources.

This extension allows you to define PhoenixGenApi endpoints directly in your Ash resource DSL, automatically generating FunConfig structs that can be pulled by gateway nodes.

Usage

Add the extension to your resource:

defmodule MyApp.Chat.DirectMessage do
  use Ash.Resource,
    extensions: [AshPhoenixGenApi.Resource]

  gen_api do
    service "chat"
    nodes {ClusterHelper, :get_nodes, [:chat]}
    choose_node_mode :random

    action :send_direct_message do
      request_type "send_direct_message"
      timeout 10_000
      response_type :async
      request_info true
    end

    action :get_conversation do
      timeout 5_000
    end

    mfa :ping do
      request_type "ping"
      mfa {MyApp.Chat.Api, :ping, []}
      arg_types %{}
    end
  end
end

DSL

See the DSL documentation for the full list of configuration options.

gen_api

Configure PhoenixGenApi at the resource level.

The gen_api section defines which Ash actions should be exposed as PhoenixGenApi endpoints, along with their routing, timeout, permission, and other settings.

Section-level options serve as defaults for all action and mfa entities in this resource. Each entity can override these defaults.

Nested DSLs

• action
• mfa

Examples

gen_api do
  service "chat"
  nodes {ClusterHelper, :get_nodes, [:chat]}
  choose_node_mode :random
  timeout 5_000
  response_type :async
  request_info true

  action :send_direct_message do
    request_type "send_direct_message"
    timeout 10_000
  end

  action :get_conversation do
    timeout 5_000
  end
end

# Minimal configuration with defaults
gen_api do
  service "chat"

  action :create
  action :read
end

Options

gen_api.action

action name

Configures a PhoenixGenApi endpoint for an Ash resource action.

Each action entity maps an Ash action to a PhoenixGenApi FunConfig. If request_type is not specified, it defaults to the action name as a string. If arg_types and arg_orders are not specified, they are auto-derived from the Ash action's accepted attributes and arguments. arg_orders defaults to :map, which derives the order from arg_types keys. Set to a list of argument name strings to specify explicit ordering.

Examples

action :send_direct_message do
  request_type "send_direct_message"
  timeout 10_000
  response_type :async
  request_info true
  check_permission {:arg, "from_user_id"}
end

action :get_conversation do
  timeout 5_000
  response_type :async
end

# Minimal config - auto-derives request_type and args from Ash action
action :create

Arguments

Options

Introspection

Target: AshPhoenixGenApi.Resource.ActionConfig

gen_api.mfa

mfa name

Configures a standalone PhoenixGenApi MFA endpoint.

Unlike action entities which map an Ash resource action to a FunConfig, mfa entities define endpoints that call an arbitrary MFA function directly. This is useful for exposing custom functions that don't map to standard Ash CRUD actions, such as utility endpoints, batch operations, or service-to-service calls.

Both request_type and mfa are required. arg_types must be explicitly provided since there is no Ash action to auto-derive from. arg_orders defaults to :map, which passes arguments as a map with string keys.

Examples

mfa :my_custom do
  request_type "my_custom"
  mfa {MyApp.Interface.Api, :my_custom, []}
  arg_types %{"user_id" => :string}
  timeout 5_000
end

mfa :batch_process do
  request_type "batch_process"
  mfa {MyApp.BatchProcessor, :run, []}
  arg_types %{"items" => {:list_string, 1000, 50}, "mode" => :string}
  arg_orders ["items", "mode"]
  response_type :async
  request_info true
end

Arguments

Options

Introspection

Target: AshPhoenixGenApi.Resource.MfaConfig