chaperon v0.3.1 Chaperon.Action.HTTP View Source

HTTP based actions to be run in a Chaperon.Scenario module for a given Chaperon.Session.

This supports GET, POST, PUT, PATCH, DELETE & HEAD requests with support for optional headers & query params.

Link to this section Summary

Types

method()

t()

Functions

add_options(action, opts)

delete(path, opts \\ [])

full_url(action, session)

get(path, opts)

is_full_url?(arg1)

metrics_url(action, session)

options(action, session)

patch(path, opts)

post(path, opts)

put(path, opts)

query_params_string(params)

Link to this section Types

method()

method() :: :get | :post | :put | :patch | :delete | :head

options()

options() :: [
  form: map() | Keyword.t(),
  json: map() | Keyword.t(),
  headers: map() | Keyword.t(),
  params: map() | Keyword.t(),
  decode: :json | (HTTPoison.Response.t() -> any()),
  with_result: Chaperon.Session.result_callback(),
  metrics_url: String.t()
]

t()

t() :: %Chaperon.Action.HTTP{
  body: binary(),
  callback: Chaperon.Session.result_callback(),
  decode: :json | (HTTPoison.Response.t() -> any()),
  headers: map(),
  method: method(),
  metrics_url: String.t(),
  params: map(),
  path: String.t()
}

Link to this section Functions

add_options(action, opts)

add_options(any(), Chaperon.Action.HTTP.options()) :: t()

delete(path, opts \\ [])

delete(String.t(), options()) :: t()

full_path(map)

full_url(action, session)

get(path, opts)

get(String.t(), options()) :: t()

is_full_url?(arg1)

metrics_url(action, session)

options(action, session)

patch(path, opts)

patch(String.t(), options()) :: t()

post(path, opts)

post(String.t(), options()) :: t()

put(path, opts)

put(String.t(), options()) :: t()

query_params_string(params)

url(map, arg2)