Oaskit.Validation.RequestData (oaskit v0.16.1)

Copy Markdown View Source

A subset of a parsed and fetched Plug.Conn struct representing an HTTP request, used by Oaskit.Plugs.ValidateRequest and Oaskit.Validation.RequestValidator.

Summary

Types

headers()
t()

Functions

from_conn(conn)

Extracts the path params, query params, body params and request headers from a parsed and fetched Plug.Conn into a t/0 struct.

Types

headers()

@type headers() :: [{binary(), binary()}]

t()

@type t() :: %Oaskit.Validation.RequestData{
  body_params: %{optional(binary()) => term()},
  path_params: %{optional(binary()) => term()},
  query_params: %{optional(binary()) => term()},
  req_headers: headers()
}

Functions

from_conn(conn)

@spec from_conn(Plug.Conn.t()) :: t()

Extracts the path params, query params, body params and request headers from a parsed and fetched Plug.Conn into a t/0 struct.