RigInboundGateway.ApiProxy.Validations (Reactive Interaction Gateway v3.0.0-alpha.2) View Source

Used to validate APIs configuration for reverse proxy. Validates use cases such as setting "target" to "kafka" but not "topic", which is required in such case.

When any error occurs during RIG start -> process will exit. When any error occurs during REST API request -> process won't exit, but instead API returns 400 -- bad request.

Link to this section Summary

Types

error_list_t()

error_map_t()

error_t()

Functions

config()

Returns module configuration.

to_map(errors)

type_validation(map, key, type, fun)

validate(api)

validate!(api)

validate_all(api)

validate_auth(errors, api)

validate_auth_type(api)

validate_endpoint_target(endpoint, targets)

validate_endpoints(errors, api)

validate_integer(map, key)

validate_list(map, key)

validate_proxy(arg1)

validate_required_props(errors, api)

validate_secured_endpoint(api, arg2)

validate_string(map, key)

validate_version_data(arg1)

with_any_error(errors, min_errors \\ 1)

with_nested_presence(arg1, key, map)

Link to this section Types

error_list_t()

Specs

error_list_t() :: [{String.t(), error_t()}]

error_map_t()

Specs

error_map_t() :: %{
  required(String.t()) => [%{required(String.t() | atom()) => String.t()}]
}

error_t()

Specs

error_t() :: [{:error, String.t() | atom(), atom(), String.t()}]

Link to this section Functions

config()

Specs

config() :: any()

Returns module configuration.

If application environment contains values in Keyword or Map struct, defaults from macro usage will be recursively merged with application configuration.

If one of the configuration parameters does not exist or can not be resolved, raises ArgumentError.

to_map(errors)

Specs

to_map(error_list_t()) :: error_map_t()

type_validation(map, key, type, fun)

Specs

type_validation(map(), String.t(), String.t(), function()) :: error_list_t()

validate(api)

Specs

validate(RigInboundGateway.ApiProxy.Api.t()) ::
  {:error, error_list_t()} | {:ok, RigInboundGateway.ApiProxy.Api.t()}

validate!(api)

Specs

validate!(RigInboundGateway.ApiProxy.Api.t()) ::
  RigInboundGateway.ApiProxy.Api.t()

validate_all(api)

Specs

validate_all(RigInboundGateway.ApiProxy.Api.t()) :: error_list_t()

validate_auth(errors, api)

Specs

validate_auth(error_list_t(), RigInboundGateway.ApiProxy.Api.t()) ::
  error_list_t()

validate_auth_type(api)

Specs

validate_auth_type(RigInboundGateway.ApiProxy.Api.t()) :: error_t()

validate_endpoint_target(endpoint, targets)

Specs

validate_endpoint_target(RigInboundGateway.ApiProxy.Api.endpoint(), [String.t()]) ::
  boolean()

validate_endpoints(errors, api)

Specs

validate_endpoints(error_list_t(), RigInboundGateway.ApiProxy.Api.t()) ::
  error_list_t()

validate_integer(map, key)

Specs

validate_integer(map(), String.t()) :: error_list_t()

validate_list(map, key)

Specs

validate_list(map(), String.t()) :: error_list_t()

validate_proxy(arg1)

Specs

validate_proxy(RigInboundGateway.ApiProxy.Api.t()) :: error_list_t()

validate_required_props(errors, api)

Specs

validate_required_props(error_list_t(), RigInboundGateway.ApiProxy.Api.t()) ::
  error_list_t()

validate_secured_endpoint(api, arg2)

Specs

validate_secured_endpoint(
  RigInboundGateway.ApiProxy.Api.t(),
  RigInboundGateway.ApiProxy.Api.endpoint()
) :: error_t()

validate_string(map, key)

Specs

validate_string(map(), String.t()) :: error_list_t()

validate_version_data(arg1)

Specs

validate_version_data(RigInboundGateway.ApiProxy.Api.t()) :: error_list_t()

with_any_error(errors, min_errors \\ 1)

Specs

with_any_error(error_list_t(), integer()) :: error_list_t()

with_nested_presence(arg1, key, map)

Specs

with_nested_presence(boolean(), String.t() | atom(), map()) :: error_t()