Describes an HTTP call for export purposes.

This struct is used to map PropertyDamage commands to their HTTP representations, enabling the export of failure reports to standalone scripts (curl, Python, Elixir) that can reproduce the failure without the PropertyDamage framework.

Usage

Adapters can optionally implement http_spec/2 to provide HTTP specifications:

def http_spec(%CreateAccount{currency: currency}, _context) do
  %HTTPSpec{
    method: :post,
    path: "/api/accounts",
    body: %{currency: currency}
  }
end

def http_spec(%CreditAccount{account_ref: id, amount: amount}, _context) do
  %HTTPSpec{
    method: :post,
    path: "/api/accounts/:account_id/credit",
    path_params: %{account_id: id},
    body: %{amount: amount}
  }
end

Path Parameters

Use :param_name syntax in paths, with corresponding keys in path_params:

%HTTPSpec{
  path: "/api/accounts/:account_id/transactions/:tx_id",
  path_params: %{account_id: "acc_123", tx_id: "tx_456"}
}

This renders as: /api/accounts/acc_123/transactions/tx_456