View Source Snap.Auth behaviour (Snap v0.9.0)

Defines how HTTP request is transformed to add authentication.

Summary

Types

response()
t()

Callbacks

sign(config_opts, method, url, headers, body)

Modifies an HTTP request to include authentication details

Types

Link to this type

response()

View Source 
@type response() ::
  {:ok,
   {Snap.HTTPClient.method(), Snap.HTTPClient.url(), Snap.HTTPClient.headers(),
    Snap.HTTPClient.body()}}
  | {:error, term()}
Link to this type

t()

View Source 
@type t() :: module()

Callbacks

Link to this callback

sign(config_opts, method, url, headers, body)

View Source 
@callback sign(
  Snap.Cluster.config_opts(),
  Snap.HTTPClient.method(),
  Snap.HTTPClient.url(),
  Snap.HTTPClient.headers(),
  Snap.HTTPClient.body()
) :: response()

Modifies an HTTP request to include authentication details