cozy_oss v0.2.0

View Source CozyOSS.ApiRequest (cozy_oss v0.2.0)

Converts %ApiSpec{} to a %ApiRequest{}.

Link to this section Summary

Types

body()

Optional request body.

headers()

Request headers.

meta()
method()

Request method.

path()

Request path.

private()
query()

Optional request query.

scheme()

Request scheme.

t()

Functions

build!(config, api_spec, opts)

Bulid a struct %CozyOSS.ApiRequest{} from %CozyOSS.Config{} and %CozyOSS.ApiSpec{}.

to_url!(req)

Converts a request to a signed URL.

Link to this section Types

Link to this type

body()

View Source 
@type body() :: iodata() | nil

Optional request body.

Link to this type

headers()

View Source 
@type headers() :: %{
  optional(header_name :: String.t()) => header_value :: String.t()
}

Request headers.

Link to this type

meta()

View Source 
@type meta() :: %{optional(atom()) => term()}
Link to this type

method()

View Source 
@type method() :: String.t()

Request method.

Link to this type

path()

View Source 
@type path() :: String.t()

Request path.

Link to this type

private()

View Source 
@type private() :: %{optional(atom()) => term()}
Link to this type

query()

View Source 
@type query() :: %{
  optional(query_name :: String.t()) =>
    query_value :: boolean() | number() | String.t()
}

Optional request query.

Link to this type

scheme()

View Source 
@type scheme() :: String.t()

Request scheme.

Link to this type

t()

View Source 
@type t() :: %CozyOSS.ApiRequest{
  body: body(),
  headers: headers(),
  host: String.t() | nil,
  meta: meta(),
  method: method(),
  path: String.t(),
  port: :inet.port_number(),
  private: private(),
  query: query(),
  scheme: scheme()
}

Link to this section Functions

Link to this function

build!(config, api_spec, opts)

View Source 
@spec build!(CozyOSS.Config.t(), CozyOSS.ApiSpec.t(), keyword()) :: t()

Bulid a struct %CozyOSS.ApiRequest{} from %CozyOSS.Config{} and %CozyOSS.ApiSpec{}.

This function has built-in signing support, and it's controlled by option :sign_by:

  • sign_by: :header - add signatures to request headers.
  • sign_by: :url - add signatures to URL.

When using sign_by: :url, an extra option :expiration_in_seconds is supported. The default value is 900.

Link to this function

to_url!(req)

View Source 
@spec to_url!(t()) :: binary()

Converts a request to a signed URL.