version 0.1.3.4: update servant-swagger-ui (#21)

Author: maksbotan

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.3.4] - 2021-04-18
+### Changed
+- Move to `servant-swagger-ui-0.3.5.3.47.1`.
+
 ## [0.1.3.3] - 2020-12-12
 ### Changed
 - Log user id for requests where it's set.

app/ServantApp.hs

@@ -3,16 +3,16 @@
 {-# LANGUAGE TypeApplications  #-}
 {-# LANGUAGE TypeOperators     #-}
 
-import Data.Aeson         (encode)
-import Data.OpenApi       (OpenApi)
-import Data.Proxy         (Proxy (..))
-import Data.Text          (Text)
-import Servant            (Description, Get, Handler, JSON, PlainText, Post, ReqBody, Summary,
-                           (:<|>) (..), (:>))
-import Servant.OpenAPI.UI (OpenApiSchemaUI, openapiSchemaUIServer)
-import Servant.OpenApi    (toOpenApi)
+import Data.Aeson      (encode)
+import Data.OpenApi    (OpenApi)
+import Data.Proxy      (Proxy (..))
+import Data.Text       (Text)
+import Servant         (Description, Get, Handler, JSON, PlainText, Post, ReqBody, Summary,
+                        (:<|>) (..), (:>))
+import Servant.OpenApi (toOpenApi)
 
-import Web.Template.Servant (CbdAuth, UserId (..), Version, runServantServer)
+import Web.Template.Servant (CbdAuth, SwaggerSchemaUI, UserId (..), Version, runServantServer,
+                             swaggerSchemaUIServer)
 
 type API = Version "1" :>
   ( Summary "ping route" :> Description "Returns pong" :> "ping" :> Get '[PlainText] Text
@@ -38,5 +38,5 @@ main :: IO ()
 main = do
   print $ encode swagger
 
-  runServantServer @(OpenApiSchemaUI "swagger-ui" "swagger.json" :<|> API) 5000
-    $ openapiSchemaUIServer swagger :<|> (pingH :<|> (\userId -> helloH userId :<|> postH userId))
+  runServantServer @(SwaggerSchemaUI "swagger-ui" "swagger.json" :<|> API) 5000
+    $ swaggerSchemaUIServer swagger :<|> (pingH :<|> (\userId -> helloH userId :<|> postH userId))

cabal.project

@@ -2,23 +2,3 @@ packages: *.cabal
 
 package web-template
     ghc-options: -Wall
-
-source-repository-package
-    type: git
-    location: https://github.com/maksbotan/servant-swagger-ui
-    tag: 0e3a6c3dcc54e081ca499e0ed0a73b9a12b538a8
-    subdir: servant-swagger-ui-core
-
-source-repository-package
-    type: git
-    location: https://github.com/maksbotan/servant-swagger-ui
-    tag: 0e3a6c3dcc54e081ca499e0ed0a73b9a12b538a8
-    subdir: servant-swagger-ui
-
-source-repository-package
-    type: git
-    location: https://github.com/maksbotan/servant-swagger-ui
-    tag: 0e3a6c3dcc54e081ca499e0ed0a73b9a12b538a8
-    subdir: servant-openapi-ui
-
-allow-newer: servant-blaze:servant

src/Web/Template/Servant.hs

@@ -3,8 +3,8 @@ module Web.Template.Servant
   , runServantServerWith
   , runServantServerWithContext
 
-  , OpenApiSchemaUI
-  , openapiSchemaUIServer
+  , SwaggerSchemaUI
+  , swaggerSchemaUIServer
 
   , module Web.Template.Servant.Aeson
   , module Web.Template.Servant.API
@@ -15,7 +15,7 @@ module Web.Template.Servant
 import Data.Proxy               (Proxy (..))
 import Network.Wai              (Application)
 import Network.Wai.Handler.Warp (Settings, runSettings)
-import Servant.OpenAPI.UI       (OpenApiSchemaUI, openapiSchemaUIServer)
+import Servant.Swagger.UI       (SwaggerSchemaUI, swaggerSchemaUIServer)
 import Servant.Server           (Context, DefaultErrorFormatters, ErrorFormatters, HasContextEntry,
                                  HasServer, Server, serveWithContext, type (.++), (.++))
 

src/Web/Template/Servant/Aeson.hs

@@ -5,6 +5,7 @@ import Data.Aeson
 import Data.Aeson.Casing
 import Data.Functor      ((<&>))
 import Data.Proxy        (Proxy (..))
+import Data.Typeable     (Typeable)
 import GHC.Generics
 
 import Data.OpenApi
@@ -37,7 +38,7 @@ instance (Generic a, GToJSON Zero (Rep a), GToEncoding Zero (Rep a)) => ToJSON (
 instance (Generic a, GFromJSON Zero (Rep a)) => FromJSON (CamelCaseAeson a) where
   parseJSON = fmap CamelCaseAeson . genericParseJSON prefixOptions
 
-instance (Generic a, GToSchema (Rep a)) => ToSchema (CamelCaseAeson a) where
+instance (Generic a, GToSchema (Rep a), Typeable a) => ToSchema (CamelCaseAeson a) where
     declareNamedSchema _ =
       genericDeclareNamedSchema @a (fromAesonOptions prefixOptions) Proxy
 

web-template.cabal

@@ -1,5 +1,5 @@
 name:                web-template
-version:             0.1.3.3
+version:             0.1.3.4
 synopsis:            Web template
 description:
             Web template includes:
@@ -45,13 +45,13 @@ library
                      , http-types
                      , lens
                      , mtl
-                     , openapi3
+                     , openapi3 >= 3.1.0
                      , resourcet
                      , scotty
                      , servant >= 0.18
-                     , servant-openapi-ui >= 0.3.4
                      , servant-openapi3
                      , servant-server >= 0.18
+                     , servant-swagger-ui >= 0.3.5
                      , text
                      , time
                      , vault
@@ -92,9 +92,9 @@ executable web-template-servant
   build-depends:       base
                      , aeson
                      , openapi3
-                     , servant-openapi-ui
                      , servant-openapi3
                      , servant-server
+                     , servant-swagger-ui
                      , text
                      , wai
                      , warp