From ee6efdc1b48635e0d3c39a23b4b5dd95cb4a6180 Mon Sep 17 00:00:00 2001 From: Oleg Grenrus Date: Sun, 10 Feb 2019 19:03:48 +0200 Subject: [PATCH] Document GADT constructors --- src/GitHub/Data/Request.hs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/GitHub/Data/Request.hs b/src/GitHub/Data/Request.hs index 054e9e4d..a6cd2784 100644 --- a/src/GitHub/Data/Request.hs +++ b/src/GitHub/Data/Request.hs @@ -61,6 +61,8 @@ data CommandMethod a where Post :: CommandMethod a Patch :: CommandMethod a Put :: CommandMethod a + + -- | Put requests, where we don't care about response's body Put' :: CommandMethod () Delete :: CommandMethod () deriving (Typeable) @@ -146,6 +148,8 @@ data Request (k :: RW) a where SimpleQuery :: FromJSON a => SimpleRequest k a -> Request k a StatusQuery :: StatusMap a -> SimpleRequest k () -> Request k a HeaderQuery :: FromJSON a => Types.RequestHeaders -> SimpleRequest k a -> Request k a + + -- | Redirect query is /some/ query where we expect status 302 response with @Location@ header. RedirectQuery :: SimpleRequest k () -> Request k URI deriving (Typeable)