Rest.Gen.Docs

Documentation

data DocsContext

Information about the context in which a resource is contained

Constructors

DocsContext

Fields

• rootUrl :: String
• contextVersion :: Version
• templates :: String

Instances

Eq DocsContext

Methods

(==) :: DocsContext -> DocsContext -> Bool

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

Show DocsContext

Methods

showsPrec :: Int -> DocsContext -> ShowS

show :: DocsContext -> String

showList :: [DocsContext] -> ShowS

cdiv :: String -> Html -> Html

cls :: String -> Attribute

Helper functions for generating HTML

mkAllResources :: DocsContext -> ApiResource -> IO String

mkSingleResource :: DocsContext -> ApiResource -> IO String

resourcesInfo :: DocsContext -> ApiResource -> Html

Recursively generate information for a resource structure

row :: Html -> Html

subResourcesInfo :: DocsContext -> ApiResource -> Html

writeDocs :: DocsContext -> Router m s -> String -> IO ()