rest-gen-0.20.0.0: Documentation and client generation from rest definition.

Safe HaskellNone
LanguageHaskell98

Rest.Gen.Base.ActionInfo

Synopsis

Documentation

data DataType #

Constructors

String 
XML 
JSON 
File 
Other 

type ResourceId = [String] #

Representation of resource

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

data DataDesc #

Core information about the type of the input/output

Constructors

DataDesc 

Fields

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 :: 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 :: forall cat. ArrowApply cat => Lens cat DataDescription DataDesc #

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

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.

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

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] #

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