diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,13 @@ [The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant-docs/CHANGELOG.md) [Changelog for `servant` package contains significant entries for all core packages.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md) +0.11.2 +------ + +* Allow `servant-0.13`: + - Doesn't have instances for streaming. + - Servant.API.Modifiers extra information isn't used. + 0.11.1 ------ diff --git a/servant-docs.cabal b/servant-docs.cabal --- a/servant-docs.cabal +++ b/servant-docs.cabal @@ -1,5 +1,5 @@ name: servant-docs -version: 0.11.1 +version: 0.11.2 synopsis: generate API docs for your servant webservice description: Library for generating API docs from a servant API definition. @@ -19,7 +19,7 @@ GHC==7.8.4 GHC==7.10.3 GHC==8.0.2 - GHC==8.2.1 + GHC==8.2.2 homepage: http://haskell-servant.readthedocs.org/ Bug-reports: http://github.com/haskell-servant/servant/issues extra-source-files: @@ -35,25 +35,39 @@ Servant.Docs , Servant.Docs.Internal , Servant.Docs.Internal.Pretty + + -- Bundled with GHC: Lower bound to not force re-installs + -- text and mtl are bundled starting with GHC-8.4 + -- + -- note: mtl lower bound is so low because of GHC-7.8 build-depends: - base >=4.7 && <5 - , base-compat >= 0.9.1 && <0.10 - , aeson - , aeson-pretty - , bytestring - , case-insensitive - , hashable - , http-media >= 0.6 - , http-types >= 0.7 - , lens - , servant == 0.12.* - , string-conversions - , text - , unordered-containers - , control-monad-omega == 0.3.* + base >= 4.7 && < 4.11 + , bytestring >= 0.10.4.0 && < 0.11 + , text >= 1.2.3.0 && < 1.3 + if !impl(ghc >= 8.0) build-depends: - semigroups >=0.17 && <0.19 + semigroups >=0.18.3 && <0.19 + + -- Servant dependencies + build-depends: + servant == 0.13.* + + -- Other dependencies: Lower bound around what is in the latest Stackage LTS. + -- Here can be exceptions if we really need features from the newer versions. + build-depends: + aeson >= 1.2.3.0 && < 1.3 + , aeson-pretty >= 0.8.5 && < 0.9 + , base-compat >= 0.9.3 && < 0.10 + , case-insensitive >= 1.2.0.10 && < 1.3 + , control-monad-omega >= 0.3.1 && < 0.4 + , hashable >= 1.2.6.1 && < 1.3 + , http-media >= 0.7.1.1 && < 0.8 + , http-types >= 0.12 && < 0.13 + , lens >= 4.15.4 && < 4.17 + , string-conversions >= 0.4.0.1 && < 0.5 + , unordered-containers >= 0.2.8.0 && < 0.3 + hs-source-dirs: src default-language: Haskell2010 ghc-options: -Wall @@ -76,19 +90,25 @@ default-language: Haskell2010 test-suite spec + default-language: Haskell2010 type: exitcode-stdio-1.0 main-is: Spec.hs other-modules: Servant.DocsSpec - build-tool-depends: - hspec-discover:hspec-discover hs-source-dirs: test ghc-options: -Wall + + -- Dependencies inherited from the library. No need to specify bounds. build-depends: base , aeson - , hspec , lens , servant , servant-docs , string-conversions - default-language: Haskell2010 + + -- Additonal dependencies + build-depends: + hspec >= 2.4.4 && < 2.5 + + build-tool-depends: + hspec-discover:hspec-discover >=2.4.4 && <2.5 diff --git a/src/Servant/Docs/Internal.hs b/src/Servant/Docs/Internal.hs --- a/src/Servant/Docs/Internal.hs +++ b/src/Servant/Docs/Internal.hs @@ -534,7 +534,7 @@ -- -- Example of an instance: -- --- > instance ToParam (QueryParam "capital" Bool) where +-- > instance ToParam (QueryParam' mods "capital" Bool) where -- > toParam _ = -- > DocQueryParam "capital" -- > ["true", "false"] @@ -795,7 +795,7 @@ -- | @"books" :> 'Capture' "isbn" Text@ will appear as -- @/books/:isbn@ in the docs. instance (KnownSymbol sym, ToCapture (Capture sym a), HasDocs api) - => HasDocs (Capture sym a :> api) where + => HasDocs (Capture' mods sym a :> api) where docsFor Proxy (endpoint, action) = docsFor subApiP (endpoint', action') @@ -859,7 +859,7 @@ p = Proxy :: Proxy a instance (KnownSymbol sym, HasDocs api) - => HasDocs (Header sym a :> api) where + => HasDocs (Header' mods sym a :> api) where docsFor Proxy (endpoint, action) = docsFor subApiP (endpoint, action') @@ -867,14 +867,14 @@ action' = over headers (|> headername) action headername = T.pack $ symbolVal (Proxy :: Proxy sym) -instance (KnownSymbol sym, ToParam (QueryParam sym a), HasDocs api) - => HasDocs (QueryParam sym a :> api) where +instance (KnownSymbol sym, ToParam (QueryParam' mods sym a), HasDocs api) + => HasDocs (QueryParam' mods sym a :> api) where docsFor Proxy (endpoint, action) = docsFor subApiP (endpoint, action') where subApiP = Proxy :: Proxy api - paramP = Proxy :: Proxy (QueryParam sym a) + paramP = Proxy :: Proxy (QueryParam' mods sym a) action' = over params (|> toParam paramP) action instance (KnownSymbol sym, ToParam (QueryParams sym a), HasDocs api) @@ -929,7 +929,7 @@ -- 'AllMimeUnrender' and 'AllMimeRender' actually agree (or to suppose that -- both are even defined) for any particular type. instance (ToSample a, AllMimeRender (ct ': cts) a, HasDocs api) - => HasDocs (ReqBody (ct ': cts) a :> api) where + => HasDocs (ReqBody' mods (ct ': cts) a :> api) where docsFor Proxy (endpoint, action) opts@DocOptions{..} = docsFor subApiP (endpoint, action') opts diff --git a/test/Servant/DocsSpec.hs b/test/Servant/DocsSpec.hs --- a/test/Servant/DocsSpec.hs +++ b/test/Servant/DocsSpec.hs @@ -33,7 +33,9 @@ -- This declaration simply checks that all instances are in place. _ = docs comprehensiveAPI -instance ToParam (QueryParam "foo" Int) where +instance ToParam (QueryParam' mods "foo" Int) where + toParam = error "unused" +instance ToParam (QueryParam' mods "bar" Int) where toParam = error "unused" instance ToParam (QueryParams "foo" Int) where toParam = error "unused"