Surgex.Parser.IncludeParser (Surgex v5.0.0) View Source

Parses the JSON API's include parameter according to the JSON API spec.

Produces a list of includes constrained to the provided relationship paths.

Link to this section Summary

errors()

path()

Flattens the result of the parser (inclusion list) into multiple keys.

errors() :: :invalid_relationship_path | :invalid_input

path() :: atom() | String.t()

flatten({:ok, Keyword.t()}, String.t()) :: {:ok, Keyword.t()}

Flattens the result of the parser (inclusion list) into multiple keys.

iex> IncludeParser.flatten({:ok, include: [:user]}, :include)
{:ok, include_user: true}