Data.Apiary.Document

Synopsis

• data Documents = Documents {
  • noGroup :: [PathDoc]
  • groups :: [(Text, [PathDoc])]
  }
• data Route
  • = Path Text Route
  • | Fetch Text TypeRep (Maybe Html) Route
  • | Rest Text (Maybe Html)
  • | Any
  • | End
• data PathDoc = PathDoc {
  • path :: Route
  • methods :: [(Method, [MethodDoc])]
  }
• data MethodDoc = MethodDoc {
  • queries :: [QueryDoc]
  • preconditions :: [Html]
  • accept :: Maybe ByteString
  • document :: Text
  }
• data QueryDoc = QueryDoc {
  • queryName :: Text
  • queryStrategy :: StrategyRep
  • queryRep :: QueryRep
  • queryDocument :: Maybe Html
  }

Documentation