Safe Haskell	None
Language	Haskell2010

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

data Error a = Error {
- id :: Maybe Text
- links :: Maybe Links
- status :: Maybe Text
- code :: Maybe Text
- title :: Maybe Text
- detail :: Maybe Text
- meta :: Maybe Meta
}

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 id :: Maybe Text links :: Maybe Links status :: Maybe Text code :: Maybe Text title :: Maybe Text detail :: Maybe Text meta :: Maybe Meta

Instances

Eq (Error a) Source #
Instance details Defined in Network.JSONApi.Error Methods (==) :: Error a -> Error a -> Bool # (/=) :: Error a -> Error a -> Bool #
Show (Error a) Source #
Instance details Defined in Network.JSONApi.Error Methods showsPrec :: Int -> Error a -> ShowS # show :: Error a -> String # showList :: [Error a] -> ShowS #
Generic (Error a) Source #
Instance details Defined in Network.JSONApi.Error Associated Types type Rep (Error a) :: Type -> Type # Methods from :: Error a -> Rep (Error a) x # to :: Rep (Error a) x -> Error a #
ToJSON a => ToJSON (Error a) Source #
Instance details Defined in Network.JSONApi.Error Methods toJSON :: Error a -> Value # toEncoding :: Error a -> Encoding # toJSONList :: [Error a] -> Value # toEncodingList :: [Error a] -> Encoding #
FromJSON a => FromJSON (Error a) Source #
Instance details Defined in Network.JSONApi.Error Methods parseJSON :: Value -> Parser (Error a) # parseJSONList :: Value -> Parser [Error a] #
Default (Error a) Source #
Instance details Defined in Network.JSONApi.Error Methods def :: Error a #
NFData a => NFData (Error a) Source #
Instance details Defined in Network.JSONApi.Error Methods rnf :: Error a -> () #
type Rep (Error a) Source #
Instance details Defined in Network.JSONApi.Error type Rep (Error a) = D1 (MetaData "Error" "Network.JSONApi.Error" "json-api-lib-0.1.3.0-6YcBiX2ASZQ3iU3wpNCPjK" False) (C1 (MetaCons "Error" PrefixI True) ((S1 (MetaSel (Just "id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "links") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Links)) :: S1 (MetaSel (Just "status") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "code") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "title") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "detail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "meta") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Meta))))))