GroundPlane.Boundary.Envelope (GroundPlane Contracts v0.1.0)

Copy Markdown View Source

Serializable cross-plane request envelope.

Summary

Types

t()

Functions

digest(envelope)
encode!(envelope)
new(attrs)
new!(attrs)
to_map(envelope)

Types

t()

@type t() :: %GroundPlane.Boundary.Envelope{
  id: String.t(),
  issued_at: String.t() | nil,
  metadata: map(),
  operation: String.t(),
  origin: String.t(),
  payload: map() | nil,
  payload_ref: String.t() | nil,
  schema_version: String.t(),
  target: String.t(),
  tenant_id: String.t(),
  trace: map()
}

Functions

digest(envelope)

@spec digest(t()) :: String.t()

encode!(envelope)

@spec encode!(t()) :: String.t()

new(attrs)

@spec new(map() | keyword()) :: {:ok, t()} | {:error, term()}

new!(attrs)

@spec new!(map() | keyword()) :: t()

to_map(envelope)

@spec to_map(t()) :: map()