calcinator v2.1.0 API Reference

Modules

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

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

Attempts to show Ecto changeset errors in JSON:API compliant fashion

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

Stores and extracts BEAM metadata from JSONAPI meta

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