Rolodex v0.10.1 Rolodex.PipelineConfig

Defines shared params to be applied to every route within a Phoenix pipeline.

Options

  • body (default: %{})
  • headers (default: %{})
  • path_params (default: %{})
  • query_params (default: %{})
  • responses (default: %{})

Example

%Rolodex.PipelineConfig{
  body: %{id: :uuid, name: :string}
  headers: %{"X-Request-Id" => :uuid},
  query_params: %{account_id: :uuid},
  responses: %{401 => SharedUnauthorizedResponse}
}

Link to this section Summary

Link to this section Types

Link to this type

t()
t() :: %Rolodex.PipelineConfig{
  auth: list() | map(),
  body: map(),
  headers: map(),
  path_params: map(),
  query_params: map(),
  responses: map()
}

Link to this section Functions

Link to this function

new(params \\ [])
new(list() | map()) :: t()