on master help sign in
Merge branch 'master' into query-param-method
6fc4c73Ivan Lazar Miljenovic
servant-docs/src/Servant/Docs.hs+2−1
@@ -43,12 +43,13 @@ module Servant.Docs
43 , -- * ADTs to represent an 'API'
43 , -- * ADTs to represent an 'API'
44 Endpoint, path, method, defEndpoint
44 Endpoint, path, method, defEndpoint
45 , API, apiIntros, apiEndpoints, emptyAPI
45 , API, apiIntros, apiEndpoints, emptyAPI
46+ , DocAuthentication(..), authIntro, authDataRequired
46 , DocCapture(..), capSymbol, capDesc
47 , DocCapture(..), capSymbol, capDesc
47 , DocQueryParam(..), ParamKind(..), paramName, paramValues, paramDesc, paramKind
48 , DocQueryParam(..), ParamKind(..), paramName, paramValues, paramDesc, paramKind
48 , DocNote(..), noteTitle, noteBody
49 , DocNote(..), noteTitle, noteBody
49 , DocIntro(..), introTitle, introBody
50 , DocIntro(..), introTitle, introBody
50 , Response(..), respStatus, respTypes, respBody, defResponse
51 , Response(..), respStatus, respTypes, respBody, defResponse
51− , Action, captures, headers, notes, params, rqtypes, rqbody, response, defAction
52+ , Action, authInfo, captures, headers, notes, params, rqtypes, rqbody, response, defAction
52 , single
53 , single
53 ) where
54 ) where
54
55
servant-docs/src/Servant/Docs/Internal.hs+1−1
@@ -264,7 +264,7 @@ combineAction :: Action -> Action -> Action
264Action a c h p n m ts body resp `combineAction` Action a' c' h' p' n' m' _ _ _ =
264Action a c h p n m ts body resp `combineAction` Action a' c' h' p' n' m' _ _ _ =
265 Action (a <> a') (c <> c') (h <> h') (p <> p') (n <> n') (m <> m') ts body resp
265 Action (a <> a') (c <> c') (h <> h') (p <> p') (n <> n') (m <> m') ts body resp
266
266
267−-- Default 'Action'. Has no 'captures', no query 'params', expects
267+-- | Default 'Action'. Has no 'captures', no query 'params', expects
268-- no request body ('rqbody') and the typical response is 'defResponse'.
268-- no request body ('rqbody') and the typical response is 'defResponse'.
269--
269--
270-- Tweakable with lenses.
270-- Tweakable with lenses.