10 KiB
The latest version of this document is on GitHub.
Changelog for servant
package contains significant entries for all core packages.
0.16.1
- Use
http-api-data-0.4.1
(a part of its API is re-exported) #1181
0.16
- Rename
ServantError
toClientError
,ServantErr
toServerError
#1131 - servant-server Reorder HTTP failure code priorities #1103
- servant-server Re-organise internal modules #1139
- Allow
network-3.0
#1107
0.15
-
Streaming refactoring. #991 #1076 #1077
The streaming functionality (
Servant.API.Stream
) is refactored to useservant
's ownSourceIO
type (seeServant.Types.SourceT
documentation), which replaces bothStreamGenerator
andResultStream
types.New conversion type-classes are
ToSourceIO
andFromSourceIO
(replacingToStreamGenerator
andBuildFromStream
). There are instances for conduit, pipes and machines in new packages: servant-conduit servant-pipes and servant-machines respectively.Writing new framing strategies is simpler. Check existing strategies for examples.
This change shouldn't affect you, if you don't use streaming endpoints.
-
servant NewlineFraming encodes newline after each element (i.e last) #1079 #1011
-
servant Add
lookupResponseHeader :: ... => Headers headers r -> ResponseHeader h a
#1064 -
servant-server Add
MonadMask Handler
#1068 -
servant Export
GetHeaders'
#1052 -
servant Add
Bitraversable
and otherBi-
instances for:<|>
#1032 -
servant Add
PutCreated
method type alias #1024 -
servant Add
ToSourceIO (NonEmpty a)
instance #988
0.14.1
-
Merge in
servant-generic
(by Patrick Chilton) intoservant
(Servant.API.Generic
),servant-client-code
(Servant.Client.Generic
) andservant-server
(Servant.Server.Generic
). -
servant-server Deprecate
Servant.Utils.StaticUtils
, useServant.Server.StaticUtils
.
0.14
-
Stream
takes a status code argument-Stream method framing ctype a +Stream method status framing ctype a
-
ToStreamGenerator
definition changed, so it's possible to write an instance for conduits.-class ToStreamGenerator f a where - toStreamGenerator :: f a -> StreamGenerator a +class ToStreamGenerator a b | a -> b where + toStreamGenerator :: a -> StreamGenerator b
(#959)
-
Added
NoFraming
streaming strategy (#959) -
servant-server File serving in polymorphic monad. i.e. Generalised types of
serveDirectoryFileServer
etc functions inServant.Utils.StaticFiles
(#953) -
servant-server
ReqBody
content type check is recoverable. This allows writing APIs like:ReqBody '[JSON] Int :> Post '[PlainText] Int :<|> ReqBody '[PlainText] Int :> Post '[PlainText] Int
which is useful when handlers are subtly different, for example may do less work. (#937)
0.13.0.1
- Support
base-compat-0.10
0.13
0.12
Breaking changes
- Added
hoistServer
member to theHasServer
class, which isHasServer
specificenter
. (#804)
0.11
Breaking changes
- Changed
HasServer
instances forHeader
to throw 400 when parsing fails (#724) - Added
headersD
block toDelayed
(#724)
Other changes
- Add
err418
,err422
error codes (#739)
0.10
Breaking changes
-
Handler
is now an abstract datatype. Migration hint: changethrowE
tothrowError
. (#641) -
Changed
HasServer
instances forQueryParam
andQueryParam
to throw 400 when parsing fails (#649)
Other changes
-
Added
paramsD
block toDelayed
-
Add
err422
Unprocessable Entity (#646) -
Deprecate
serveDirectory
and introduceserveDirectoryFileServer
,serveDirectoryWebApp
,serveDirectoryWebAppLookup
,serveDirectoryEmbedded
andserveDirectoryWith
which offer 4 default options and a more flexible one for serving static files. (#658) -
DelayedIO
is an instance ofMonadResource
, allowing safe resource handling. (#622 , #674 , #675)
0.7.1
- Remove module
Servant.Server.Internal.Enter
(https://github.com/haskell-servant/servant/pull/478) - Support GHC 8.0
0.7
- The
Router
type has been changed. Static router tables should now be properly shared between requests, drastically increasing the number of situations where servers will be able to route requests efficiently. Functionslayout
andlayoutWithContext
have been added to visualize the router layout for debugging purposes. Test cases for expected router layouts have been added. - If an endpoint is discovered to have a non-matching "accept header", this is now a recoverable rather than a fatal failure, allowing different endpoints for the same route, but with different content types to be specified modularly.
- Export
throwError
from moduleServant
- Add
Handler
type synonym
0.6.1
- If servers use the
BasicAuth
combinator and receive requests with missing or invalid credentials, the resulting error responses (401 and 403) could be overwritten by subsequent alternative routes. NowBasicAuth
usesFailFatal
and the error responses can't be overwritten anymore.
0.6
- Query parameters that can't be parsed result in a
400
(was404
).
0.5
- Add
Config
machinery (https://github.com/haskell-servant/servant/pull/327). This is a breaking change, as the signatures of bothroute
,serve
and the typeclassHasServer
now take an additional parameter. - Support for the
HttpVersion
,IsSecure
,RemoteHost
andVault
combinators - Drop
EitherT
in favor ofExceptT
- Use
http-api-data
instead ofServant.Common.Text
- Remove matrix params.
- Remove
RouteMismatch
. - Redefined constructors of
RouteResult
. - Added
Delayed
and related functions (addMethodCheck
,addAcceptCheck
,addBodyCheck
,runDelayed
) - Added support for Basic Authentication
- Add generalized authentication support via the
AuthServerData
type family andAuthHandler
handler
0.4.1
- Bump attoparsec upper bound to < 0.14
- Bump wai-app-static upper bound to < 3.2
- Bump either upper bound to < 4.5
0.4
Delete
now is likeGet
,Post
,Put
, andPatch
and returns a response body- Add a
RouteMismatch
constructor for arbitrary HTTP response codes (https://github.com/haskell-servant/servant-server/pull/22) - Add support for the
Patch
combinator - Support for
Accept
/Content-type
headers and for the content-type aware combinators in servant-0.4 - Export
toApplication
fromServant.Server
(https://github.com/haskell-servant/servant-server/pull/29) - Support other Monads than just
EitherT (Int, String) IO
(https://github.com/haskell-servant/servant-server/pull/21) - Make methods return status code 204 if they return () (https://github.com/haskell-servant/servant-server/issues/28)
- Add server support for response headers
- Use
ServantErr
instead of(Int,String)
inEitherT
handlers - Add
errXXX
functions for HTTP errors with sensible default reason strings - Add
enter
function for applying natural transformations to handlers
0.2.4
- Added support for matrix parameters, see e.g. http://www.w3.org/DesignIssues/MatrixURIs.html
- Add support for serializing based on Accept header (https://github.com/haskell-servant/servant-server/issues/9)
- Ignore trailing slashes (https://github.com/haskell-servant/servant-server/issues/5)
0.2.3
- Fix consuming request body issue (https://github.com/haskell-servant/servant/issues/3)
- Make code sample in Servant.Server complete