Release 1.2.5

README.md

@@ -128,7 +128,7 @@ tapir documentation is available at [tapir.softwaremill.com](http://tapir.softwa
 Add the following dependency:
 
 ```sbt
-"com.softwaremill.sttp.tapir" %% "tapir-core" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-core" % "1.2.5"
 ```
 
 Then, import:

generated-doc/out/client/http4s.md

@@ -3,7 +3,7 @@
 Add the dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-http4s-client" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-http4s-client" % "1.2.5"
 ```
 
 To interpret an endpoint definition as an `org.http4s.Request[F]`, import:

generated-doc/out/client/play.md

@@ -3,7 +3,7 @@
 Add the dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-play-client" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-play-client" % "1.2.5"
 ```
 
 To make requests using an endpoint definition using the [play client](https://github.com/playframework/play-ws), import:

generated-doc/out/client/sttp.md

@@ -3,7 +3,7 @@
 Add the dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-sttp-client" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-sttp-client" % "1.2.5"
 ```
 
 To make requests using an endpoint definition using the [sttp client](https://github.com/softwaremill/sttp), import:
@@ -102,7 +102,7 @@ In this case add the following dependencies (note the [`%%%`](https://www.scala-
 instead of the usual `%%`):
 
 ```scala
-"com.softwaremill.sttp.tapir" %%% "tapir-sttp-client" % "1.2.4"
+"com.softwaremill.sttp.tapir" %%% "tapir-sttp-client" % "1.2.5"
 "io.github.cquiroz" %%% "scala-java-time" % "2.2.0" // implementations of java.time classes for Scala.JS
 ```
 

generated-doc/out/docs/asyncapi.md

@@ -3,7 +3,7 @@
 To use, add the following dependencies:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-docs" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-docs" % "1.2.5"
 "com.softwaremill.sttp.apispec" %% "asyncapi-circe-yaml" % "..." // see https://github.com/softwaremill/sttp-apispec
 ```
 

generated-doc/out/docs/openapi.md

@@ -13,7 +13,7 @@ these steps can be done separately, giving you complete control over the process
 To generate OpenAPI documentation and expose it using the Swagger UI in a single step, first add the dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-bundle" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-bundle" % "1.2.5"
 ```
 
 Then, you can interpret a list of endpoints using `SwaggerInterpreter`. The result will be a list of file-serving 
@@ -55,7 +55,7 @@ for details.
 Similarly as above, you'll need the following dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-redoc-bundle" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-redoc-bundle" % "1.2.5"
 ```
 
 And the server endpoints can be generated using the `sttp.tapir.redoc.bundle.RedocInterpreter` class.
@@ -65,7 +65,7 @@ And the server endpoints can be generated using the `sttp.tapir.redoc.bundle.Red
 To generate the docs in the OpenAPI yaml format, add the following dependencies:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.2.5"
 "com.softwaremill.sttp.apispec" %% "openapi-circe-yaml" % "..." // see https://github.com/softwaremill/sttp-apispec
 ```
 
@@ -133,7 +133,7 @@ For example, generating the OpenAPI 3.1.0 YAML string can be achieved by perform
 
 Firstly add dependencies:
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.2.5"
 "com.softwaremill.sttp.apispec" %% "openapi-circe-yaml" % "..." // see https://github.com/softwaremill/sttp-apispec
 ```
 
@@ -164,12 +164,12 @@ The modules `tapir-swagger-ui` and `tapir-redoc` contain server endpoint definit
 yaml format, will expose it using the given context path. To use, add as a dependency either
 `tapir-swagger-ui`:
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui" % "1.2.5"
 ```
 
 or `tapir-redoc`:
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-redoc" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-redoc" % "1.2.5"
 ```
 
 Then, you'll need to pass the server endpoints to your server interpreter. For example, using akka-http:

generated-doc/out/endpoint/integrations.md

@@ -14,7 +14,7 @@ The `tapir-cats` module contains additional instances for some [cats](https://ty
 datatypes as well as additional syntax:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-cats" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-cats" % "1.2.5"
 ```
 
 - `import sttp.tapir.integ.cats.codec._` - brings schema, validator and codec instances
@@ -26,7 +26,7 @@ If you use [refined](https://github.com/fthomas/refined), the `tapir-refined` mo
 validators for `T Refined P` as long as a codec for `T` already exists:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-refined" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-refined" % "1.2.5"
 ```
 
 You'll need to extend the `sttp.tapir.codec.refined.TapirCodecRefined`
@@ -47,7 +47,7 @@ The `tapir-enumeratum` module provides schemas, validators and codecs for [Enume
 enumerations. To use, add the following dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-enumeratum" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-enumeratum" % "1.2.5"
 ```
 
 Then, `import sttp.tapir.codec.enumeratum._`, or extends the `sttp.tapir.codec.enumeratum.TapirCodecEnumeratum` trait.
@@ -60,7 +60,7 @@ If you use [scala-newtype](https://github.com/estatico/scala-newtype), the `tapi
 schemas for types with a `@newtype` and `@newsubtype` annotations as long as a codec and schema for its underlying value already exists:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-newtype" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-newtype" % "1.2.5"
 ```
 
 Then, `import sttp.tapir.codec.newtype._`, or extend the `sttp.tapir.codec.newtype.TapirCodecNewType` trait to bring the implicit values into scope.
@@ -71,7 +71,7 @@ If you use [monix newtypes](https://github.com/monix/newtypes), the `tapir-monix
 schemas for types which extend `NewtypeWrapped` and `NewsubtypeWrapped` annotations as long as a codec and schema for its underlying value already exists:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-monix-newtype" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-monix-newtype" % "1.2.5"
 ```
 
 Then, `import sttp.tapir.codec.monix.newtype._`, or extend the `sttp.tapir.codec.monix.newtype.TapirCodecMonixNewType` trait to bring the implicit values into scope.
@@ -82,7 +82,7 @@ If you use [ZIO Prelude Newtypes](https://zio.github.io/zio-prelude/docs/newtype
 schemas for types defined using `Newtype` and `Subtype` as long as a codec and a schema for the underlying type already exists:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-zio-prelude" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-zio-prelude" % "1.2.5"
 ```
 
 Then, mix in `sttp.tapir.codec.zio.prelude.newtype.TapirNewtypeSupport` into your newtype to bring the implicit values into scope:
@@ -121,7 +121,7 @@ For details refer to [derevo documentation](https://github.com/tofu-tf/derevo#in
 To use, add the following dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-derevo" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-derevo" % "1.2.5"
 ```
 
 Then you can derive schema for your ADT along with other typeclasses besides ADT declaration itself:

generated-doc/out/endpoint/json.md

@@ -45,7 +45,7 @@ stringJsonBody.schema(implicitly[Schema[MyBody]].as[String])
 To use [Circe](https://github.com/circe/circe), add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-json-circe" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-json-circe" % "1.2.5"
 ```
 
 Next, import the package (or extend the `TapirJsonCirce` trait, see [MyTapir](../mytapir.md)):
@@ -118,7 +118,7 @@ Now the above JSON object will render as
 To use [µPickle](http://www.lihaoyi.com/upickle/) add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-json-upickle" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-json-upickle" % "1.2.5"
 ```
 
 Next, import the package (or extend the `TapirJsonuPickle` trait, see [MyTapir](../mytapir.md) and add `TapirJsonuPickle` not `TapirCirceJson`):
@@ -153,7 +153,7 @@ For more examples, including making a custom encoder/decoder, see [TapirJsonuPic
 To use [Play JSON](https://github.com/playframework/play-json) add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-json-play" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-json-play" % "1.2.5"
 ```
 
 Next, import the package (or extend the `TapirJsonPlay` trait, see [MyTapir](../mytapir.md) and add `TapirJsonPlay` not `TapirCirceJson`):
@@ -169,7 +169,7 @@ Play JSON requires `Reads` and `Writes` implicit values in scope for each type y
 To use [Spray JSON](https://github.com/spray/spray-json) add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-json-spray" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-json-spray" % "1.2.5"
 ```
 
 Next, import the package (or extend the `TapirJsonSpray` trait, see [MyTapir](../mytapir.md) and add `TapirJsonSpray` not `TapirCirceJson`):
@@ -185,7 +185,7 @@ Spray JSON requires a `JsonFormat` implicit value in scope for each type you wan
 To use [Tethys JSON](https://github.com/tethys-json/tethys) add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-json-tethys" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-json-tethys" % "1.2.5"
 ```
 
 Next, import the package (or extend the `TapirJsonTethys` trait, see [MyTapir](../mytapir.md) and add `TapirJsonTethys` not `TapirCirceJson`):
@@ -201,7 +201,7 @@ Tethys JSON requires `JsonReader` and `JsonWriter` implicit values in scope for
 To use [Jsoniter-scala](https://github.com/plokhotnyuk/jsoniter-scala) add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-jsoniter-scala" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-jsoniter-scala" % "1.2.5"
 ```
 
 Next, import the package (or extend the `TapirJsonJsoniter` trait, see [MyTapir](../mytapir.md) and add `TapirJsonJsoniter` not `TapirCirceJson`):
@@ -217,7 +217,7 @@ Jsoniter Scala requires `JsonValueCodec` implicit value in scope for each type y
 To use [json4s](https://github.com/json4s/json4s) add the following dependencies to your project:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-json-json4s" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-json-json4s" % "1.2.5"
 ```
 
 And one of the implementations:
@@ -248,7 +248,7 @@ implicit val formats: Formats = org.json4s.jackson.Serialization.formats(NoTypeH
 To use [zio-json](https://github.com/zio/zio-json), add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-json-zio" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-json-zio" % "1.2.5"
 ```
 Next, import the package (or extend the `TapirJsonZio` trait, see [MyTapir](../mytapir.md) and add `TapirJsonZio` instead of `TapirCirceJson`):
 

generated-doc/out/generator/sbt-openapi-codegen.md

@@ -11,7 +11,7 @@
 Add the sbt plugin to the `project/plugins.sbt`:
 
 ```scala
-addSbtPlugin("com.softwaremill.sttp.tapir" % "sbt-openapi-codegen" % "1.2.4")
+addSbtPlugin("com.softwaremill.sttp.tapir" % "sbt-openapi-codegen" % "1.2.5")
 ```
 
 Enable the plugin for your project in the `build.sbt`:

generated-doc/out/quickstart.md

@@ -3,7 +3,7 @@
 To use tapir, add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-core" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-core" % "1.2.5"
 ```
 
 This will import only the core classes needed to create endpoint descriptions. To generate a server or a client, you

generated-doc/out/server/akkahttp.md

@@ -4,14 +4,14 @@ To expose an endpoint as an [akka-http](https://doc.akka.io/docs/akka-http/curre
 dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-akka-http-server" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-akka-http-server" % "1.2.5"
 ```
 
 This will transitively pull some Akka modules in version 2.6. If you want to force
 your own Akka version (for example 2.5), use sbt exclusion. Mind the Scala version in artifact name:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-akka-http-server" % "1.2.4" exclude("com.typesafe.akka", "akka-stream_2.12")
+"com.softwaremill.sttp.tapir" %% "tapir-akka-http-server" % "1.2.5" exclude("com.typesafe.akka", "akka-stream_2.12")
 ```
 
 Now import the object:

generated-doc/out/server/armeria.md

@@ -8,7 +8,7 @@ Armeria interpreter can be used with different effect systems (cats-effect, ZIO)
 
 Add the following dependency
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-armeria-server" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-armeria-server" % "1.2.5"
 ```
 
 and import the object:
@@ -75,7 +75,7 @@ Note that Armeria automatically injects an `ExecutionContext` on top of Armeria'
 
 Add the following dependency
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-armeria-server-cats" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-armeria-server-cats" % "1.2.5"
 ```
 to use this interpreter with Cats Effect typeclasses.
 
@@ -155,9 +155,9 @@ Add the following dependency
 
 ```scala
 // for zio 2:
-"com.softwaremill.sttp.tapir" %% "tapir-armeria-server-zio" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-armeria-server-zio" % "1.2.5"
 // for zio 1:
-"com.softwaremill.sttp.tapir" %% "tapir-armeria-server-zio1" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-armeria-server-zio1" % "1.2.5"
 ```
 
 to use this interpreter with ZIO.

generated-doc/out/server/aws.md

@@ -13,7 +13,7 @@ To implement the Lambda function, a server interpreter is available, which takes
 Currently, only an interpreter integrating with cats-effect is available (`AwsCatsEffectServerInterpreter`). To use, add the following dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-aws-lambda" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-aws-lambda" % "1.2.5"
 ```
 
 To configure API Gateway and the Lambda function, you can use:
@@ -24,8 +24,8 @@ To configure API Gateway and the Lambda function, you can use:
 Add one of the following dependencies:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-aws-sam" % "1.2.4"
-"com.softwaremill.sttp.tapir" %% "tapir-aws-terraform" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-aws-sam" % "1.2.5"
+"com.softwaremill.sttp.tapir" %% "tapir-aws-terraform" % "1.2.5"
 ```
 
 ## Examples

generated-doc/out/server/debugging.md

@@ -4,17 +4,22 @@ When dealing with multiple endpoints, how to find out which endpoint handled a r
 handle a request?
 
 For this purpose, tapir provides optional logging. The logging options (and messages) can be customised by providing
-an instance of the `ServerLog` class, which is part of [server options](options.md).
+an instance of the `ServerLog` trait, which is part of [server options](options.md).
 
-The default implementation, `DefaultServerLog`, can be customised using the following flags:
+An instance of the default implementation, `DefaultServerLog`, is available in the companion object for the 
+interpreter's options class, e.g. `Http4sServerOptions.defaultServerLog` or `NettyZioServerOptions.defaultServerLog`.
 
-1. `logWhenHandled`: when a request is handled by an endpoint, or when the inputs can't be decoded, and the decode 
+This instance can be customised using the following flags:
+
+1. `logWhenReceived`: log when a request is first received (default: `false`, `DEBUG` log)
+2. `logWhenHandled`: log when a request is handled by an endpoint, or when the inputs can't be decoded, and the decode 
  failure maps to a response (default: `true`, `DEBUG` log)
-2. `logAllDecodeFailures`: when the inputs can't be decoded, and the decode failure doesn't map to a response (the next 
- endpoint will be tried; default: `false`, `DEBUG` log)
-3. `logExceptions`: when there's an exception during evaluation of the server logic (default: `true`, `ERROR` log)
+3. `logAllDecodeFailures`: log each time when the inputs can't be decoded, and the decode failure doesn't map to a 
+ response (the next endpoint will be tried; default: `false`, `DEBUG` log)
+4. `logLogicExceptions`: log when there's an exception during evaluation of the server logic (default: `true`, 
+ `ERROR` log)
 
-Logging all decode failures (2) might be helpful when debugging, but can also produce a large amount of logs, hence
+Logging all decode failures (3) might be helpful when debugging, but can also produce a large amount of logs, hence
 it's disabled by default.
 
 Even if logging for a particular category (as described above) is set to `true`, normal logger rules apply - if you 

generated-doc/out/server/finatra.md

@@ -4,7 +4,7 @@ To expose an endpoint as an [finatra](https://twitter.github.io/finatra/) server
 dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-finatra-server" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-finatra-server" % "1.2.5"
 ```
 
 and import the object:
@@ -17,7 +17,7 @@ This interpreter supports the twitter `Future`.
 Or, if you would like to use cats-effect project, you can add the following dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-finatra-server-cats" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-finatra-server-cats" % "1.2.5"
 ```
 
 and import the object:

generated-doc/out/server/http4s.md

@@ -4,7 +4,7 @@ To expose an endpoint as an [http4s](https://http4s.org) server, first add the f
 dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-http4s-server" % "1.2.4"
+"com.softwaremill.sttp.tapir" %% "tapir-http4s-server" % "1.2.5"
 ```
 
 and import the object: