TamaEx.Memory.Entity.Params (TamaEx v0.1.18)

View Source

Summary

Functions

Converts validated changeset to request body format.

Converts validated update changeset to request body format. Only includes fields that are present.

Validates and prepares parameters for creating an entity.

Validates parameters and raises on error.

Validates and prepares parameters for updating an entity. Only requires record field, identifier is optional.

Validates update parameters and raises on error.

Functions

to_request_body(changeset)

Converts validated changeset to request body format.

to_update_request_body(changeset)

Converts validated update changeset to request body format. Only includes fields that are present.

validate(attrs)

Validates and prepares parameters for creating an entity.

Parameters

  • attrs - Map containing entity parameters

Examples

iex> TamaEx.Memory.Entity.Params.validate(%{"identifier" => "my-entity", "record" => %{"name" => "test"}})
{:ok, %{"identifier" => "my-entity", "record" => %{"name" => "test"}, "validate_record" => true}}

iex> TamaEx.Memory.Entity.Params.validate(%{})
{:error, %Ecto.Changeset{}}

validate!(attrs)

Validates parameters and raises on error.

validate_update(attrs)

Validates and prepares parameters for updating an entity. Only requires record field, identifier is optional.

Parameters

  • attrs - Map containing entity parameters

Examples

iex> TamaEx.Memory.Entity.Params.validate_update(%{"record" => %{"name" => "updated"}})
{:ok, %{"record" => %{"name" => "updated"}, "validate_record" => true}}

iex> TamaEx.Memory.Entity.Params.validate_update(%{"identifier" => "new-id", "record" => %{"name" => "test"}})
{:ok, %{"identifier" => "new-id", "record" => %{"name" => "test"}, "validate_record" => true}}

iex> TamaEx.Memory.Entity.Params.validate_update(%{})
{:error, %Ecto.Changeset{}}

validate_update!(attrs)

Validates update parameters and raises on error.