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

Safe HaskellNone
LanguageHaskell98

Rest.Gen.Base.ActionInfo

Synopsis

Documentation

data ActionTarget Source

Constructors

Self 
Any 

data DataType Source

Constructors

String 
XML 
JSON 
File 
Other 

Instances

type ResourceId = [String] Source

Representation of resource

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

data DataDesc Source

Core information about the type of the input/output

Instances

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

haskellType :: forall cat. ArrowApply cat => Lens cat DataDesc Type 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 :: Maybe String

Just if dataType is XML or JSON

Instances

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 (Maybe String) Source

data DataDescription Source

Combines the core and documentation information for input/output

Constructors

DataDescription 

Fields

_desc :: DataDesc
 
_meta :: DataMeta
 

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.

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

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

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

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