Release 3.8.12

README.md

@@ -45,14 +45,14 @@ sttp (v2) documentation is available at [sttp.softwaremill.com/en/v2](http://stt
 
 sttp (v1) documentation is available at [sttp.softwaremill.com/en/v1](https://sttp.softwaremill.com/en/v1).
 
-scaladoc is available at [https://www.javadoc.io](https://www.javadoc.io/doc/com.softwaremill.sttp.client3/core_2.12/3.8.11)
+scaladoc is available at [https://www.javadoc.io](https://www.javadoc.io/doc/com.softwaremill.sttp.client3/core_2.12/3.8.12)
 
 ## Quickstart with Ammonite
 
 If you are an [Ammonite](http://ammonite.io) user, you can quickly start experimenting with sttp by copy-pasting the following:
 
 ```scala
-import $ivy.`com.softwaremill.sttp.client3::core:3.8.11`
+import $ivy.`com.softwaremill.sttp.client3::core:3.8.12`
 import sttp.client3.quick._
 quickRequest.get(uri"http://httpbin.org/ip").send(backend)
 ```
@@ -64,7 +64,7 @@ This brings in the sttp API and a synchronous backend instance.
 Add the following dependency:
 
 ```scala
-"com.softwaremill.sttp.client3" %% "core" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "core" % "3.8.12"
 ```
 
 Then, import:
@@ -119,7 +119,7 @@ The documentation is typechecked using [mdoc](https://scalameta.org/mdoc/). The
 
 When generating documentation, it's best to set the version to the current one, so that the generated doc files don't include modifications with the current snapshot version. 
 
-That is, in sbt run: `set version := "3.8.11"`, before running `mdoc` in `docs`.
+That is, in sbt run: `set version := "3.8.12"`, before running `mdoc` in `docs`.
 
 ### Testing the Scala.JS backend
 

generated-docs/out/backends/akka.md

@@ -3,7 +3,7 @@
 This backend is based on [akka-http](http://doc.akka.io/docs/akka-http/current/scala/http/). To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %% "akka-http-backend" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "akka-http-backend" % "3.8.12"
 ```
 
 A fully **asynchronous** backend. Uses the `Future` effect to return responses. There are also [other `Future`-based backends](future.md), which don't depend on Akka. 

generated-docs/out/backends/catseffect.md

@@ -76,9 +76,9 @@ Creation of the backend can be done in two basic ways:
 Firstly, add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.client3" %% "armeria-backend-cats" % "3.8.11" // for cats-effect 3.x
+"com.softwaremill.sttp.client3" %% "armeria-backend-cats" % "3.8.12" // for cats-effect 3.x
 // or
-"com.softwaremill.sttp.client3" %% "armeria-backend-cats-ce2" % "3.8.11" // for cats-effect 2.x
+"com.softwaremill.sttp.client3" %% "armeria-backend-cats-ce2" % "3.8.12" // for cats-effect 2.x
 ```
 
 create client:

generated-docs/out/backends/finagle.md

@@ -3,7 +3,7 @@
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %% "finagle-backend" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "finagle-backend" % "3.8.12"
 ```
 
 Next you'll need to add an implicit value:

generated-docs/out/backends/fs2.md

@@ -12,9 +12,9 @@ Creation of the backend can be done in two basic ways:
 Firstly, add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.client3" %% "fs2" % "3.8.11" // for cats-effect 3.x & fs2 3.x
+"com.softwaremill.sttp.client3" %% "fs2" % "3.8.12" // for cats-effect 3.x & fs2 3.x
 // or 
-"com.softwaremill.sttp.client3" %% "fs2-ce2" % "3.8.11" // for cats-effect 2.x & fs2 2.x
+"com.softwaremill.sttp.client3" %% "fs2-ce2" % "3.8.12" // for cats-effect 2.x & fs2 2.x
 ```
 
 Obtain a cats-effect `Resource` which creates the backend, and closes the thread pool after the resource is no longer used:
@@ -78,9 +78,9 @@ Host header override is supported in environments running Java 12 onwards, but i
 To use, add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.client3" %% "armeria-backend-fs2" % "3.8.11" // for cats-effect 3.x & fs2 3.x
+"com.softwaremill.sttp.client3" %% "armeria-backend-fs2" % "3.8.12" // for cats-effect 3.x & fs2 3.x
 // or
-"com.softwaremill.sttp.client3" %% "armeria-backend-fs2" % "3.8.11" // for cats-effect 2.x & fs2 2.x
+"com.softwaremill.sttp.client3" %% "armeria-backend-fs2" % "3.8.12" // for cats-effect 2.x & fs2 2.x
 ```
 
 create client:

generated-docs/out/backends/future.md

@@ -20,7 +20,7 @@ Class                                 Supported stream type
 To use, you don't need any extra dependencies, `core` is enough:
 
 ```
-"com.softwaremill.sttp.client3" %% "core" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "core" % "3.8.12"
 ```
 
 You'll need the following imports:
@@ -59,7 +59,7 @@ Host header override is supported in environments running Java 12 onwards, but i
 To use, add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.client3" %% "okhttp-backend" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "okhttp-backend" % "3.8.12"
 ```
 
 and some imports:
@@ -91,7 +91,7 @@ This backend depends on [OkHttp](http://square.github.io/okhttp/) and fully supp
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %% "armeria-backend" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "armeria-backend" % "3.8.12"
 ```
 
 add imports:

generated-docs/out/backends/http4s.md

@@ -3,9 +3,9 @@
 This backend is based on [http4s](https://http4s.org) (client) and is **asynchronous**. To use, add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.client3" %% "http4s-backend" % "3.8.11" // for cats-effect 3.x & http4s 1.0.0-Mx
+"com.softwaremill.sttp.client3" %% "http4s-backend" % "3.8.12" // for cats-effect 3.x & http4s 1.0.0-Mx
 // or
-"com.softwaremill.sttp.client3" %% "http4s-ce2-backend" % "3.8.11" // for cats-effect 2.x & http4s 0.21.x
+"com.softwaremill.sttp.client3" %% "http4s-ce2-backend" % "3.8.12" // for cats-effect 2.x & http4s 0.21.x
 ```
 
 The backend can be created in a couple of ways, e.g.:

generated-docs/out/backends/javascript/fetch.md

@@ -7,7 +7,7 @@ A JavaScript backend with web socket support. Implemented using the [Fetch API](
 This is the default backend, available in the main jar for JS. To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %%% "core" % "3.8.11"
+"com.softwaremill.sttp.client3" %%% "core" % "3.8.12"
 ```
 
 And create the backend instance:
@@ -26,7 +26,7 @@ Note that `Fetch` does not pass cookies by default. If your request needs cookie
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %%% "monix" % "3.8.11"
+"com.softwaremill.sttp.client3" %%% "monix" % "3.8.12"
 ```
 
 And create the backend instance:
@@ -40,7 +40,7 @@ val backend = FetchMonixBackend()
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %%% "zio" % "3.8.11"
+"com.softwaremill.sttp.client3" %%% "zio" % "3.8.12"
 ```
 
 And create the backend instance:
@@ -55,13 +55,13 @@ Any effect implementing the cats-effect `Concurrent` typeclass can be used. To u
 your project:
 
 ```
-"com.softwaremill.sttp.client3" %%% "cats" % "3.8.11"
+"com.softwaremill.sttp.client3" %%% "cats" % "3.8.12"
 ```
 
 If you are on Cats Effect 2 (CE2) you will need to add the CE2 specific dependency instead:
 
 ```
-"com.softwaremill.sttp.client3" %%% "catsce2 % "3.8.11"
+"com.softwaremill.sttp.client3" %%% "catsce2 % "3.8.12"
 ```
 
 And create the backend instance:
@@ -129,7 +129,7 @@ Streaming support is provided via `FetchMonixBackend`. Note that streaming suppo
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %%% "monix" % "3.8.11"
+"com.softwaremill.sttp.client3" %%% "monix" % "3.8.12"
 ```
 
 An example of streaming a response:

generated-docs/out/backends/monix.md

@@ -12,7 +12,7 @@ Creation of the backend can be done in two basic ways:
 Firstly, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %% "monix" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "monix" % "3.8.12"
 ```
 
 and create the backend using:
@@ -50,7 +50,7 @@ Host header override is supported in environments running Java 12 onwards, but i
 To use, add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.client3" %% "okhttp-backend-monix" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "okhttp-backend-monix" % "3.8.12"
 ```
 
 Create the backend using:
@@ -76,7 +76,7 @@ This backend depends on [OkHttp](http://square.github.io/okhttp/) and fully supp
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %% "armeria-backend-monix" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "armeria-backend-monix" % "3.8.12"
 ```
 
 add imports:

generated-docs/out/backends/native/curl.md

@@ -5,7 +5,7 @@ A Scala Native backend implemented using [Curl](https://github.com/curl/curl/blo
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %%% "core" % "3.8.11"
+"com.softwaremill.sttp.client3" %%% "core" % "3.8.12"
 ```
 
 and initialize one of the backends:

generated-docs/out/backends/scalaz.md

@@ -8,7 +8,7 @@ The [Scalaz](https://github.com/scalaz/scalaz) backend is **asynchronous**. Send
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %% "armeria-backend-scalaz" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "armeria-backend-scalaz" % "3.8.12"
 ```
 
 add imports:

generated-docs/out/backends/synchronous.md

@@ -7,7 +7,7 @@ There are several synchronous backend implementations. Sending a request using t
 The default **synchronous** backend. To use, you don't need any extra dependencies, `core` is enough:
 
 ```
-"com.softwaremill.sttp.client3" %% "core" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "core" % "3.8.12"
 ```
 
 Create the backend using:
@@ -40,7 +40,7 @@ Host header override is supported in environments running Java 12 onwards, but i
 To use, you don't need any extra dependencies, `core` is enough: 
 
 ```
-"com.softwaremill.sttp.client3" %% "core" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "core" % "3.8.12"
 ```
 
 Create the backend using:
@@ -62,7 +62,7 @@ This backend supports host header override, but it has to be enabled by system p
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %% "okhttp-backend" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "okhttp-backend" % "3.8.12"
 ```
 
 Create the backend using:

generated-docs/out/backends/wrappers/custom.md

@@ -238,7 +238,7 @@ object RateLimitingSttpBackend {
 Implementing a new backend is made easy as the tests are published in the `core` jar file under the `tests` classifier. Simply add the follow dependencies to your `build.sbt`:
 
 ```
-"com.softwaremill.sttp.client3" %% "core" % "3.8.11" % Test classifier "tests"
+"com.softwaremill.sttp.client3" %% "core" % "3.8.12" % Test classifier "tests"
 ```
 
 Implement your backend and extend the `HttpTest` class:
@@ -268,9 +268,9 @@ import sttp.client3.impl.cats.implicits._
 from the cats integration module. The module should be available on the classpath after adding following dependency:
 
 ```scala
-"com.softwaremill.sttp.client3" %% "cats" % "3.8.11" // for cats-effect 3.x
+"com.softwaremill.sttp.client3" %% "cats" % "3.8.12" // for cats-effect 3.x
 // or
-"com.softwaremill.sttp.client3" %% "catsce2" % "3.8.11" // for cats-effect 2.x
+"com.softwaremill.sttp.client3" %% "catsce2" % "3.8.12" // for cats-effect 2.x
 ```
 
 The object contains implicits to convert a cats `MonadError` into the sttp `MonadError`, 

generated-docs/out/backends/wrappers/logging.md

@@ -28,7 +28,7 @@ Log levels can be configured when creating the `LoggingBackend`, or specified in
 To use the [slf4j](http://www.slf4j.org) logging backend wrapper, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %% "slf4j-backend" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "slf4j-backend" % "3.8.12"
 ``` 
 
 There are three backend wrappers available, which log request & response information using a slf4j `Logger`. To see the logs, you'll need to use an slf4j-compatible logger implementation, e.g.  [logback](http://logback.qos.ch), or use a binding, e.g. [log4j-slf4j](https://logging.apache.org/log4j/2.0/log4j-slf4j-impl/index.html).
@@ -50,5 +50,5 @@ To create a customised logging backend, see the section on [custom backends](cus
 To use the [scribe](https://github.com/outr/scribe) logging backend wrapper, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %% "scribe-backend" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "scribe-backend" % "3.8.12"
 ``` 

generated-docs/out/backends/wrappers/opentelemetry.md

@@ -12,7 +12,7 @@ The backend depends only on [opentelemetry-api](https://github.com/open-telemetr
 following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %% "opentelemetry-metrics-backend" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "opentelemetry-metrics-backend" % "3.8.12"
 ```
 
 Then an instance can be obtained as follows:
@@ -53,8 +53,8 @@ OpenTelemetryMetricsBackend(
 To use, add the following dependency to your project (the `zio-*` modules depend on ZIO 2.x; for ZIO 1.x support, use `zio1-*`):
 
 ```
-"com.softwaremill.sttp.client3" %% "opentelemetry-tracing-zio-backend" % "3.8.11"  // for ZIO 2.x
-"com.softwaremill.sttp.client3" %% "opentelemetry-tracing-zio1-backend" % "3.8.11" // for ZIO 1.x
+"com.softwaremill.sttp.client3" %% "opentelemetry-tracing-zio-backend" % "3.8.12"  // for ZIO 2.x
+"com.softwaremill.sttp.client3" %% "opentelemetry-tracing-zio1-backend" % "3.8.12" // for ZIO 1.x
 ```
 
 This backend depends on [zio-opentelemetry](https://github.com/zio/zio-telemetry).

generated-docs/out/backends/wrappers/prometheus.md

@@ -3,7 +3,7 @@
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %% "prometheus-backend" % "3.8.11"
+"com.softwaremill.sttp.client3" %% "prometheus-backend" % "3.8.12"
 ```
 
 and some imports:

generated-docs/out/backends/zio.md

@@ -9,8 +9,8 @@ The `*-zio` modules depend on ZIO 2.x. For ZIO 1.x support, use modules with the
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %% "zio" % "3.8.11"  // for ZIO 2.x
-"com.softwaremill.sttp.client3" %% "zio1" % "3.8.11" // for ZIO 1.x
+"com.softwaremill.sttp.client3" %% "zio" % "3.8.12"  // for ZIO 2.x
+"com.softwaremill.sttp.client3" %% "zio1" % "3.8.12" // for ZIO 1.x
 ```
 
 Create the backend using:
@@ -40,14 +40,13 @@ Host header override is supported in environments running Java 12 onwards, but i
 -Djdk.httpclient.allowRestrictedHeaders=host
 ```
 
-
 ## Using Armeria
 
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client3" %% "armeria-backend-zio" % "3.8.11"  // for ZIO 2.x
-"com.softwaremill.sttp.client3" %% "armeria-backend-zio1" % "3.8.11" // for ZIO 1.x
+"com.softwaremill.sttp.client3" %% "armeria-backend-zio" % "3.8.12"  // for ZIO 2.x
+"com.softwaremill.sttp.client3" %% "armeria-backend-zio1" % "3.8.12" // for ZIO 1.x
 ```
 
 add imports:
@@ -96,9 +95,9 @@ This backend is build on top of [Armeria](https://armeria.dev/docs/client-http).
 Armeria's [ClientFactory](https://armeria.dev/docs/client-factory) manages connections and protocol-specific properties.
 Please visit [the official documentation](https://armeria.dev/docs/client-factory) to learn how to configure it.
 
-## ZIO layers
+## ZIO layers + constructors
 
-As an alternative to effectfully or resourcefully creating backend instances, ZIO layers can be used. In this scenario, the lifecycle of a `SttpBackend` service is described by `ZLayer`s, which can be created using the `.layer`/`.layerUsingConfig`/... methods on `HttpClientZioBackend` / `ArmeriaZioBackend`.
+When using constructors to express service dependencies, ZIO layers can be used to provide the `SttpBackend` instance, instead of creating one by hand. In this scenario, the lifecycle of a `SttpBackend` service is described by `ZLayer`s, which can be created using the `.layer`/`.layerUsingConfig`/... methods on `HttpClientZioBackend` / `ArmeriaZioBackend`.
 
 The layers can be used to provide an implementation of the `SttpBackend` dependency when creating services. For example:
 
@@ -121,6 +120,33 @@ object MyService {
 ZLayer.make[MyService](MyService.live, HttpClientZioBackend.layer())
 ```
 
+## ZIO environment
+
+As yet another alternative to effectfully or resourcefully creating backend instances, ZIO environment can be used. There are top-level `send` and `sendR` top-level methods which require a `SttpClient` to be available in the environment. The `SttpClient` itself is a type alias:
+
+ ```scala
+ package sttp.client3.httpclient.zio
+ type SttpClient = SttpBackend[Task, ZioStreams with WebSockets]
+
+ // or, when using Armeria
+ package sttp.client3.armeria.zio
+ type SttpClient = SttpBackend[Task, ZioStreams]
+ ```
+
+The lifecycle of the `SttpClient` service is described by `ZLayer`s, which can be created using the `.layer`/`.layerUsingConfig`/... methods on `HttpClientZioBackend` / `ArmeriaZioBackend`.
+
+The `SttpClient` companion object contains effect descriptions which use the `SttpClient` service from the environment to send requests or open websockets. This is different from sttp usage with other effect libraries (which require invoking `.send(backend)` on the request), but is more in line with one of the styles of using ZIO. For example:
+
+ ```scala mdoc:compile-only
+ import sttp.client3._
+ import sttp.client3.httpclient.zio._
+ import zio._
+
+ val request = basicRequest.get(uri"https://httpbin.org/get")
+ val sent: ZIO[SttpClient, Throwable, Response[Either[String, String]]] = 
+   send(request)
+ ```
+
 ## Streaming
 
 The ZIO based backends support streaming using zio-streams. The following example is using the `HttpClientZioBackend`.