Incant.Web.API.ActionRunRequest (incant v0.1.0)

Typed request contract for running Incant actions over the standalone HTTP API.

Carries the decoded action payload plus caller context. Library/embedded consumers do not interact with this module.

Summary

t()

cast(params)

decode(json)

Decodes a JSON string into this struct.

decode!(json)

Decodes a JSON string into this struct, raising on failure.

dump(struct)

Dumps this struct into JSON-shaped data, respecting JSON field names.

from_map(map)

Builds this struct from a decoded JSON map.

from_map!(map)

Builds this struct from a decoded JSON map, raising on failure.

json_schema()

Returns a JSON Schema-compatible schema map.

schema()

Returns a JSON Schema-compatible schema map.

to_map(struct)

Converts this struct into a JSON-shaped map.

@type t() :: %Incant.Web.API.ActionRunRequest{
  context: map(),
  payload: Incant.Web.API.ActionPayload.t()
}

@spec cast(map()) :: {:ok, t()} | {:error, {:invalid_request, Exception.t()}}

Decodes a JSON string into this struct.

Decodes a JSON string into this struct, raising on failure.

Dumps this struct into JSON-shaped data, respecting JSON field names.

Builds this struct from a decoded JSON map.

Builds this struct from a decoded JSON map, raising on failure.

Returns a JSON Schema-compatible schema map.

Returns a JSON Schema-compatible schema map.

Converts this struct into a JSON-shaped map.