1631ae6 · servant · git.iko.soy

git.iko.soy/servant

on master help sign in

remove serveDocumentation references/code

1631ae6Julian K. Arni11 years ago

servant-docs/src/Servant/Docs/Internal.hs−27

@@ -876,30 +876,3 @@ instance (KnownSymbol path, HasDocs sublayout) => HasDocs (path :> sublayout) wh

876 endpoint' = endpoint & path <>~ [symbolVal pa]

877 pa = Proxy :: Proxy path

878

879−{-

880−

881−-- | Serve your API's docs as markdown embedded in an html \<pre> tag.

882−--

883−-- > type MyApi = "users" :> Get [User]

884−-- > :<|> "docs :> Raw

885−-- >

886−-- > apiProxy :: Proxy MyApi

887−-- > apiProxy = Proxy

888−-- >

889−-- > server :: Server MyApi

890−-- > server = listUsers

891−-- > :<|> serveDocumentation apiProxy

892−serveDocumentation :: HasDocs api => Proxy api -> Server Raw

893−serveDocumentation proxy _request respond =

894− respond $ responseLBS ok200 [] $ cs $ toHtml $ markdown $ docs proxy

895−

896−toHtml :: String -> String

897−toHtml md =

898− "<html>" ++

899− "<body>" ++

900− "<pre>" ++

901− md ++

902− "</pre>" ++

903− "</body>" ++

904− "</html>"

905−-}

servant/src/Servant/API/Raw.hs+1−2

@@ -10,6 +10,5 @@ import Data.Typeable (Typeable)

10--

11-- In addition to just letting you plug in your existing WAI 'Application's,

12-- this can also be used with 'Servant.Utils.StaticFiles.serveDirectory' to serve

13−-- static files stored in a particular directory on your filesystem, or to serve

13+-- static files stored in a particular directory on your filesystem

14−-- your API's documentation with 'Servant.Utils.StaticFiles.serveDocumentation'.

15data Raw deriving Typeable

14data Raw deriving Typeable