Safe Haskell	None
Language	Haskell98

Rest.Gen.Base.ActionInfo

Synopsis

Documentation

type Accessor = (String, Maybe Ident) Source #

data ActionInfo Source #

Constructors

ActionInfo
Fields ident :: Maybe Ident postAction :: Bool actionType :: ActionType actionTarget :: ActionTarget resDir :: String method :: RequestMethod inputs :: [DataDescription] outputs :: [DataDescription] errors :: [DataDescription] params :: [String] https :: Bool link :: Link

Instances

Eq ActionInfo Source #
Methods (==) :: ActionInfo -> ActionInfo -> Bool # (/=) :: ActionInfo -> ActionInfo -> Bool #
Show ActionInfo Source #
Methods showsPrec :: Int -> ActionInfo -> ShowS # show :: ActionInfo -> String # showList :: [ActionInfo] -> ShowS #

data ActionType Source #

Constructors

Retrieve
Create
Delete
DeleteMany
List
Update
UpdateMany
Modify

Instances

Eq ActionType Source #
Methods (==) :: ActionType -> ActionType -> Bool # (/=) :: ActionType -> ActionType -> Bool #
Show ActionType Source #
Methods showsPrec :: Int -> ActionType -> ShowS # show :: ActionType -> String # showList :: [ActionType] -> ShowS #

data ActionTarget Source #

Constructors

Self
Any

Instances

Eq ActionTarget Source #
Methods (==) :: ActionTarget -> ActionTarget -> Bool # (/=) :: ActionTarget -> ActionTarget -> Bool #
Show ActionTarget Source #
Methods showsPrec :: Int -> ActionTarget -> ShowS # show :: ActionTarget -> String # showList :: [ActionTarget] -> ShowS #

data DataType Source #

Constructors

String
XML
JSON
File
Other

Instances

Eq DataType Source #
Methods (==) :: DataType -> DataType -> Bool # (/=) :: DataType -> DataType -> Bool #
Show DataType Source #
Methods showsPrec :: Int -> DataType -> ShowS # show :: DataType -> String # showList :: [DataType] -> ShowS #

type ResourceId = [String] Source #

Representation of resource

accessLink :: [Accessor] -> Link Source #

accessors :: Step sid mid aid -> [Accessor] Source #

chooseType :: NonEmpty DataDescription -> DataDescription Source #

data DataDesc Source #

Core information about the type of the input/output

Constructors

DataDesc
Fields _dataType :: DataType _haskellType :: Type _haskellModules :: [ModuleName]

Instances

Eq DataDesc Source #
Methods (==) :: DataDesc -> DataDesc -> Bool # (/=) :: DataDesc -> DataDesc -> Bool #
Show DataDesc Source #
Methods showsPrec :: Int -> DataDesc -> ShowS # show :: DataDesc -> String # showList :: [DataDesc] -> ShowS #

dataType :: forall cat. ArrowApply cat => Lens cat DataDesc DataType Source #

haskellType :: forall cat. ArrowApply cat => Lens cat DataDesc Type Source #

haskellModules :: forall cat. ArrowApply cat => Lens cat DataDesc [ModuleName] Source #

data DataMeta Source #

Documentation information about the input/output

Constructors

DataMeta
Fields _dataTypeDesc :: String The name of the DataType, or a custom value if dataType is Other _dataSchema :: Maybe String Just if dataType is XML _dataExample :: [String] Non empty if dataType is XML or JSON

Instances

Eq DataMeta Source #
Methods (==) :: DataMeta -> DataMeta -> Bool # (/=) :: DataMeta -> DataMeta -> Bool #
Show DataMeta Source #
Methods showsPrec :: Int -> DataMeta -> ShowS # show :: DataMeta -> String # showList :: [DataMeta] -> ShowS #

dataTypeDesc :: forall cat. ArrowApply cat => Lens cat DataMeta String Source #

dataSchema :: forall cat. ArrowApply cat => Lens cat DataMeta (Maybe String) Source #

dataExample :: forall cat. ArrowApply cat => Lens cat DataMeta [String] Source #

data DataDescription Source #

Combines the core and documentation information for input/output

Constructors

DataDescription
Fields _desc :: DataDesc _meta :: DataMeta

Instances

Eq DataDescription Source #
Methods (==) :: DataDescription -> DataDescription -> Bool # (/=) :: DataDescription -> DataDescription -> Bool #
Show DataDescription Source #
Methods showsPrec :: Int -> DataDescription -> ShowS # show :: DataDescription -> String # showList :: [DataDescription] -> ShowS #

desc :: forall cat. ArrowApply cat => Lens cat DataDescription DataDesc Source #

meta :: forall cat. ArrowApply cat => Lens cat DataDescription DataMeta Source #

data ResponseType Source #

Constructors

ResponseType
Fields errorType :: Maybe DataDesc outputType :: Maybe DataDesc

Instances

Show ResponseType Source #
Methods showsPrec :: Int -> ResponseType -> ShowS # show :: ResponseType -> String # showList :: [ResponseType] -> ShowS #

responseAcceptType :: ResponseType -> [DataType] Source #

dataTypesToAcceptHeader :: DataType -> [DataType] -> String Source #

First argument is the default accept header to use if there is no output or errors, must be XML or JSON.

chooseResponseType :: ActionInfo -> ResponseType Source #

isAccessor :: ActionInfo -> Bool Source #

listGetterActionInfo :: Resource m s sid mid aid -> String -> Getter mid -> [ActionInfo] Source #

mkActionDescription :: String -> ActionInfo -> String Source #

namedActionInfo :: Resource m s sid mid aid -> String -> Endpoint sid mid aid -> [ActionInfo] Source #

resourceToAccessors :: Resource m s sid mid aid -> [Accessor] Source #

resourceToActionInfo :: forall m s sid mid aid. Resource m s sid mid aid -> [ActionInfo] Source #

selectActionInfo :: Link -> String -> Handler m -> ActionInfo Source #

singleActionInfo :: Resource m s sid mid aid -> Maybe (Id sid) -> String -> [ActionInfo] Source #