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

Typed request contract for standalone Incant resource queries.

The standalone HTTP API decodes JSON bodies into this struct at the HTTP boundary before dispatching to the queried resource. Library/embedded consumers do not interact with this module.

Summary

Types

t()

Functions

cast(params)

cast_table(table)

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.

Types

t()

@type t() :: %Incant.Web.API.QueryRequest{
  context: map(),
  table: Incant.Service.Index.table_state()
}

Functions

cast(params)

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

cast_table(table)

@spec cast_table(map()) ::
  {:ok, Incant.Service.Index.table_state()}
  | {:error, {:invalid_request, Exception.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.