Insider.Sentinel.DraftCreation.Provider behaviour (Insider Lab v0.1.0)

Copy Markdown View Source

Behaviour for an explicitly configured draft-creation provider.

Implementations must use idempotency_key as provider-native idempotency, must stop work when the monotonic deadline expires, and must return only bounded wire data. This contract authorizes draft creation only; merge and deployment must never be exposed by an implementation.

Summary

Types

deadline()

@type deadline() :: integer()

idempotency_key()

@type idempotency_key() :: binary()

request()

@type request() :: %{required(String.t()) => term()}

response()

@type response() :: %{required(String.t()) => term()}

Callbacks

create(request, idempotency_key, deadline)

@callback create(request(), idempotency_key(), deadline()) ::
  {:ok, response()} | {:error, atom()}

identity()