Spectre.Event.SchemaRegistry behaviour (Spectre v0.3.0)

Copy Markdown View Source

Host-owned compatibility gate for global Event payload schemas.

Summary

Types

config()

Callbacks

compatible?(t, t, keyword)

Functions

verify(config, definition_ref, envelope)

Types

config()

@type config() :: module() | {module(), keyword()} | nil

Callbacks

compatible?(t, t, keyword)

@callback compatible?(Spectre.Definition.Ref.t(), Spectre.Event.Envelope.t(), keyword()) ::
  :ok | {:error, term()}

Functions

verify(config, definition_ref, envelope)

@spec verify(config(), Spectre.Definition.Ref.t(), Spectre.Event.Envelope.t()) ::
  :ok | {:error, term()}