Safe Haskell	Safe-Inferred
Language	Haskell2010

Web.Scim.Schema.Error

Contents

Types
Constructors
Servant interoperability

Description

SCIM errors

Synopsis

data ScimErrorType
- = InvalidFilter
- | TooMany
- | Uniqueness
- | Mutability
- | InvalidSyntax
- | InvalidPath
- | NoTarget
- | InvalidValue
- | InvalidVers
- | Sensitive
data ScimError = ScimError {
- schemas :: [Schema]
- status :: Status
- scimType :: Maybe ScimErrorType
- detail :: Maybe Text
}
newtype Status = Status {
- unStatus :: Int
}
notFound :: Text -> Text -> ScimError
badRequest :: ScimErrorType -> Maybe Text -> ScimError
conflict :: ScimError
unauthorized :: Text -> ScimError
forbidden :: Text -> ScimError
serverError :: Text -> ScimError
scimToServerError :: ScimError -> ServerError

Types

data ScimErrorType Source #

An ADT for error types in the SCIM specification. Not all possible SCIM errors have a corresponding ScimErrorType (for instance, authorization is not covered by this type).

See https://tools.ietf.org/html/rfc7644#page-69

Constructors

InvalidFilter
TooMany
Uniqueness
Mutability
InvalidSyntax
InvalidPath
NoTarget
InvalidValue
InvalidVers
Sensitive

Instances

Instances details

ToJSON ScimErrorType Source #
Instance details Defined in Web.Scim.Schema.Error Methods toJSON :: ScimErrorType -> Value # toEncoding :: ScimErrorType -> Encoding # toJSONList :: [ScimErrorType] -> Value # toEncodingList :: [ScimErrorType] -> Encoding #
Generic ScimErrorType Source #
Instance details Defined in Web.Scim.Schema.Error Associated Types type Rep ScimErrorType :: Type -> Type # Methods from :: ScimErrorType -> Rep ScimErrorType x # to :: Rep ScimErrorType x -> ScimErrorType #
Show ScimErrorType Source #
Instance details Defined in Web.Scim.Schema.Error Methods showsPrec :: Int -> ScimErrorType -> ShowS # show :: ScimErrorType -> String # showList :: [ScimErrorType] -> ShowS #
Eq ScimErrorType Source #
Instance details Defined in Web.Scim.Schema.Error Methods (==) :: ScimErrorType -> ScimErrorType -> Bool # (/=) :: ScimErrorType -> ScimErrorType -> Bool #
type Rep ScimErrorType Source #
Instance details Defined in Web.Scim.Schema.Error type Rep ScimErrorType = D1 ('MetaData "ScimErrorType" "Web.Scim.Schema.Error" "hscim-0.4.0.4-2j6MXcQGp1TDKeruswPvhg" 'False) (((C1 ('MetaCons "InvalidFilter" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TooMany" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Uniqueness" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Mutability" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InvalidSyntax" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "InvalidPath" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoTarget" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "InvalidValue" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "InvalidVers" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Sensitive" 'PrefixI 'False) (U1 :: Type -> Type)))))

data ScimError Source #

Constructors

ScimError
Fields schemas :: [Schema] status :: Status scimType :: Maybe ScimErrorType detail :: Maybe Text

Instances

Instances details

ToJSON ScimError Source #
Instance details Defined in Web.Scim.Schema.Error Methods toJSON :: ScimError -> Value # toEncoding :: ScimError -> Encoding # toJSONList :: [ScimError] -> Value # toEncodingList :: [ScimError] -> Encoding #
Exception ScimError Source #
Instance details Defined in Web.Scim.Schema.Error Methods toException :: ScimError -> SomeException # fromException :: SomeException -> Maybe ScimError # displayException :: ScimError -> String #
Generic ScimError Source #
Instance details Defined in Web.Scim.Schema.Error Associated Types type Rep ScimError :: Type -> Type # Methods from :: ScimError -> Rep ScimError x # to :: Rep ScimError x -> ScimError #
Show ScimError Source #
Instance details Defined in Web.Scim.Schema.Error Methods showsPrec :: Int -> ScimError -> ShowS # show :: ScimError -> String # showList :: [ScimError] -> ShowS #
Eq ScimError Source #
Instance details Defined in Web.Scim.Schema.Error Methods (==) :: ScimError -> ScimError -> Bool # (/=) :: ScimError -> ScimError -> Bool #
type Rep ScimError Source #
Instance details Defined in Web.Scim.Schema.Error type Rep ScimError = D1 ('MetaData "ScimError" "Web.Scim.Schema.Error" "hscim-0.4.0.4-2j6MXcQGp1TDKeruswPvhg" 'False) (C1 ('MetaCons "ScimError" 'PrefixI 'True) ((S1 ('MetaSel ('Just "schemas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Schema]) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status)) :: (S1 ('MetaSel ('Just "scimType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ScimErrorType)) :*: S1 ('MetaSel ('Just "detail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

newtype Status Source #

Constructors

Status
Fields unStatus :: Int

Instances

Instances details

ToJSON Status Source #
Instance details Defined in Web.Scim.Schema.Error Methods toJSON :: Status -> Value # toEncoding :: Status -> Encoding # toJSONList :: [Status] -> Value # toEncodingList :: [Status] -> Encoding #
Generic Status Source #
Instance details Defined in Web.Scim.Schema.Error Associated Types type Rep Status :: Type -> Type # Methods from :: Status -> Rep Status x # to :: Rep Status x -> Status #
Show Status Source #
Instance details Defined in Web.Scim.Schema.Error Methods showsPrec :: Int -> Status -> ShowS # show :: Status -> String # showList :: [Status] -> ShowS #
Eq Status Source #
Instance details Defined in Web.Scim.Schema.Error Methods (==) :: Status -> Status -> Bool # (/=) :: Status -> Status -> Bool #
type Rep Status Source #
Instance details Defined in Web.Scim.Schema.Error type Rep Status = D1 ('MetaData "Status" "Web.Scim.Schema.Error" "hscim-0.4.0.4-2j6MXcQGp1TDKeruswPvhg" 'True) (C1 ('MetaCons "Status" 'PrefixI 'True) (S1 ('MetaSel ('Just "unStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

Constructors

notFound Source #

Arguments

:: Text	Resource type
-> Text	Resource ID
-> ScimError

badRequest Source #

Arguments

:: ScimErrorType	Error type
-> Maybe Text	Error details
-> ScimError

conflict :: ScimError Source #

unauthorized Source #

Arguments

:: Text	Error details
-> ScimError

forbidden Source #

Arguments

:: Text	Error details
-> ScimError

serverError Source #

Arguments

:: Text	Error details
-> ScimError

Servant interoperability

scimToServerError :: ScimError -> ServerError Source #

Convert a SCIM Error to a Servant one by encoding it with the appropriate headers.