defmodule Reactor.Req.Dsl.Request do
  @moduledoc """
  A `req_run` DSL entity for the `Reactor.Req` DSL extension.
  """

  alias Reactor.Dsl.WaitFor
  alias Reactor.Req.Dsl.Options

  defstruct Options.struct_attrs()
  @type t :: Options.entity()

  @doc false
  def __entity__,
    do: %Spark.Dsl.Entity{
      name: :req_request,
      describe: """
      Performs a request using `Req.request/2`.

      Note that Reactor doesn't validate any options - it simply passes them to the underlying `Req` function and assumes it will validate them.
      """,
      target: __MODULE__,
      identifier: :name,
      imports: [Reactor.Dsl.Argument],
      args: [:name],
      recursive_as: :steps,
      entities: [arguments: [WaitFor.__entity__()]],
      schema:
        Options.merge(
          name: [
            type: :atom,
            required: true,
            doc:
              "A unique name for the step. Used when choosing the return value of the Reactor and for arguments into other steps"
          ]
        )
    }
end