Safe Haskell	Safe-Inferred
Language	Haskell2010

Hercules.API.Error

Synopsis

data Error = Error {
- errorTags :: [Text]
- message :: Text
}

Documentation

data Error Source #

General error type used in (some) HTTP error response bodies and in some resources.

Constructors

Error
Fields errorTags :: [Text] Symbolic names of the error condition; identifiers that clients may use to identify specific errors or classes of errors. message :: Text Human-readable error message.

Instances

Instances details

FromJSON Error Source #
Instance details Defined in Hercules.API.Error Methods parseJSON :: Value -> Parser Error # parseJSONList :: Value -> Parser [Error] #
ToJSON Error Source #
Instance details Defined in Hercules.API.Error Methods toJSON :: Error -> Value # toEncoding :: Error -> Encoding # toJSONList :: [Error] -> Value # toEncodingList :: [Error] -> Encoding #
Generic Error Source #
Instance details Defined in Hercules.API.Error Associated Types type Rep Error :: Type -> Type # Methods from :: Error -> Rep Error x # to :: Rep Error x -> Error #
Show Error Source #
Instance details Defined in Hercules.API.Error Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #
NFData Error Source #
Instance details Defined in Hercules.API.Error Methods rnf :: Error -> () #
Eq Error Source #
Instance details Defined in Hercules.API.Error Methods (==) :: Error -> Error -> Bool # (/=) :: Error -> Error -> Bool #
ToSchema Error Source #
Instance details Defined in Hercules.API.Error Methods declareNamedSchema :: Proxy Error -> Declare (Definitions Schema) NamedSchema #
ToSchema Error Source #
Instance details Defined in Hercules.API.Error Methods declareNamedSchema :: Proxy Error -> Declare (Definitions Schema) NamedSchema #
type Rep Error Source #
Instance details Defined in Hercules.API.Error type Rep Error = D1 ('MetaData "Error" "Hercules.API.Error" "hercules-ci-api-0.8.2.0-inplace" 'False) (C1 ('MetaCons "Error" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))