Settings API Reference jsonapi_plug v1.0.1

JSONAPIPlug context

JSON:API API Configuration

JSON:API Document

JSON:API Error Object

JSON:API Document JSON:API Object

JSON:API Link Object

JSON:API Relationship Object

JSON:API Resource Identifier object

JSON:API Resource Object

Defines a generic exception for when an invalid document is received.

Defines a generic exception for when an invalid header is received.

Defines a generic exception for when an invalid query parameter is received.

Transforms user data to and from a JSON:API Document.

JSON:API Document normalizer implementation for Ecto

JSON:API Pagination strategy

Implements validation and parsing of JSON:API requests

Provides content type negotiation by validating the content-type and accept headers.

Plug for parsing the JSON:API Document in requests

JSON:API Query Paramter parser plug

Plug for setting the response content type

Parses a JSON:API query parameter to a user defined format.

JSON:API 'fields' query parameter parser implementation for Ecto

JSON:API 'include' query parameter parser implementation for Ecto

JSON:API 'sort' query parameter parser implementation for Ecto

JSON:API 'filter' query parameter parser

JSON:API 'page' query parameter parser

A Resource is simply a module that describes how to render your data as JSON:API resources.