servant-swagger-ui-core 0.3.1 → 0.3.2
raw patch · 4 files changed
+22/−59 lines, 4 filesdep −eitherdep ~basedep ~http-mediadep ~servantsetup-changedPVP: major bump suggested
API removals or changes: PVP suggests a major version bump
Dependencies removed: either
Dependency ranges changed: base, http-media, servant, servant-blaze, servant-server, swagger2, text
API changes (from Hackage documentation)
- Servant.Swagger.UI.Core: instance (GHC.TypeLits.KnownSymbol dir, Servant.Utils.Links.HasLink api, Servant.Utils.Links.Link ~ Servant.Utils.Links.MkLink api, Servant.API.TypeLevel.IsElem api api) => Text.Blaze.ToMarkup (Servant.Swagger.UI.Core.SwaggerUiHtml dir api)
+ Servant.Swagger.UI.Core: instance (GHC.TypeLits.KnownSymbol dir, Servant.Links.HasLink api, Servant.Links.Link ~ Servant.Links.MkLink api Servant.Links.Link, Servant.API.TypeLevel.IsElem api api) => Text.Blaze.ToMarkup (Servant.Swagger.UI.Core.SwaggerUiHtml dir api)
- Servant.Swagger.UI.Core: data Handler a :: * -> *
+ Servant.Swagger.UI.Core: data Handler a
- Servant.Swagger.UI.Core: type SwaggerSchemaUI' (dir :: Symbol) (api :: *) = api :<|> (dir :> (Get '[HTML] (SwaggerUiHtml dir api) :<|> (("index.html" :> Get '[HTML] (SwaggerUiHtml dir api)) :<|> Raw)))
+ Servant.Swagger.UI.Core: type SwaggerSchemaUI' (dir :: Symbol) (api :: *) = api :<|> dir :> (Get '[HTML] (SwaggerUiHtml dir api) :<|> "index.html" :> Get '[HTML] (SwaggerUiHtml dir api) :<|> Raw)
Files
- Changelog.md +5/−0
- Setup.hs +0/−2
- servant-swagger-ui-core.cabal +14/−26
- src/Servant/Swagger/UI/Core.hs +3/−31
Changelog.md view
@@ -1,3 +1,8 @@+# 0.3.2++- Support GHC-8.6.+- Drop servant <0.14 support+ # 0.3.1 - Support `servant-0.14`
− Setup.hs
@@ -1,2 +0,0 @@-import Distribution.Simple-main = defaultMain
servant-swagger-ui-core.cabal view
@@ -1,6 +1,6 @@ cabal-version: 1.12 name: servant-swagger-ui-core-version: 0.3.1+version: 0.3.2 synopsis: Servant swagger ui core components category: Web, Servant, Swagger@@ -17,7 +17,7 @@ license: BSD3 license-file: LICENSE build-type: Simple-tested-with: GHC ==7.8.4 || ==7.10.3 || ==8.0.2 || ==8.2.2 || ==8.4.3+tested-with: GHC ==7.8.4 || ==7.10.3 || ==8.0.2 || ==8.2.2 || ==8.4.4 || ==8.6.1 extra-source-files: Changelog.md @@ -25,36 +25,24 @@ type: git location: https://github.com/haskell-servant/servant-swagger-ui -flag servant-0-5- description: Whether use servant >= 0.5- manual: False- default: True- library hs-source-dirs: src ghc-options: -Wall build-depends:- base >=4.7 && <4.12- , blaze-markup >=0.7.0.2 && <0.9- , bytestring >=0.10.4.0 && <0.11- , http-media >=0.6.2 && <0.8- , servant >=0.4.4.5 && <0.15- , servant-blaze >=0.4.4.5 && <0.9- , servant-server >=0.4.4.5 && <0.15- , swagger2 >=2.0.1 && <2.3- , text >=1.2.0.6 && <1.3- , wai-app-static >=3.0.1.1 && <3.2- if flag(servant-0-5)- build-depends:- servant >=0.5- , transformers >=0.3 && <0.6- , transformers-compat >=0.3 && <0.7- else- build-depends:- servant <0.5- , either+ base >=4.7 && <4.13+ , blaze-markup >=0.7.0.2 && <0.9+ , bytestring >=0.10.4.0 && <0.11+ , http-media >=0.7.1.3 && <0.8+ , servant >=0.14 && <0.15+ , servant-blaze >=0.8 && <0.9+ , servant-server >=0.14 && <0.15+ , swagger2 >=2.3.0.1 && <2.4+ , text >=1.2.3.0 && <1.3+ , transformers >=0.3 && <0.6+ , transformers-compat >=0.3 && <0.7+ , wai-app-static >=3.0.1.1 && <3.2 exposed-modules: Servant.Swagger.UI.Core default-language: Haskell2010
src/Servant/Swagger/UI/Core.hs view
@@ -1,4 +1,3 @@-{-# LANGUAGE CPP #-} {-# LANGUAGE ConstraintKinds #-} {-# LANGUAGE DataKinds #-} {-# LANGUAGE DeriveGeneric #-}@@ -56,18 +55,6 @@ import qualified Data.Text as T -#if MIN_VERSION_servant(0,7,0)--- do nothing-#else-#if MIN_VERSION_servant(0,5,0)-import Control.Monad.Trans.Except (ExceptT)-type Handler = ExceptT ServantErr IO-#else-import Control.Monad.Trans.Either (EitherT)-type Handler = EitherT ServantErr IO-#endif-#endif- -- | Swagger schema + ui api. -- -- @SwaggerSchemaUI "swagger-ui" "swagger.json"@ will result into following hierarchy:@@ -100,18 +87,7 @@ -- to find schema file automatically. data SwaggerUiHtml (dir :: Symbol) (api :: *) = SwaggerUiHtml T.Text -#if MIN_VERSION_servant(0,14,0)-#define LINK Link ~ MkLink api Link-#define LINKPATH uriPath . linkURI-#elif MIN_VERSION_servant(0,10,0)-#define LINK Link ~ MkLink api-#define LINKPATH uriPath . linkURI-#else-#define LINK URI ~ MkLink api-#define LINKPATH uriPath-#endif--instance (KnownSymbol dir, HasLink api, LINK, IsElem api api)+instance (KnownSymbol dir, HasLink api, Link ~ MkLink api Link, IsElem api api) => ToMarkup (SwaggerUiHtml dir api) where toMarkup (SwaggerUiHtml template) = preEscapedToMarkup@@ -119,7 +95,7 @@ $ T.replace "SERVANT_SWAGGER_UI_DIR" dir $ template where- schema = T.pack $ LINKPATH $ safeLink proxyApi proxyApi+ schema = T.pack $ uriPath . linkURI $ safeLink proxyApi proxyApi dir = T.pack $ symbolVal (Proxy :: Proxy dir) proxyApi = Proxy :: Proxy api @@ -132,8 +108,4 @@ :<|> return (SwaggerUiHtml indexTemplate) :<|> rest where- rest =-#if MIN_VERSION_servant_server(0,11,0)- Tagged $-#endif- staticApp $ embeddedSettings files+ rest = Tagged $ staticApp $ embeddedSettings files