Rest.Gen.Base.ActionInfo

The types describing a resource's actions.

type ResourceId = [String]

Representation of resource

data RequestMethod

Intermediate data representation of Rest structure

Constructors

GET

POST

PUT

DELETE

Instances

Eq RequestMethod

Show RequestMethod

data ActionType

Constructors

Retrieve

Create

Delete

List

Update

UpdateMany

Modify

Instances

Eq ActionType

Show ActionType

data ActionTarget

Constructors

Self

Any

Instances

Eq ActionTarget

Show ActionTarget

data ActionInfo

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

Instances

Eq ActionInfo

Show ActionInfo

isAccessor :: ActionInfo -> Bool

data DataType

Constructors

String

XML

JSON

File

Other

Instances

Eq DataType

Show DataType

data DataDescription

Description of input/output data

Constructors

DataDescription

Fields

dataType :: DataType

dataTypeDesc :: String

dataSchema :: String

dataExample :: String

haskellType :: String

haskellModule :: [String]

Instances

Eq DataDescription

Show DataDescription

defaultDescription :: DataDescription

chooseType :: [DataDescription] -> Maybe DataDescription

Traverse a resource's Schema and Handlers to create a [ActionInfo].

resourceToActionInfo :: Resource m s sid mid aid -> [ActionInfo]

topLevelActionInfo :: Resource m s sid mid aid -> Cardinality sid mid -> [ActionInfo]

stepActionInfo :: Resource m s sid mid aid -> Step sid mid aid -> [ActionInfo]

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

unnamedActionInfo :: Resource m s sid mid aid -> Cardinality (Id sid) (Id mid) -> [ActionInfo]

getterActionInfo :: Resource m s sid mid aid -> String -> Getter sid -> [ActionInfo]

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

listIdErr :: mid

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

Smart constructors for ActionInfo.

getActionInfo :: Maybe (Id sid) -> String -> Handler m -> ActionInfo

updateActionInfo :: Maybe (Id sid) -> String -> Handler m -> ActionInfo

multiUpdateActionInfo :: Monad m => Id sid -> String -> Handler m -> Maybe ActionInfo

removeActionInfo :: Handler m -> ActionInfo

listActionInfo :: Monad m => Maybe (Id mid) -> String -> ListHandler m -> Maybe ActionInfo

staticActionInfo :: String -> Handler m -> ActionInfo

createActionInfo :: Handler m -> ActionInfo

selectActionInfo :: String -> Handler m -> ActionInfo

actionActionInfo :: String -> Handler m -> ActionInfo

handlerActionInfo :: Maybe (Id id) -> Bool -> ActionType -> ActionTarget -> String -> RequestMethod -> Handler m -> ActionInfo

Utilities for extraction information from Handlers.

handlerParams :: GenHandler m f -> [String]

paramNames :: Param a -> [String]

A Param can contain the same parameter multiple times. For example, offset and count are added in Rest.Handler.mkListing, and in Rest.Driver.Routing.mkListHandler. For that reason, we nub here.

paramNames_ :: Param a -> [String]

handlerInputs :: Handler m -> [DataDescription]

Extract input description from handlers

handlerOutputs :: Handler m -> [DataDescription]

Extract output description from handlers

handlerErrors :: Handler m -> [DataDescription]

Extract input description from handlers

typeString :: forall a. Typeable a => Proxy a -> String

modString :: forall a. Typeable a => Proxy a -> [String]

idIdent :: Id id -> Ident

actionIdent :: forall a. Ident a -> Ident

mkActionDescription :: String -> ActionInfo -> String