From 8e67e26d632d7a837ebb3b97831b0011a779d713 Mon Sep 17 00:00:00 2001 From: Ivan Lazar Miljenovic Date: Fri, 28 Jul 2017 15:15:16 +1000 Subject: [PATCH 1/2] Export authentication-related types/lenses I'm assuming that they're not meant to be just in `.Internal`. --- servant-docs/src/Servant/Docs.hs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/servant-docs/src/Servant/Docs.hs b/servant-docs/src/Servant/Docs.hs index 9805285f..7209e258 100644 --- a/servant-docs/src/Servant/Docs.hs +++ b/servant-docs/src/Servant/Docs.hs @@ -43,12 +43,13 @@ module Servant.Docs , -- * ADTs to represent an 'API' Endpoint, path, method, defEndpoint , API, apiIntros, apiEndpoints, emptyAPI + , DocAuthentication(..), authIntro, authDataRequired , DocCapture(..), capSymbol, capDesc , DocQueryParam(..), ParamKind(..), paramName, paramValues, paramDesc, paramKind , DocNote(..), noteTitle, noteBody , DocIntro(..), introTitle, introBody , Response(..), respStatus, respTypes, respBody, defResponse - , Action, captures, headers, notes, params, rqtypes, rqbody, response, defAction + , Action, authInfo, captures, headers, notes, params, rqtypes, rqbody, response, defAction , single ) where From 31578b9bfac374b61c3f8ccb8b1e24727fe4eb4d Mon Sep 17 00:00:00 2001 From: Ivan Lazar Miljenovic Date: Fri, 28 Jul 2017 16:39:52 +1000 Subject: [PATCH 2/2] Make defAction's documentation visible to Haddock --- servant-docs/src/Servant/Docs/Internal.hs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/servant-docs/src/Servant/Docs/Internal.hs b/servant-docs/src/Servant/Docs/Internal.hs index f253715e..6f98c208 100644 --- a/servant-docs/src/Servant/Docs/Internal.hs +++ b/servant-docs/src/Servant/Docs/Internal.hs @@ -263,8 +263,8 @@ combineAction :: Action -> Action -> Action Action a c h p n m ts body resp `combineAction` Action a' c' h' p' n' m' _ _ _ = Action (a <> a') (c <> c') (h <> h') (p <> p') (n <> n') (m <> m') ts body resp --- Default 'Action'. Has no 'captures', no GET 'params', expects --- no request body ('rqbody') and the typical response is 'defResponse'. +-- | Default 'Action'. Has no 'captures', no GET 'params', expects no +-- request body ('rqbody') and the typical response is 'defResponse'. -- -- Tweakable with lenses. --