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
Show ActionInfo Source

data ActionType Source

Constructors

Retrieve
Create
Delete
DeleteMany
List
Update
UpdateMany
Modify

Instances

Eq ActionType Source
Show ActionType Source

data ActionTarget Source

Constructors

Self
Any

Instances

Eq ActionTarget Source
Show ActionTarget Source

data DataType Source

Constructors

String
XML
JSON
File
Other

Instances

Eq DataType Source
Show DataType Source

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
Show DataDesc Source

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
Show DataMeta Source

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
Show DataDescription Source

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

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