calcinator v5.0.0 API Reference

Modules

Converts actions from a controller or RPC server using JSONAPI formatted params to calls on a Calcinator.Resources module

Alembic.Document.t for errors added by Calcinator on top of Alembic.Error

Alembic.Error.t for errors added by Calcinator on top of Alembic.Error

Behaviour for Calcinator.Resources.t authorization_module

Calcinator.Authorization where filter_associations_can/3 and filter_can/3 are implemented in terms of can/3, so only can/3 needs to be implemented

Allows all actions to all targets, but only if there is no subject. Only use if your system wants no authorization at all

Errors returned by Calcinator.Controller. Public, so that other controllers not using Calcinator.Controller can have same format for errors

Similar to Phoenix, Calcinator supports instrumenters that can receive events from Calcinator

Stores and extracts BEAM metadata from JSONAPI meta

Collects metrics about

Defines "get_related_resource.json-api" render/2 clauses that defer to render_related_resource/2 callbacks

Defines "show_relationhip.json-api" render/2 clauses that defer to render_relationship/2 and render_relationship_links/1 callbacks

A module that exposes Ecto schema structs

Default callbacks for Calcinator.Resources behaviour when backed by a single Ecto.Repo

Page in Calcinator.Resources.query_options

Sort in Calcinator.Resources.query_options

Sorts in Calcinator.Resources.query_options

Mix Tasks

Waits for connection to work to the given repository