noahzgordon / elm-jsonapi / JsonApi

A library for processing and working with JSON API payloads.

Generic Data Types


type alias Document =
Data.Document

Data type representing the entire JsonApi document.


type alias Resource =
Data.Resource

Data type representing a single JsonApi resource.


type alias Links =
Data.Links

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


type alias Meta =
Data.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 Data.ErrorLinks
, status : Maybe String
, code : Maybe String
, title : Maybe String
, detail : Maybe String
, source : Maybe Data.Source
, meta : Meta 
}

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