Migrating
From 1.9.3 to 1.9.4
NettyConfig.defaultNoStreaming
has been removed, useNettyConfig.default
.
From 1.4 to 1.5
badRequestOnPathErrorIfPathShapeMatches
andbadRequestOnPathInvalidIfPathShapeMatches
have been removed fromDefaultDecodeFailureHandler
. These flags were causing confusion and incosistencies caused by specifics of ZIO and Play backends. Before tapir 1.5, keeping defaults (false
andtrue
respectively for these flags) meant that some path segment decoding failures (specifically, errors - when an exception has been thrown during decoding, but not for e.g. enumeration mismatches) were translated to a “no-match”, meaning that the next endpoint was attempted. From 1.5, tapir defaults to a 400 Bad Request response to be sent instead, on all path decoding failures.If your code sets
badRequestOnPathErrorIfPathShapeMatches = true
to override the defaultfalse
, you can just remove this in tapir 1.5, it is the new default.Similarly, if your code sets
.badRequestOnDecodeFailure
on endpoint path input, just remove this attribute.If your code doesn’t change this parameter and you update tapir, you should expect shape-matched path decoding failures to always become 400s, without attempting the next endpoint unless explicitly specified.
If you want to override this behavior and force trying the next endpoint, add
.onDecodeFailureNextEndpoint
to the input where you expect such handling. See error handling page for details.
From 1.2 to 1.3
Static content endpoints from
sttp.tapir.static._
are deprecated in favor of the newtapir-files
module. New methods are insttp.tapir.files._
:staticFilesGetServerEndpoint
,staticFilesHeadServerEndpoint
,staticFilesServerEndpoints
,staticResourcesGetServerEndpoint
,staticResourcesHeadServerEndpoint
,staticResourcesServerEndpoints
, etc. See the updated documentation.Respectively, use
sttp.tapir.files.FilesOptions
instead ofsttp.tapir.static.FilesOptions
the
cats
integration module has been split intocats
andcats-effect
, with the latter containing theCatsMonadError
class, providing a bridge between the sttp-internalMonadError
and the cats-effectSync
typeclass. If you’ve been using this directly, you might need to update your dependencies.
From 0.20 to 1.0
EndpointVerifier
is moved to a separatetapir-testing
modulecustomJsonBody
is renamed tocustomCodecJsonBody
anyFromStringBody
is renamed tostringBodyAnyFormat
anyFromUtf8StringBody
is renamed tostringBodyUtf8AnyFormat
CustomInterceptors
is renamed toCustomiseInterceptors
as this better reflects the functionality of the classCustomiseInterceptors.errorOutput
is renamed to.defaultHandlers
, with additional options added.in custom server interpreters, the
RejectInterecptor
must be now disabled explicitly usingRejectInterceptor.disableWhenSingleEndpoint
when a single endpoint is being interpreted; theServerInterpreter
no longer knows about all endpoints, as it is now parametrised with a function which gives the potentially matching endpoints, given aServerRequest
the names of Prometheus and OpenTelemetry metrics have changed; there are now three metrics (requests active, total and duration), instead of the previous 4 (requests active, total, response total and duration). Moreover, the request duration metric includes an additional label - phase (either headers or body), measuring how long it takes to create the headers or the body.
CustomiseInterceptors.appendInterceptor
is replaced with.addInterceptor
;.prependInterceptor
and.appendInterceptor
methods are also addedRequestHandler
, returned byRequestInterceptor
, now also accepts a list of server endpoints. This allows to dynamically filter the endpoints. Moreover, there’s a new type parameter inRequestInterceptor
andRequestHandler
,R
, specifying the capabilities required by the given server endpoints.the http4s server interpreters have only one effect parameter, instead of two (
F
for the general effect andG
for the body effect). This separation stopped making sense with the introduction ofBodyListener
some time ago and keepingServerInterpreter
using a single effect.the Swagger and Redoc UIs by default use relative paths for yaml/json documentation references and for redirects. This can be changed by passing appropriate options.
The
streamBinaryBody
method now has a mandatoryformat
parameter, which previously was fixed to beCodecFormat.OctetStream()
Moved traits, classes, objects
server interpreters & interceptors have moved from
core
into theserver/core
moduleServerResponse
andValuedEndpointOutput
are moved tosttp.tapir.server.model
metrics classes and interceptors have moved to the
sttp.tapir.server.metrics
packageEndpoint.renderPathTemplate
is renamed toEndpoint.showPathTemplate
web socket exceptions
UnsupportedWebSocketFrameException
andWebSocketFrameDecodeFailure
are now in thesttp.tapir.model
packageOpenAPI and AsyncAPI models are now part of a separate sttp-apispec project, hence the packages of these objects changed as well, from
sttp.tapir.apispec
/sttp.tapir.openapi
/sttp.tapir.asyncapi
tosttp.tapir.apispec.(...)
server interpreters sources are now grouped based on the underlying server implementation (e.g. http4s, vertx), and then sub-directories contain effect integrations (e.g. cats, zio). Name templates:
for artifacts:
tapir-<server>-server-<effect>
. E.g.tapir-zio-http4s-server
becametapir-http4s-server-zio1
for package names:
sttp.tapir.server.<server>.<effect>
for interpreters:
<server><effect>ServerInterpreter
From 0.19 to 0.20
See the release notes
From 0.18 to 0.19
See the release notes
From 0.17 to 0.18
See the release notes