Incant.Web.API.ActionPayload (Incant v0.1.1)

Action invocation payload carried inside Incant.Web.API.ActionRunRequest.

Holds the target record id, optional bulk selection, caller assigns, and action input. Library/embedded consumers do not interact with this module.

Summary

t()

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.ActionPayload{
  assigns: map(),
  id: term() | nil,
  input: map(),
  selected_ids: [term()] | nil
}

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.

@spec to_service_payload(t()) :: map()