| Safe Haskell | None |
|---|
Rest.Gen.Base.ActionInfo
- type Accessor = (String, Maybe Ident)
- data ActionInfo = ActionInfo {
- 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
- data ActionType
- = Retrieve
- | Create
- | Delete
- | DeleteMany
- | List
- | Update
- | UpdateMany
- | Modify
- data ActionTarget
- data DataType
- type ResourceId = [String]
- accessLink :: [Accessor] -> Link
- accessors :: Step sid mid aid -> [Accessor]
- chooseType :: NonEmpty DataDescription -> DataDescription
- data DataDesc = DataDesc {}
- 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 = DataMeta {
- _dataTypeDesc :: String
- _dataSchema :: Maybe String
- _dataExample :: Maybe String
- 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 (Maybe String)
- data DataDescription = DataDescription {}
- desc :: forall cat. ArrowApply cat => Lens cat DataDescription DataDesc
- meta :: forall cat. ArrowApply cat => Lens cat DataDescription DataMeta
- data ResponseType = ResponseType {
- errorType :: Maybe DataDesc
- outputType :: Maybe DataDesc
- responseAcceptType :: ResponseType -> [DataType]
- dataTypesToAcceptHeader :: DataType -> [DataType] -> String
- 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]
Documentation
data ActionInfo Source
Constructors
| ActionInfo | |
Fields
| |
Instances
| Eq ActionInfo | |
| Show ActionInfo |
data ActionType Source
Constructors
| Retrieve | |
| Create | |
| Delete | |
| DeleteMany | |
| List | |
| Update | |
| UpdateMany | |
| Modify |
Instances
| Eq ActionType | |
| Show ActionType |
type ResourceId = [String]Source
Representation of resource
accessLink :: [Accessor] -> LinkSource
Core information about the type of the input/output
Constructors
| DataDesc | |
Fields
| |
haskellType :: forall cat. ArrowApply cat => Lens cat DataDesc TypeSource
haskellModules :: forall cat. ArrowApply cat => Lens cat DataDesc [ModuleName]Source
Documentation information about the input/output
Constructors
| DataMeta | |
Fields
| |
dataTypeDesc :: forall cat. ArrowApply cat => Lens cat DataMeta StringSource
dataSchema :: forall cat. ArrowApply cat => Lens cat DataMeta (Maybe String)Source
dataExample :: forall cat. ArrowApply cat => Lens cat DataMeta (Maybe String)Source
data DataDescription Source
Combines the core and documentation information for input/output
Constructors
| DataDescription | |
Instances
| Eq DataDescription | |
| Show DataDescription |
desc :: forall cat. ArrowApply cat => Lens cat DataDescription DataDescSource
meta :: forall cat. ArrowApply cat => Lens cat DataDescription DataMetaSource
data ResponseType Source
Constructors
| ResponseType | |
Fields
| |
Instances
| Show ResponseType |
dataTypesToAcceptHeader :: DataType -> [DataType] -> StringSource
First argument is the default accept header to use if there is no output or errors, must be XML or JSON.
isAccessor :: ActionInfo -> BoolSource
listGetterActionInfo :: Resource m s sid mid aid -> String -> Getter mid -> [ActionInfo]Source
mkActionDescription :: String -> ActionInfo -> StringSource
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 -> ActionInfoSource
singleActionInfo :: Resource m s sid mid aid -> Maybe (Id sid) -> String -> [ActionInfo]Source