Safe Haskell	None
Language	Haskell2010

Web.Scim.Schema.PatchOp

Synopsis

newtype PatchOp tag = PatchOp {
- getOperations :: [Operation]
}
data Operation = Operation {
- op :: Op
- path :: Maybe Path
- value :: Maybe Value
}
data Op
- = Add
- | Replace
- | Remove
data Path
- = NormalPath AttrPath
- | IntoValuePath ValuePath (Maybe SubAttr)
parsePath :: [Schema] -> Text -> Either String Path
pPath :: [Schema] -> Parser Path
rPath :: Path -> Text
operationFromJSON :: [Schema] -> Value -> Parser Operation
pathFromJSON :: [Schema] -> Value -> Parser Path
class Patchable a where
- applyOperation :: MonadError ScimError m => a -> Operation -> m a

Documentation

newtype PatchOp tag Source #

Constructors

PatchOp
Fields getOperations :: [Operation]

Instances

Instances details

Eq (PatchOp tag) Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods (==) :: PatchOp tag -> PatchOp tag -> Bool # (/=) :: PatchOp tag -> PatchOp tag -> Bool #
Show (PatchOp tag) Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods showsPrec :: Int -> PatchOp tag -> ShowS # show :: PatchOp tag -> String # showList :: [PatchOp tag] -> ShowS #
ToJSON (PatchOp tag) Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods toJSON :: PatchOp tag -> Value # toEncoding :: PatchOp tag -> Encoding # toJSONList :: [PatchOp tag] -> Value # toEncodingList :: [PatchOp tag] -> Encoding #
UserTypes tag => FromJSON (PatchOp tag) Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods parseJSON :: Value -> Parser (PatchOp tag) # parseJSONList :: Value -> Parser [PatchOp tag] #

data Operation Source #

The Path attribute value is a String containing an attribute path describing the target of the operation. It is OPTIONAL for Ops "add" and "replace", and is REQUIRED for "remove". See relevant operation sections below for details.

TODO(arianvp): When value is an array, it needs special handling. e.g. primary fields need to be negated and whatnot. We currently do not do that :)

NOTE: When the path contains a schema, this schema must be implicitly added to the list of schemas on the result type

Constructors

Operation
Fields op :: Op path :: Maybe Path value :: Maybe Value

Instances

Instances details

Eq Operation Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods (==) :: Operation -> Operation -> Bool # (/=) :: Operation -> Operation -> Bool #
Show Operation Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods showsPrec :: Int -> Operation -> ShowS # show :: Operation -> String # showList :: [Operation] -> ShowS #
ToJSON Operation Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods toJSON :: Operation -> Value # toEncoding :: Operation -> Encoding # toJSONList :: [Operation] -> Value # toEncodingList :: [Operation] -> Encoding #

data Op Source #

Constructors

Add
Replace
Remove

Instances

Instances details

Bounded Op Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods minBound :: Op # maxBound :: Op #
Enum Op Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods succ :: Op -> Op # pred :: Op -> Op # toEnum :: Int -> Op # fromEnum :: Op -> Int # enumFrom :: Op -> [Op] # enumFromThen :: Op -> Op -> [Op] # enumFromTo :: Op -> Op -> [Op] # enumFromThenTo :: Op -> Op -> Op -> [Op] #
Eq Op Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods (==) :: Op -> Op -> Bool # (/=) :: Op -> Op -> Bool #
Show Op Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods showsPrec :: Int -> Op -> ShowS # show :: Op -> String # showList :: [Op] -> ShowS #
ToJSON Op Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods toJSON :: Op -> Value # toEncoding :: Op -> Encoding # toJSONList :: [Op] -> Value # toEncodingList :: [Op] -> Encoding #
FromJSON Op Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods parseJSON :: Value -> Parser Op # parseJSONList :: Value -> Parser [Op] #

data Path Source #

PATH = attrPath / valuePath [subAttr]

Constructors

NormalPath AttrPath
IntoValuePath ValuePath (Maybe SubAttr)

Instances

Instances details

Eq Path Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods (==) :: Path -> Path -> Bool # (/=) :: Path -> Path -> Bool #
Show Path Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods showsPrec :: Int -> Path -> ShowS # show :: Path -> String # showList :: [Path] -> ShowS #
ToJSON Path Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods toJSON :: Path -> Value # toEncoding :: Path -> Encoding # toJSONList :: [Path] -> Value # toEncodingList :: [Path] -> Encoding #

parsePath :: [Schema] -> Text -> Either String Path Source #

pPath :: [Schema] -> Parser Path Source #

PATH = attrPath / valuePath [subAttr]

rPath :: Path -> Text Source #

operationFromJSON :: [Schema] -> Value -> Parser Operation Source #

pathFromJSON :: [Schema] -> Value -> Parser Path Source #

class Patchable a where Source #

A very coarse description of what it means to be Patchable I do not like it. We should handhold people using this library more

Methods

applyOperation :: MonadError ScimError m => a -> Operation -> m a Source #

Instances

Instances details

Patchable NoUserExtra Source #
Instance details Defined in Web.Scim.Schema.User Methods applyOperation :: MonadError ScimError m => NoUserExtra -> Operation -> m NoUserExtra Source #
(UserTypes tag, FromJSON (User tag), Patchable (UserExtra tag)) => Patchable (User tag) Source #
Instance details Defined in Web.Scim.Schema.User Methods applyOperation :: MonadError ScimError m => User tag -> Operation -> m (User tag) Source #
Patchable (HashMap Text Text) Source #
Instance details Defined in Web.Scim.Schema.PatchOp Methods applyOperation :: MonadError ScimError m => HashMap Text Text -> Operation -> m (HashMap Text Text) Source #