Rest.Gen.Docs.Generate

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

Show DocsContext

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

writeSingleResource :: DocsContext -> String -> ApiResource -> IO ()

mkAllResources :: DocsContext -> ApiResource -> IO String

mkSingleResource :: DocsContext -> ApiResource -> IO String

cls :: String -> Attribute

Helper functions for generating HTML

cdiv :: String -> Html -> Html

row :: Html -> Html

resourcesInfo :: DocsContext -> ApiResource -> Html

Recursively generate information for a resource structure

subResourcesInfo :: DocsContext -> ApiResource -> Html

resourceInfo :: DocsContext -> ApiResource -> Html

Generate information for one resource

resourceIdentifiers :: Link -> [Link] -> [Html]

resourceTable :: ApiResource -> Html

dataDescriptions :: String -> [DataDescription] -> Html

Generate information for input/output data structure

mkCode :: String -> String -> String -> Html

Helper function for setting the right attributes to make something collapsible. The javascript prt can be found in docs.js

resourceId :: ResourceId -> String

resourceDisp :: ResourceId -> Html

resourceLinkAnchor :: ResourceId -> Html -> Html

resourceLinkRemote :: String -> ResourceId -> Html -> Html

resourceAnchor :: ResourceId -> Html

linkHtml :: Link -> Html