Release 1.10.10

README.md

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

generated-doc/out/client/http4s.md

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

generated-doc/out/client/play.md

@@ -6,13 +6,13 @@ See the [Play framework documentation](https://www.playframework.com/documentati
 For **Play 3.0**, add the dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-play-client" % "1.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-play-client" % "1.10.10"
 ```
 
 For **Play 2.9**, add
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-play29-client" % "1.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-play29-client" % "1.10.10"
 ```
 
 instead. Furthermore, replace all uses of `sttp.capabilities.pekko.PekkoStreams` in the following code snippets with `sttp.capabilities.akka.AkkaStreams`.

generated-doc/out/client/sttp.md

@@ -3,7 +3,7 @@
 Add the dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-sttp-client" % "1.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-sttp-client" % "1.10.10"
 ```
 
 To make requests using an endpoint definition using the [sttp client](https://github.com/softwaremill/sttp), import:
@@ -101,7 +101,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.10.9"
+"com.softwaremill.sttp.tapir" %%% "tapir-sttp-client" % "1.10.10"
 "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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-docs" % "1.10.10"
 "com.softwaremill.sttp.apispec" %% "asyncapi-circe-yaml" % "..." // see https://github.com/softwaremill/sttp-apispec
 ```
 

generated-doc/out/docs/json-schema.md

@@ -3,7 +3,7 @@
 You can conveniently generate JSON schema from Tapir schema, which can be derived from your Scala types. Use `TapirSchemaToJsonSchema`:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-apispec-docs" % "1.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-apispec-docs" % "1.10.10"
 ```
 
 Schema generation can now be performed like in the following example:

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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-bundle" % "1.10.10"
 ```
 
 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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-redoc-bundle" % "1.10.10"
 ```
 
 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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.10.10"
 "com.softwaremill.sttp.apispec" %% "openapi-circe-yaml" % "..." // see https://github.com/softwaremill/sttp-apispec
 ```
 
@@ -133,7 +133,7 @@ For example, generating the OpenAPI 3.0.3 YAML string can be achieved by perform
 
 Firstly add dependencies:
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.10.10"
 "com.softwaremill.sttp.apispec" %% "openapi-circe-yaml" % "..." // see https://github.com/softwaremill/sttp-apispec
 ```
 
@@ -163,12 +163,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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui" % "1.10.10"
 ```
 
 or `tapir-redoc`:
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-redoc" % "1.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-redoc" % "1.10.10"
 ```
 
 Then, you'll need to pass the server endpoints to your server interpreter. For example, using akka-http:

generated-doc/out/endpoint/enumerations.md

@@ -263,6 +263,23 @@ enum ColorEnum {
 given Schema[ColorEnum] = Schema.derivedEnumeration.defaultStringBased
 ```
 
+### Scala 3 string-based constant union types to enum
+
+If a union type is a string-based constant union type, it can be auto-derived as field type or manually derived by using the `Schema.derivedStringBasedUnionEnumeration[T]` method.
+
+Constant strings can be derived by using the `Schema.constStringToEnum[T]` method.
+
+Examples:
+```scala
+val aOrB: Schema["a" | "b"] = Schema.derivedStringBasedUnionEnumeration
+```
+```scala
+val a: Schema["a"] = Schema.constStringToEnum
+```
+```scala
+case class Foo(aOrB: "a" | "b", optA: Option["a"]) derives Schema
+```
+
 ### Creating an enum schema by hand
 
 Creating an enumeration [schema](schema.md) by hand is exactly the same as for any other type. The only difference

generated-doc/out/endpoint/integrations.md

@@ -12,7 +12,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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-cats" % "1.10.10"
 ```
 
 - `import sttp.tapir.integ.cats.codec._` - brings schema, validator and codec instances
@@ -22,7 +22,7 @@ Additionally, the `tapir-cats-effect` module contains an implementation of the `
 between the sttp-internal `MonadError` and the cats-effect `Sync` typeclass:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-cats-effect" % "1.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-cats-effect" % "1.10.10"
 ```
 
 ## Refined integration
@@ -31,7 +31,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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-refined" % "1.10.10"
 ```
 
 You'll need to extend the `sttp.tapir.codec.refined.TapirCodecRefined`
@@ -52,7 +52,7 @@ If you use [iron](https://github.com/Iltotore/iron), the `tapir-iron` module wil
 validators for `T :| P` as long as a codec for `T` already exists:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-iron" % "1.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-iron" % "1.10.10"
 ```
 
 The module is only available for Scala 3 since iron is not designed to work with Scala 2.
@@ -144,7 +144,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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-enumeratum" % "1.10.10"
 ```
 
 Then, `import sttp.tapir.codec.enumeratum._`, or extends the `sttp.tapir.codec.enumeratum.TapirCodecEnumeratum` trait.
@@ -157,7 +157,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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-newtype" % "1.10.10"
 ```
 
 Then, `import sttp.tapir.codec.newtype._`, or extend the `sttp.tapir.codec.newtype.TapirCodecNewType` trait to bring the implicit values into scope.
@@ -168,7 +168,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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-monix-newtype" % "1.10.10"
 ```
 
 Then, `import sttp.tapir.codec.monix.newtype._`, or extend the `sttp.tapir.codec.monix.newtype.TapirCodecMonixNewType` trait to bring the implicit values into scope.
@@ -179,7 +179,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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-zio-prelude" % "1.10.10"
 ```
 
 Then, mix in `sttp.tapir.codec.zio.prelude.newtype.TapirNewtypeSupport` into your newtype to bring the implicit values into scope:
@@ -218,7 +218,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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-derevo" % "1.10.10"
 ```
 
 Then you can derive schema for your ADT along with other typeclasses besides ADT declaration itself:

generated-doc/out/endpoint/json.md

@@ -50,7 +50,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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-json-circe" % "1.10.10"
 ```
 
 Next, import the package (or extend the `TapirJsonCirce` trait, see [MyTapir](../mytapir.md)):
@@ -123,7 +123,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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-json-upickle" % "1.10.10"
 ```
 
 Next, import the package (or extend the `TapirJsonuPickle` trait, see [MyTapir](../mytapir.md) and add `TapirJsonuPickle` not `TapirCirceJson`):
@@ -158,13 +158,13 @@ For more examples, including making a custom encoder/decoder, see [TapirJsonuPic
 To use [Play JSON](https://github.com/playframework/play-json) for **Play 3.0**, add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-json-play" % "1.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-json-play" % "1.10.10"
 ```
 
 For **Play 2.9** use:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-json-play29" % "1.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-json-play29" % "1.10.10"
 ```
 
 Next, import the package (or extend the `TapirJsonPlay` trait, see [MyTapir](../mytapir.md) and add `TapirJsonPlay` not `TapirCirceJson`):
@@ -180,7 +180,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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-json-spray" % "1.10.10"
 ```
 
 Next, import the package (or extend the `TapirJsonSpray` trait, see [MyTapir](../mytapir.md) and add `TapirJsonSpray` not `TapirCirceJson`):
@@ -196,7 +196,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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-json-tethys" % "1.10.10"
 ```
 
 Next, import the package (or extend the `TapirJsonTethys` trait, see [MyTapir](../mytapir.md) and add `TapirJsonTethys` not `TapirCirceJson`):
@@ -212,7 +212,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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-jsoniter-scala" % "1.10.10"
 ```
 
 Next, import the package (or extend the `TapirJsonJsoniter` trait, see [MyTapir](../mytapir.md) and add `TapirJsonJsoniter` not `TapirCirceJson`):
@@ -228,7 +228,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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-json-json4s" % "1.10.10"
 ```
 
 And one of the implementations:
@@ -259,7 +259,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.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-json-zio" % "1.10.10"
 ```
 Next, import the package (or extend the `TapirJsonZio` trait, see [MyTapir](../mytapir.md) and add `TapirJsonZio` instead of `TapirCirceJson`):
 

generated-doc/out/endpoint/pickler.md

@@ -9,7 +9,7 @@ In [other](json.md) tapir-JSON integrations, you have to keep the `Schema` (whic
 To use pickler, add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-json-pickler" % "1.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-json-pickler" % "1.10.10"
 ```
 
 Please note that it is available only for Scala 3 and Scala.JS 3.

generated-doc/out/endpoint/schemas.md

@@ -117,6 +117,11 @@ val s: Schema[StringOrInt] = Schema.derivedUnion[StringOrInt]
 If any of the components of the union type is a generic type, any of its validations will be skipped when validating
 the union type, as it's not possible to generate a runtime check for the generic type.
 
+### Derivation for string-based constant union types
+e.g. `type AorB = "a" | "b"`
+
+See [enumerations](enumerations.md#scala-3-string-based-constant-union-types-to-enum) on how to use string-based unions of constant types as enums.
+
 ## Configuring derivation
 
 It is possible to configure Magnolia's automatic derivation to use `snake_case`, `kebab-case` or a custom field naming

generated-doc/out/endpoint/static.md

@@ -11,7 +11,7 @@ the API documentation of the old static content API, switch documentation to an
 In order to use static content endpoints, add the module to your dependencies:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-files" % "1.10.9"
+"com.softwaremill.sttp.tapir" %% "tapir-files" % "1.10.10"
 ```
 
 ## Files

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

@@ -9,7 +9,7 @@ This is a really early alpha implementation.
 Add the sbt plugin to the `project/plugins.sbt`:
 
 ```scala
-addSbtPlugin("com.softwaremill.sttp.tapir" % "sbt-openapi-codegen" % "1.10.9")
+addSbtPlugin("com.softwaremill.sttp.tapir" % "sbt-openapi-codegen" % "1.10.10")
 ```
 
 Enable the plugin for your project in the `build.sbt`:

generated-doc/out/index.md

@@ -216,6 +216,7 @@ We offer commercial support for sttp and related technologies, as well as develo
  tutorials/01_hello_world
  tutorials/02_openapi_docs
  tutorials/03_json
+ tutorials/04_errors
 
 .. toctree::
  :maxdepth: 2

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