json-api-0.1.1.2: Utilities for generating JSON-API payloads

Safe HaskellNone
LanguageHaskell2010

Network.JSONApi.Error

Description

Module representing a JSON-API error object.

Error objects are used for providing application-specific detail to unsuccessful API responses.

Specification: http://jsonapi.org/format/#error-objects

Synopsis

Documentation

data Error a Source #

Type for providing application-specific detail to unsuccessful API responses.

Specification: http://jsonapi.org/format/#error-objects

Constructors

Error 

Fields

Instances

Eq (Error a) Source # 

Methods

(==) :: Error a -> Error a -> Bool #

(/=) :: Error a -> Error a -> Bool #

Show (Error a) Source # 

Methods

showsPrec :: Int -> Error a -> ShowS #

show :: Error a -> String #

showList :: [Error a] -> ShowS #

Generic (Error a) Source # 

Associated Types

type Rep (Error a) :: * -> * #

Methods

from :: Error a -> Rep (Error a) x #

to :: Rep (Error a) x -> Error a #

ToJSON a => ToJSON (Error a) Source # 

Methods

toJSON :: Error a -> Value #

toEncoding :: Error a -> Encoding #

FromJSON a => FromJSON (Error a) Source # 

Methods

parseJSON :: Value -> Parser (Error a) #

Default (Error a) Source # 

Methods

def :: Error a #

type Rep (Error a) Source #