Servant MultiVerb

CHANGELOG.md

@@ -54,6 +54,8 @@ Upgrade nginz (#1658)
 
 ## Documentation
 
+* Improved Swagger documentation for endpoints with multiple responses (#1649).
+
 ## Internal changes
 
 * The servant-swagger dependency now points to the current upstream master (#1656).
@@ -103,6 +105,7 @@ This release requires a manual change in your galley configuration: `settings.co
 * [Federation] Adjust scripts under ./hack/federation to work with recent changes to the federation API (#1632).
 * Refactored Proteus endpoint to work with qualified users (#1634).
 * Refactored Federator InternalServer (#1637)
+* Introduced `MultiVerb` endpoints in Servant API (#1649).
 
 ### Internal Federation API changes
 

libs/metrics-wai/src/Data/Metrics/Servant.hs

@@ -97,7 +97,7 @@ instance
   where
   getRoutes = [Node (Left (cs (":" <> symbolVal (Proxy @capture)))) (getRoutes @segs)]
 
--- route :> routes
+-- route :<|> routes
 instance
   {-# OVERLAPPING #-}
   ( RoutesToPaths route,
@@ -107,79 +107,13 @@ instance
   where
   getRoutes = getRoutes @route <> getRoutes @routes
 
--- stuff to ignore
-instance {-# OVERLAPPING #-} RoutesToPaths (Verb 'HEAD status ctypes content) where
-  getRoutes = []
-
-instance {-# OVERLAPPING #-} RoutesToPaths (Verb 'GET status ctypes content) where
-  getRoutes = []
-
-instance {-# OVERLAPPING #-} RoutesToPaths (Verb 'POST status ctypes content) where
-  getRoutes = []
-
-instance {-# OVERLAPPING #-} RoutesToPaths (Verb 'PUT status ctypes content) where
-  getRoutes = []
-
-instance {-# OVERLAPPING #-} RoutesToPaths (Verb 'DELETE status ctypes content) where
-  getRoutes = []
-
-instance {-# OVERLAPPING #-} RoutesToPaths (Verb 'PATCH status ctypes content) where
-  getRoutes = []
-
-instance RoutesToPaths (NoContentVerb 'DELETE) where
-  getRoutes = []
-
-instance {-# OVERLAPPING #-} RoutesToPaths (UVerb 'HEAD ctypes content) where
-  getRoutes = []
-
-instance {-# OVERLAPPING #-} RoutesToPaths (UVerb 'GET ctypes content) where
-  getRoutes = []
-
-instance {-# OVERLAPPING #-} RoutesToPaths (UVerb 'POST ctypes content) where
-  getRoutes = []
-
-instance {-# OVERLAPPING #-} RoutesToPaths (UVerb 'PUT ctypes content) where
-  getRoutes = []
-
-instance {-# OVERLAPPING #-} RoutesToPaths (UVerb 'DELETE ctypes content) where
-  getRoutes = []
-
-instance {-# OVERLAPPING #-} RoutesToPaths (UVerb 'PATCH ctypes content) where
-  getRoutes = []
-
-instance RoutesToPaths Raw where
-  getRoutes = []
-
-instance
-  {-# OVERLAPPING #-}
-  ( RoutesToPaths segs
-  ) =>
-  RoutesToPaths (ReqBody ctypes content :> segs)
-  where
-  getRoutes = getRoutes @segs
-
-instance
-  {-# OVERLAPPING #-}
-  ( KnownSymbol sym,
-    RoutesToPaths segs
-  ) =>
-  RoutesToPaths (Header sym content :> segs)
-  where
-  getRoutes = getRoutes @segs
-
-instance
-  {-# OVERLAPPING #-}
-  ( KnownSymbol sym,
-    RoutesToPaths segs
-  ) =>
-  RoutesToPaths (QueryParam sym content :> segs)
-  where
-  getRoutes = getRoutes @segs
-
 instance
   {-# OVERLAPPABLE #-}
   ( RoutesToPaths segs
   ) =>
   RoutesToPaths (anything :> segs)
   where
   getRoutes = getRoutes @segs
+
+instance {-# OVERLAPPABLE #-} RoutesToPaths anything where
+  getRoutes = []

libs/wire-api/package.yaml

@@ -56,8 +56,11 @@ library:
   - proto-lens
   - QuickCheck >=2.14
   - quickcheck-instances >=0.3.16
+  - resourcet
   - saml2-web-sso
   - servant
+  - servant-client
+  - servant-client-core
   - servant-multipart
   - servant-server
   - servant-swagger