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

Update documentation such that it isn't just for GET

Browse source
This commit is contained in:
Ivan Lazar Miljenovic 2017-07-28 16:39:05 +10:00
parent 89e0a98ac5
commit 256ee41254
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
servant-docs/src/Servant/Docs/Internal.hs
View file

@ -125,9 +125,10 @@ data DocCapture = DocCapture
, _capDesc :: String -- user supplied , _capDesc :: String -- user supplied
} deriving (Eq, Ord, Show) } deriving (Eq, Ord, Show)
-- | A type to represent a /GET/ parameter from the Query String. Holds its name, -- | A type to represent a /GET/ (or other possible 'HTTP.Method')
-- the possible values (leave empty if there isn't a finite number of them), -- parameter from the Query String. Holds its name, the possible
-- and a description of how it influences the output or behavior. -- values (leave empty if there isn't a finite number of them), and
-- a description of how it influences the output or behavior.
-- --
-- Write a 'ToParam' instance for your GET parameter types -- Write a 'ToParam' instance for your GET parameter types
data DocQueryParam = DocQueryParam data DocQueryParam = DocQueryParam
@ -185,7 +186,7 @@ defaultDocOptions :: DocOptions
defaultDocOptions = DocOptions defaultDocOptions = DocOptions
{ _maxSamples = 5 } { _maxSamples = 5 }
-- | Type of GET parameter: -- | Type of GET (or other 'HTTP.Method') parameter:
-- --
-- - Normal corresponds to @QueryParam@, i.e your usual GET parameter -- - Normal corresponds to @QueryParam@, i.e your usual GET parameter
-- - List corresponds to @QueryParams@, i.e GET parameters with multiple values -- - List corresponds to @QueryParams@, i.e GET parameters with multiple values
@ -235,7 +236,7 @@ defResponse = Response
-- at an endpoint, with its lenses: -- at an endpoint, with its lenses:
-- --
-- - List of captures ('captures') -- - List of captures ('captures')
-- - List of GET parameters ('params') -- - List of GET (or other 'HTTP.Method') parameters ('params')
-- - What the request body should look like, if any is requested ('rqbody') -- - What the request body should look like, if any is requested ('rqbody')
-- - What the response should be if everything goes well ('response') -- - What the response should be if everything goes well ('response')
-- --
@ -263,7 +264,7 @@ combineAction :: Action -> Action -> Action
Action a c h p n m ts body resp `combineAction` Action a' c' h' p' n' m' _ _ _ = 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 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 -- Default 'Action'. Has no 'captures', no query 'params', expects
-- no request body ('rqbody') and the typical response is 'defResponse'. -- no request body ('rqbody') and the typical response is 'defResponse'.
-- --
-- Tweakable with lenses. -- Tweakable with lenses.
@ -487,8 +488,8 @@ sampleByteStrings ctypes@Proxy Proxy =
enc (t, s) = uncurry (t,,) <$> allMimeRender ctypes s enc (t, s) = uncurry (t,,) <$> allMimeRender ctypes s
in concatMap enc samples' in concatMap enc samples'
-- | The class that helps us automatically get documentation -- | The class that helps us automatically get documentation for GET
-- for GET parameters. -- (or other 'HTTP.Method') parameters.
-- --
-- Example of an instance: -- Example of an instance:
-- --