README About Versions Source Modules

JsonApi

A library for processing and working with JSON API payloads.

Generic Data Types

type alias Document =

Document

Data type representing the entire JsonApi document.

type alias Resource =

Resource

Data type representing a single JsonApi resource.

type alias Links =

Links

Data type representing a JsonApi links object. See: jsonapi.org/format/#document-links

type alias Meta =

Meta

Data type representing a JsonApi meta object. Alias for Json.Encode.Value. See: jsonapi.org/format/#document-meta

type alias ErrorObject =

{ id : Maybe String

, links : Maybe ErrorLinks

, status : Maybe String

, code : Maybe String

, title : Maybe String

, detail : Maybe String

, source : Maybe Source

, meta : Meta

}

Data type describing the types of problems that can be encountered when processing a JSON API payload.

Modules