Release 0.17.15

Author: adamw

README.md

@@ -90,7 +90,7 @@ tapir documentation is available at [tapir.softwaremill.com](http://tapir.softwa
 Add the following dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-core" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-core" % "0.17.15"
 ```
 
 You'll need partial unification enabled in the compiler (alternatively, you'll need to manually provide type arguments in some cases):

generated-doc/out/client/play.md

@@ -3,7 +3,7 @@
 Add the dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-play-client" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-play-client" % "0.17.15"
 ```
 
 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" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-sttp-client" % "0.17.15"
 ```
 
 To make requests using an endpoint definition using the [sttp client](https://github.com/softwaremill/sttp), import:

generated-doc/out/docs/asyncapi.md

@@ -3,8 +3,8 @@
 To use, add the following dependencies:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-docs" % "0.17.14"
-"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-circe-yaml" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-docs" % "0.17.15"
+"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-circe-yaml" % "0.17.15"
 ```
 
 Tapir contains a case class-based model of the asyncapi data structures in the `asyncapi/asyncapi-model` subproject (the

generated-doc/out/docs/openapi.md

@@ -4,8 +4,8 @@
 To use, add the following dependencies:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "0.17.14"
-"com.softwaremill.sttp.tapir" %% "tapir-openapi-circe-yaml" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "0.17.15"
+"com.softwaremill.sttp.tapir" %% "tapir-openapi-circe-yaml" % "0.17.15"
 ```
 
 Tapir contains a case class-based model of the openapi data structures in the `openapi/openapi-model` subproject (the
@@ -81,29 +81,29 @@ akka-http/http4s routes for exposing documentation using [Swagger UI](https://sw
 
 ```scala
 // Akka HTTP
-"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-akka-http" % "0.17.14"
-"com.softwaremill.sttp.tapir" %% "tapir-redoc-akka-http" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-akka-http" % "0.17.15"
+"com.softwaremill.sttp.tapir" %% "tapir-redoc-akka-http" % "0.17.15"
 
 // Finatra
-"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-finatra" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-finatra" % "0.17.15"
 
 // HTTP4S
-"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-http4s" % "0.17.14"
-"com.softwaremill.sttp.tapir" %% "tapir-redoc-http4s" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-http4s" % "0.17.15"
+"com.softwaremill.sttp.tapir" %% "tapir-redoc-http4s" % "0.17.15"
 
 // Play
-"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-play" % "0.17.14"
-"com.softwaremill.sttp.tapir" %% "tapir-redoc-play" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-play" % "0.17.15"
+"com.softwaremill.sttp.tapir" %% "tapir-redoc-play" % "0.17.15"
 
 // Vert.x
-"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-vertx" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-vertx" % "0.17.15"
 ```
 
 Note: `tapir-swagger-ui-akka-http` transitively pulls 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-swagger-ui-akka-http" % "0.17.14" exclude("com.typesafe.akka", "akka-stream_2.12")
+"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-akka-http" % "0.17.15" exclude("com.typesafe.akka", "akka-stream_2.12")
 ```
 
 Usage example for akka-http:

generated-doc/out/endpoint/customtypes.md

@@ -104,7 +104,7 @@ Two policies enable to choose the way custom types are derived:
 
 Case classes, traits and their children are recursively derived by Magnolia.
 
-Importing `sttp.tapir.generic.auto._` enables fully automatic derivation for `Schema`:
+Importing `sttp.tapir.generic.auto._` (or extending the `SchemaDerivation` trait) enables fully automatic derivation for `Schema`:
 
 ```scala
 import sttp.tapir.Schema
@@ -120,6 +120,8 @@ implicitly[Schema[Parent]]
 If you have a case class which contains some non-standard types (other than strings, number, other case classes, 
 collections), you only need to provide schemas for them. Using these, the rest will be derived automatically.
 
+Note that when using [datatypes integrations](integrations.md), respective codecs must also be imported to enable the derivation, e.g. for [newtype](integrations.md#newtype-integration) you'll have to add `import sttp.tapir.codec.newtype._` or extend `TapirCodecNewType`.
+
 ### Semi-automatic derivation
 
 Semi-automatic derivation can be done using `Schema.derived[T]`. 

generated-doc/out/endpoint/integrations.md

@@ -6,7 +6,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" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-cats" % "0.17.15"
 ```
 
 - `import sttp.tapir.integ.cats.codec._` - brings schema, validator and codec instances
@@ -19,7 +19,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" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-refined" % "0.17.15"
 ```
 
 You'll need to extend the `sttp.tapir.codec.refined.TapirCodecRefined`
@@ -40,7 +40,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" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-enumeratum" % "0.17.15"
 ```
 
 Then, `import sttp.tapir.codec.enumeratum`, or extends the `sttp.tapir.codec.enumeratum.TapirCodecEnumeratum` trait.
@@ -75,13 +75,13 @@ object Color extends Enumeration with EnumHelper {
 ## NewType integration
 
 If you use [scala-newtype](https://github.com/estatico/scala-newtype), the `tapir-newtype` module will provide implicit codecs and
-schemas for a types with a @newtype and @newsubtype annotations as long as a codec and schema for its underlying value already exists:
+schemas for a 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" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-newtype" % "0.17.15"
 ```
 
-Then, `import sttp.tapir.codec.newtype`, or extends the `sttp.tapir.codec.enumeratum.TapirCodecNewType` trait to bring the implicit values into scope.
+Then, `import sttp.tapir.codec.newtype._`, or extend the `sttp.tapir.codec.enumeratum.TapirCodecNewType` trait to bring the implicit values into scope.
 
 ## Derevo integration
 
@@ -90,7 +90,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" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-derevo" % "0.17.15"
 ```
 
 Then you can derive schema for your ADT along with other typeclasses besides ADT declaration itself:

generated-doc/out/endpoint/json.md

@@ -19,7 +19,7 @@ the json codec that is in scope.
 To use Circe add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-json-circe" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-json-circe" % "0.17.15"
 ```
 
 Next, import the package (or extend the `TapirJsonCirce` trait, see [MyTapir](../mytapir.md)):
@@ -93,7 +93,7 @@ Now the above JSON object will render as
 To use µPickle add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-json-upickle" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-json-upickle" % "0.17.15"
 ```
 
 Next, import the package (or extend the `TapirJsonuPickle` trait, see [MyTapir](../mytapir.md) and add `TapirJsonuPickle` not `TapirCirceJson`):
@@ -128,7 +128,7 @@ For more examples, including making a custom encoder/decoder, see [TapirJsonuPic
 To use Play JSON add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-json-play" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-json-play" % "0.17.15"
 ```
 
 Next, import the package (or extend the `TapirJsonPlay` trait, see [MyTapir](../mytapir.md) and add `TapirJsonPlay` not `TapirCirceJson`):
@@ -144,7 +144,7 @@ Play JSON requires `Reads` and `Writes` implicit values in scope for each type y
 To use Spray JSON add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-json-spray" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-json-spray" % "0.17.15"
 ```
 
 Next, import the package (or extend the `TapirJsonSpray` trait, see [MyTapir](../mytapir.md) and add `TapirJsonSpray` not `TapirCirceJson`):
@@ -160,7 +160,7 @@ Spray JSON requires a `JsonFormat` implicit value in scope for each type you wan
 To use Tethys JSON add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-json-tethys" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-json-tethys" % "0.17.15"
 ```
 
 Next, import the package (or extend the `TapirJsonTethys` trait, see [MyTapir](../mytapir.md) and add `TapirJsonTethys` not `TapirCirceJson`):
@@ -176,7 +176,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" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-jsoniter-scala" % "0.17.15"
 ```
 
 Next, import the package (or extend the `TapirJsonJsoniter` trait, see [MyTapir](../mytapir.md) and add `TapirJsonJsoniter` not `TapirCirceJson`):
@@ -193,7 +193,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-json4s" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-json4s" % "0.17.15"
 ```
 
 And one of the implementations:

generated-doc/out/endpoint/zio.md

@@ -7,8 +7,8 @@ exposing the endpoints using the [http4s](https://http4s.org) server.
 You'll need the following dependencies:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-zio" % "0.17.14"
-"com.softwaremill.sttp.tapir" %% "tapir-zio-http4s-server" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-zio" % "0.17.15"
+"com.softwaremill.sttp.tapir" %% "tapir-zio-http4s-server" % "0.17.15"
 ```
 
 Next, instead of the usual `import sttp.tapir._`, you should import:

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" % "0.17.14")
+addSbtPlugin("com.softwaremill.sttp.tapir" % "sbt-openapi-codegen" % "0.17.15")
 ```
 
 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" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-core" % "0.17.15"
 ```
 
 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" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-akka-http-server" % "0.17.15"
 ```
 
 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" % "0.17.14" exclude("com.typesafe.akka", "akka-stream_2.12")
+"com.softwaremill.sttp.tapir" %% "tapir-akka-http-server" % "0.17.15" exclude("com.typesafe.akka", "akka-stream_2.12")
 ```
 
 Now import the object:

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" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-finatra-server" % "0.17.15"
 ```
 
 and import the object:
@@ -16,7 +16,7 @@ import sttp.tapir.server.finatra.FinatraServerInterpreter
 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" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-finatra-server-cats" % "0.17.15"
 ```
 
 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" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-http4s-server" % "0.17.15"
 ```
 
 and import the object:

generated-doc/out/server/play.md

@@ -3,7 +3,7 @@
 To expose endpoint as a [play-server](https://www.playframework.com/) first add the following dependencies:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-play-server" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-play-server" % "0.17.15"
 ```
 
 and (if you don't already depend on Play) 

generated-doc/out/server/vertx.md

@@ -8,7 +8,7 @@ Vert.x interpreter can be used with different effect systems (cats-effect, ZIO)
 
 Add the following dependency
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-vertx-server" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-vertx-server" % "0.17.15"
 ```
 to use this interpreter with `Future`.
 
@@ -83,7 +83,7 @@ It's also possible to define an endpoint together with the server logic in a sin
 
 Add the following dependency
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-vertx-server" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-vertx-server" % "0.17.15"
 "com.softwaremill.sttp.shared" %% "fs2" % "LatestVersion"
 ```
 to use this interpreter with Cats Effect typeclasses.
@@ -164,7 +164,7 @@ val attach = route(streamedResponse) { key =>
 
 Add the following dependency
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-vertx-server" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-vertx-server" % "0.17.15"
 "com.softwaremill.sttp.shared" %% "zio" % "LatestVersion"
 ```
 to use this interpreter with ZIO.

generated-doc/out/testing.md

@@ -12,7 +12,7 @@ details on how the stub works).
 Add the dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-sttp-stub-server" % "0.17.14"
+"com.softwaremill.sttp.tapir" %% "tapir-sttp-stub-server" % "0.17.15"
 ```
 
 And the following imports: