Release 1.8.0

softwaremill · Oct 9, 2023 · d0f1a4c · d0f1a4c
1 parent 79717e1
commit d0f1a4c
Show file tree

Hide file tree

Showing 28 changed files with 133 additions and 86 deletions.
diff --git a/README.md b/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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-core" % "1.8.0"
 ```
 
 Then, import:

diff --git a/generated-doc/out/.DS_Store b/generated-doc/out/.DS_Store
diff --git a/generated-doc/out/client/http4s.md b/generated-doc/out/client/http4s.md
@@ -3,7 +3,7 @@
 Add the dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-http4s-client" % "1.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-http4s-client" % "1.8.0"
 ```
 
 To interpret an endpoint definition as an `org.http4s.Request[F]`, import:

diff --git a/generated-doc/out/client/play.md b/generated-doc/out/client/play.md
@@ -3,7 +3,7 @@
 Add the dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-play-client" % "1.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-play-client" % "1.8.0"
 ```
 
 To make requests using an endpoint definition using the [play client](https://github.com/playframework/play-ws), import:

diff --git a/generated-doc/out/client/sttp.md b/generated-doc/out/client/sttp.md
@@ -3,7 +3,7 @@
 Add the dependency:
 
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-sttp-client" % "1.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-sttp-client" % "1.8.0"
 ```
 
 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.7.6"
+"com.softwaremill.sttp.tapir" %%% "tapir-sttp-client" % "1.8.0"
 "io.github.cquiroz" %%% "scala-java-time" % "2.2.0" // implementations of java.time classes for Scala.JS
 ```
 

diff --git a/generated-doc/out/docs/asyncapi.md b/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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-asyncapi-docs" % "1.8.0"
 "com.softwaremill.sttp.apispec" %% "asyncapi-circe-yaml" % "..." // see https://github.com/softwaremill/sttp-apispec
 ```
 

diff --git a/generated-doc/out/docs/json-schema.md b/generated-doc/out/docs/json-schema.md
@@ -3,13 +3,13 @@
 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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-apispec-docs" % "1.8.0"
 ```
 
 Schema generation can now be performed like in the following example:
 
 ```scala
-import sttp.apispec.{ReferenceOr, Schema => ASchema}
+import sttp.apispec.{Schema => ASchema}
 import sttp.tapir._
 import sttp.tapir.docs.apispec.schema._
 import sttp.tapir.generic.auto._
@@ -21,7 +21,7 @@ import sttp.tapir.generic.auto._
  case class Child(childName: String) // to illustrate unique name generation // to illustrate unique name generation
  val tSchema = implicitly[Schema[Parent]]
 
- val jsonSchema: ReferenceOr[ASchema] = TapirSchemaToJsonSchema(
+ val jsonSchema: ASchema = TapirSchemaToJsonSchema(
  tSchema,
  markOptionsAsNullable = true,
  metaSchema = MetaSchemaDraft04 // default
@@ -44,7 +44,7 @@ you will get a codec for `sttp.apispec.Schema`:
 import io.circe.Printer
 import io.circe.syntax._
 import sttp.apispec.circe._
-import sttp.apispec.{ReferenceOr, Schema => ASchema, SchemaType => ASchemaType}
+import sttp.apispec.{Schema => ASchema, SchemaType => ASchemaType}
 import sttp.tapir._
 import sttp.tapir.docs.apispec.schema._
 import sttp.tapir.generic.auto._
@@ -57,12 +57,12 @@ import sttp.tapir.Schema.annotations.title
  case class Child(childName: String)
  val tSchema = implicitly[Schema[Parent]]
 
- val jsonSchema: ReferenceOr[ASchema] = TapirSchemaToJsonSchema(
+ val jsonSchema: ASchema = TapirSchemaToJsonSchema(
  tSchema,
  markOptionsAsNullable = true)
 
  // JSON serialization
- val schemaAsJson = jsonSchema.getOrElse(ASchema(ASchemaType.Null)).asJson
+ val schemaAsJson = jsonSchema.asJson
  val schemaStr: String = Printer.spaces2.print(schemaAsJson.deepDropNullValues)
 ```
 

diff --git a/generated-doc/out/docs/openapi.md b/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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-bundle" % "1.8.0"
 ```
 
 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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-redoc-bundle" % "1.8.0"
 ```
 
 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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.8.0"
 "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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-openapi-docs" % "1.8.0"
 "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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-swagger-ui" % "1.8.0"
 ```
 
 or `tapir-redoc`:
 ```scala
-"com.softwaremill.sttp.tapir" %% "tapir-redoc" % "1.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-redoc" % "1.8.0"
 ```
 
 Then, you'll need to pass the server endpoints to your server interpreter. For example, using akka-http:

diff --git a/generated-doc/out/endpoint/integrations.md b/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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-cats" % "1.8.0"
 ```
 
 - `import sttp.tapir.integ.cats.codec._` - brings schema, validator and codec instances
@@ -24,7 +24,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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-cats-effect" % "1.8.0"
 ```
 
 ## Refined integration
@@ -33,7 +33,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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-refined" % "1.8.0"
 ```
 
 You'll need to extend the `sttp.tapir.codec.refined.TapirCodecRefined`
@@ -54,7 +54,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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-iron" % "1.8.0"
 ```
 
 The module is only available for Scala 3 since iron is not designed to work with Scala 2.
@@ -72,7 +72,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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-enumeratum" % "1.8.0"
 ```
 
 Then, `import sttp.tapir.codec.enumeratum._`, or extends the `sttp.tapir.codec.enumeratum.TapirCodecEnumeratum` trait.
@@ -85,7 +85,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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-newtype" % "1.8.0"
 ```
 
 Then, `import sttp.tapir.codec.newtype._`, or extend the `sttp.tapir.codec.newtype.TapirCodecNewType` trait to bring the implicit values into scope.
@@ -96,7 +96,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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-monix-newtype" % "1.8.0"
 ```
 
 Then, `import sttp.tapir.codec.monix.newtype._`, or extend the `sttp.tapir.codec.monix.newtype.TapirCodecMonixNewType` trait to bring the implicit values into scope.
@@ -107,7 +107,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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-zio-prelude" % "1.8.0"
 ```
 
 Then, mix in `sttp.tapir.codec.zio.prelude.newtype.TapirNewtypeSupport` into your newtype to bring the implicit values into scope:
@@ -146,7 +146,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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-derevo" % "1.8.0"
 ```
 
 Then you can derive schema for your ADT along with other typeclasses besides ADT declaration itself:

diff --git a/generated-doc/out/endpoint/json.md b/generated-doc/out/endpoint/json.md
@@ -52,7 +52,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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-json-circe" % "1.8.0"
 ```
 
 Next, import the package (or extend the `TapirJsonCirce` trait, see [MyTapir](../mytapir.md)):
@@ -125,7 +125,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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-json-upickle" % "1.8.0"
 ```
 
 Next, import the package (or extend the `TapirJsonuPickle` trait, see [MyTapir](../mytapir.md) and add `TapirJsonuPickle` not `TapirCirceJson`):
@@ -160,7 +160,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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-json-play" % "1.8.0"
 ```
 
 Next, import the package (or extend the `TapirJsonPlay` trait, see [MyTapir](../mytapir.md) and add `TapirJsonPlay` not `TapirCirceJson`):
@@ -176,7 +176,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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-json-spray" % "1.8.0"
 ```
 
 Next, import the package (or extend the `TapirJsonSpray` trait, see [MyTapir](../mytapir.md) and add `TapirJsonSpray` not `TapirCirceJson`):
@@ -192,7 +192,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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-json-tethys" % "1.8.0"
 ```
 
 Next, import the package (or extend the `TapirJsonTethys` trait, see [MyTapir](../mytapir.md) and add `TapirJsonTethys` not `TapirCirceJson`):
@@ -208,7 +208,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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-jsoniter-scala" % "1.8.0"
 ```
 
 Next, import the package (or extend the `TapirJsonJsoniter` trait, see [MyTapir](../mytapir.md) and add `TapirJsonJsoniter` not `TapirCirceJson`):
@@ -224,7 +224,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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-json-json4s" % "1.8.0"
 ```
 
 And one of the implementations:
@@ -255,7 +255,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.7.6"
+"com.softwaremill.sttp.tapir" %% "tapir-json-zio" % "1.8.0"
 ```
 Next, import the package (or extend the `TapirJsonZio` trait, see [MyTapir](../mytapir.md) and add `TapirJsonZio` instead of `TapirCirceJson`):