Data.Apiary.Document

Documentation

data Documents

Constructors

Documents

Fields

• noGroup :: [PathDoc]
• groups :: [(Text, [PathDoc])]

data Route

Constructors

Path Text Route

Fetch Text TypeRep (Maybe Html) Route

Rest Text (Maybe Html)

** with name

Any

** without name

End

Instances

Eq Route

Methods

(==) :: Route -> Route -> Bool

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

data PathDoc

Constructors

PathDoc

Fields

• path :: Route
• methods :: [(Method, [MethodDoc])]

data MethodDoc

Constructors

MethodDoc

Fields

• queries :: [QueryDoc]
• preconditions :: [Html]
• accept :: Maybe ByteString
• document :: Text

data QueryDoc

query parameters document

Constructors

QueryDoc

Fields

• queryName :: Text
• queryStrategy :: StrategyRep
• queryRep :: QueryRep
• queryDocument :: Maybe Html