OCSF.Error (OCSF v0.1.0)

Structured error returned by validation and builder functions.

Carries the reason for the failure, the dotted path to the invalid field, and optional details. All functions in this library that can fail return {:error, %OCSF.Error{}}.

Fields

:reason — atom describing the failure (e.g. :invalid, :missing, :type_mismatch).
:path — dotted string pointing at the problematic field (e.g. "user.org.uid", "metadata.version").
:details — map with additional context (expected values, actual value, etc.).

See OCSF.validate/1 and OCSF.Events.Authentication for functions that return this struct.

Summary

Types

t()

Functions

new(reason, path, details \\ %{})

Create a new error.

Types

t()

@type t() :: %OCSF.Error{details: map(), path: String.t(), reason: atom()}

Functions

new(reason, path, details \\ %{})

@spec new(atom(), String.t(), map()) :: t()

Create a new error.

Examples

iex> OCSF.Error.new(:missing, "user.uid")
%OCSF.Error{reason: :missing, path: "user.uid", details: %{}}

iex> OCSF.Error.new(:invalid, "severity_id", %{expected: "0..6 or 99", got: 42})
%OCSF.Error{reason: :invalid, path: "severity_id", details: %{expected: "0..6 or 99", got: 42}}