eeva/servant
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

use Capture Description if available

Browse Source
This commit is contained in:
Samuel Gélineau 2021-05-19 15:15:16 -04:00
parent 4016aafe66
commit 1f53a065a6
1 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
servant-docs/src/Servant/Docs/Internal.hs
View File

@ -862,7 +862,7 @@ instance HasDocs EmptyAPI where
-- | @"books" :> 'Capture' "isbn" Text@ will appear as
-- @/books/:isbn@ in the docs.
instance (KnownSymbol sym, ToCapture (Capture sym a), HasDocs api)
=> HasDocs (Capture' mods sym a :> api) where
=> HasDocs (Capture' '[] sym a :> api) where
docsFor Proxy (endpoint, action) =
docsFor subApiP (endpoint', action')
@ -874,6 +874,28 @@ instance (KnownSymbol sym, ToCapture (Capture sym a), HasDocs api)
endpoint' = over path (\p -> p ++ [":" ++ symbolVal symP]) endpoint
symP = Proxy :: Proxy sym
instance (KnownSymbol descr, KnownSymbol sym, HasDocs api)
=> HasDocs (Capture' (Description descr ': mods) sym a :> api) where
docsFor Proxy (endpoint, action) =
docsFor subApiP (endpoint', action')
where subApiP = Proxy :: Proxy api
docCapture = DocCapture (symbolVal symP) (symbolVal descrP)
action' = over captures (|> docCapture) action
endpoint' = over path (\p -> p ++ [":" ++ symbolVal symP]) endpoint
descrP = Proxy :: Proxy descr
symP = Proxy :: Proxy sym
instance {-# OVERLAPPABLE #-} HasDocs (Capture' mods sym a :> api)
=> HasDocs (Capture' (mod ': mods) sym a :> api) where
docsFor Proxy =
docsFor apiP
where apiP = Proxy :: Proxy (Capture' mods sym a :> api)
-- | @"books" :> 'CaptureAll' "isbn" Text@ will appear as
-- @/books/:isbn@ in the docs.