Rest.Gen.Base.ActionInfo

Documentation

type Accessor = (String, Maybe Ident)

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
• link :: Link

Instances

Eq ActionInfo

Methods

(==) :: ActionInfo -> ActionInfo -> Bool

(/=) :: ActionInfo -> ActionInfo -> Bool

Show ActionInfo

Methods

showsPrec :: Int -> ActionInfo -> ShowS

show :: ActionInfo -> String

showList :: [ActionInfo] -> ShowS

data ActionType

Constructors

Retrieve

Create

Delete

DeleteMany

List

Update

UpdateMany

Modify

Instances

Eq ActionType

Methods

(==) :: ActionType -> ActionType -> Bool

(/=) :: ActionType -> ActionType -> Bool

Show ActionType

Methods

showsPrec :: Int -> ActionType -> ShowS

show :: ActionType -> String

showList :: [ActionType] -> ShowS

data ActionTarget

Constructors

Self

Any

Instances

Eq ActionTarget

Methods

(==) :: ActionTarget -> ActionTarget -> Bool

(/=) :: ActionTarget -> ActionTarget -> Bool

Show ActionTarget

Methods

showsPrec :: Int -> ActionTarget -> ShowS

show :: ActionTarget -> String

showList :: [ActionTarget] -> ShowS

data DataType

Constructors

String

XML

JSON

File

Other

Instances

Eq DataType

Methods

(==) :: DataType -> DataType -> Bool

(/=) :: DataType -> DataType -> Bool

Show DataType

Methods

showsPrec :: Int -> DataType -> ShowS

show :: DataType -> String

showList :: [DataType] -> ShowS

type ResourceId = [String]

Representation of resource

accessLink :: [Accessor] -> Link

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

chooseType :: NonEmpty DataDescription -> DataDescription

data DataDesc

Core information about the type of the input/output

Constructors

DataDesc

Fields

• _dataType :: DataType
• _haskellType :: Type
• _haskellModules :: [ModuleName]

Instances

Eq DataDesc

Methods

(==) :: DataDesc -> DataDesc -> Bool

(/=) :: DataDesc -> DataDesc -> Bool

Show DataDesc

Methods

showsPrec :: Int -> DataDesc -> ShowS

show :: DataDesc -> String

showList :: [DataDesc] -> ShowS

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

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

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

data DataMeta

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

Methods

(==) :: DataMeta -> DataMeta -> Bool

(/=) :: DataMeta -> DataMeta -> Bool

Show DataMeta

Methods

showsPrec :: Int -> DataMeta -> ShowS

show :: DataMeta -> String

showList :: [DataMeta] -> ShowS

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

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

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

data DataDescription

Combines the core and documentation information for input/output

Constructors

DataDescription

Fields

• _desc :: DataDesc
• _meta :: DataMeta

Instances

Eq DataDescription

Methods

(==) :: DataDescription -> DataDescription -> Bool

(/=) :: DataDescription -> DataDescription -> Bool

Show DataDescription

Methods

showsPrec :: Int -> DataDescription -> ShowS

show :: DataDescription -> String

showList :: [DataDescription] -> ShowS

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

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

data ResponseType

Constructors

ResponseType

Fields

• errorType :: Maybe DataDesc
• outputType :: Maybe DataDesc

Instances

Show ResponseType

Methods

showsPrec :: Int -> ResponseType -> ShowS

show :: ResponseType -> String

showList :: [ResponseType] -> ShowS

responseAcceptType :: ResponseType -> [DataType]

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

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

chooseResponseType :: ActionInfo -> ResponseType

isAccessor :: ActionInfo -> Bool

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

mkActionDescription :: String -> ActionInfo -> String

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

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

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

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

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