Release 4.0.0-M11

README.md

@@ -48,15 +48,15 @@ sttp (v2) documentation is available at [sttp.softwaremill.com/en/v2](https://st
 
 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.client4/core_2.12/4.0.0-M10)
+scaladoc is available at [https://www.javadoc.io](https://www.javadoc.io/doc/com.softwaremill.sttp.client4/core_2.12/4.0.0-M11)
 
 ## Quickstart with scala-cli
 
 Add the following directive to the top of your scala file to add the core sttp dependency:
 If you are using [scala-cli](https://scala-cli.virtuslab.org), you can quickly start experimenting with sttp by copy-pasting the following:
 
 ```
-//> using lib "com.softwaremill.sttp.client4::core:4.0.0-M10"
+//> using lib "com.softwaremill.sttp.client4::core:4.0.0-M11"
 import sttp.client4.quick._
 quickRequest.get(uri"http://httpbin.org/ip").send()
 ```
@@ -68,7 +68,7 @@ The `quick` package import brings in the sttp API and a pre-configured, global s
 Similarly, using [Ammonite](http://ammonite.io):
 
 ```scala
-import $ivy.`com.softwaremill.sttp.client4::core:4.0.0-M10`
+import $ivy.`com.softwaremill.sttp.client4::core:4.0.0-M11`
 import sttp.client4.quick._
 quickRequest.get(uri"http://httpbin.org/ip").send()
 ```
@@ -78,7 +78,7 @@ quickRequest.get(uri"http://httpbin.org/ip").send()
 Add the following dependency:
 
 ```scala
-"com.softwaremill.sttp.client4" %% "core" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "core" % "4.0.0-M11"
 ```
 
 Then, import:
@@ -133,7 +133,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 := "4.0.0-M10"`, before running `mdoc` in `docs`.
+That is, in sbt run: `set version := "4.0.0-M11"`, 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.client4" %% "akka-http-backend" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "akka-http-backend" % "4.0.0-M11"
 ```
 
 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

@@ -14,7 +14,7 @@ Also note that the [http4s](http4s.md) backend can also be created for a type im
 Firstly, add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.client4" %% "cats" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "cats" % "4.0.0-M11"
 ```
 
 Obtain a cats-effect `Resource` which creates the backend, and closes the thread pool after the resource is no longer used:
@@ -82,9 +82,9 @@ Creation of the backend can be done in two basic ways:
 Firstly, add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.client4" %% "armeria-backend-cats" % "4.0.0-M10" // for cats-effect 3.x
+"com.softwaremill.sttp.client4" %% "armeria-backend-cats" % "4.0.0-M11" // for cats-effect 3.x
 // or
-"com.softwaremill.sttp.client4" %% "armeria-backend-cats-ce2" % "4.0.0-M10" // for cats-effect 2.x
+"com.softwaremill.sttp.client4" %% "armeria-backend-cats-ce2" % "4.0.0-M11" // 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.client4" %% "finagle-backend" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "finagle-backend" % "4.0.0-M11"
 ```
 
 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.client4" %% "fs2" % "4.0.0-M10" // for cats-effect 3.x & fs2 3.x
+"com.softwaremill.sttp.client4" %% "fs2" % "4.0.0-M11" // for cats-effect 3.x & fs2 3.x
 // or 
-"com.softwaremill.sttp.client4" %% "fs2ce2" % "4.0.0-M10" // for cats-effect 2.x & fs2 2.x
+"com.softwaremill.sttp.client4" %% "fs2ce2" % "4.0.0-M11" // 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.client4" %% "armeria-backend-fs2" % "4.0.0-M10" // for cats-effect 3.x & fs2 3.x
+"com.softwaremill.sttp.client4" %% "armeria-backend-fs2" % "4.0.0-M11" // for cats-effect 3.x & fs2 3.x
 // or
-"com.softwaremill.sttp.client4" %% "armeria-backend-fs2" % "4.0.0-M10" // for cats-effect 2.x & fs2 2.x
+"com.softwaremill.sttp.client4" %% "armeria-backend-fs2" % "4.0.0-M11" // 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.client4" %% "core" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "core" % "4.0.0-M11"
 ```
 
 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.client4" %% "okhttp-backend" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "okhttp-backend" % "4.0.0-M11"
 ```
 
 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.client4" %% "armeria-backend" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "armeria-backend" % "4.0.0-M11"
 ```
 
 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.client4" %% "http4s-backend" % "4.0.0-M10" // for cats-effect 3.x & http4s 1.0.0-Mx
+"com.softwaremill.sttp.client4" %% "http4s-backend" % "4.0.0-M11" // for cats-effect 3.x & http4s 1.0.0-Mx
 // or
-"com.softwaremill.sttp.client4" %% "http4s-ce2-backend" % "4.0.0-M10" // for cats-effect 2.x & http4s 0.21.x
+"com.softwaremill.sttp.client4" %% "http4s-ce2-backend" % "4.0.0-M11" // 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.client4" %%% "core" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %%% "core" % "4.0.0-M11"
 ```
 
 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.client4" %%% "monix" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %%% "monix" % "4.0.0-M11"
 ```
 
 And create the backend instance:
@@ -40,7 +40,7 @@ val backend = FetchMonixBackend()
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client4" %%% "zio" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %%% "zio" % "4.0.0-M11"
 ```
 
 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.client4" %%% "cats" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %%% "cats" % "4.0.0-M11"
 ```
 
 If you are on Cats Effect 2 (CE2) you will need to add the CE2 specific dependency instead:
 
 ```
-"com.softwaremill.sttp.client4" %%% "catsce2 % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %%% "catsce2 % "4.0.0-M11"
 ```
 
 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.client4" %%% "monix" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %%% "monix" % "4.0.0-M11"
 ```
 
 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.client4" %% "monix" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "monix" % "4.0.0-M11"
 ```
 
 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.client4" %% "okhttp-backend-monix" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "okhttp-backend-monix" % "4.0.0-M11"
 ```
 
 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.client4" %% "armeria-backend-monix" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "armeria-backend-monix" % "4.0.0-M11"
 ```
 
 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.client4" %%% "core" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %%% "core" % "4.0.0-M11"
 ```
 
 and initialize one of the backends:

generated-docs/out/backends/pekko.md

@@ -3,7 +3,7 @@
 This backend is based on [pekko-http](https://pekko.apache.org/docs/pekko-http/current/). To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client4" %% "pekko-http-backend" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "pekko-http-backend" % "4.0.0-M11"
 ```
 
 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 Pekko. 

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.client4" %% "armeria-backend-scalaz" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "armeria-backend-scalaz" % "4.0.0-M11"
 ```
 
 add imports:

generated-docs/out/backends/summary.md

@@ -29,24 +29,24 @@ Below is a summary of all the JVM backends; see the sections on individual backe
 ==================================== ================================ ================================================= ========================== ===================
 Class                                Effect type                      Supported stream type                             Supports websockets        Fully non-blocking
 ==================================== ================================ ================================================= ========================== ===================
-``DefaultSyncBackend``               None (``Identity``)              n/a                                               yes (regular)              no
-``HttpClientSyncBackend``            None (``Identity``)              n/a                                               yes (regular)              no
-``DefaultFutureBackend``             ``scala.concurrent.Future``      n/a                                               yes (regular)              no
-``HttpClientFutureBackend``          ``scala.concurrent.Future``      n/a                                               yes (regular)              no
+``DefaultSyncBackend``               None (``Identity``)              ``java.io.InputStream`` (blocking)                yes (regular)              no
+``HttpClientSyncBackend``            None (``Identity``)              ``java.io.InputStream`` (blocking)                yes (regular)              no
+``DefaultFutureBackend``             ``scala.concurrent.Future``      ``java.io.InputStream`` (blocking)                yes (regular)              no
+``HttpClientFutureBackend``          ``scala.concurrent.Future``      ``java.io.InputStream`` (blocking)                yes (regular)              no
 ``HttpClientMonixBackend``           ``monix.eval.Task``              ``monix.reactive.Observable[ByteBuffer]``         yes (regular & streaming)  yes
 ``HttpClientFs2Backend``             ``F[_]: cats.effect.Concurrent`` ``fs2.Stream[F, Byte]``                           yes (regular & streaming)  yes
 ``HttpClientZioBackend``             ``zio.Task``                     ``zio.stream.Stream[Throwable, Byte]``            yes (regular & streaming)  yes
-``HttpURLConnectionBackend``         None (``Identity``)              n/a                                               no                         no
-``TryHttpURLConnectionBackend``      ``scala.util.Try``               n/a                                               no                         no
+``HttpURLConnectionBackend``         None (``Identity``)              ``java.io.InputStream`` (blocking)                no                         no
+``TryHttpURLConnectionBackend``      ``scala.util.Try``               ``java.io.InputStream`` (blocking)                no                         no
 ``AkkaHttpBackend``                  ``scala.concurrent.Future``      ``akka.stream.scaladsl.Source[ByteString, Any]``  yes (regular & streaming)  yes
 ``ArmeriaFutureBackend``             ``scala.concurrent.Future``      n/a                                               no                         yes
 ``ArmeriaScalazBackend``             ``scalaz.concurrent.Task``       n/a                                               no                         yes
 ``ArmeriaZioBackend``                ``zio.Task``                     ``zio.stream.Stream[Throwable, Byte]``            no                         yes
 ``ArmeriaMonixBackend``              ``monix.eval.Task``              ``monix.reactive.Observable[HttpData]``           no                         yes
 ``ArmeriaCatsBackend``               ``F[_]: cats.effect.Concurrent`` n/a                                               no                         yes
 ``ArmeriaFs2Backend``                ``F[_]: cats.effect.Concurrent`` ``fs2.Stream[F, Byte]``                           no                         yes
-``OkHttpSyncBackend``                None (``Identity``)              n/a                                               yes (regular)              no
-``OkHttpFutureBackend``              ``scala.concurrent.Future``      n/a                                               yes (regular)              no
+``OkHttpSyncBackend``                None (``Identity``)              ``java.io.InputStream`` (blocking)                yes (regular)              no
+``OkHttpFutureBackend``              ``scala.concurrent.Future``      ``java.io.InputStream`` (blocking)                yes (regular)              no
 ``OkHttpMonixBackend``               ``monix.eval.Task``              ``monix.reactive.Observable[ByteBuffer]``         yes (regular & streaming)  no
 ``Http4sBackend``                    ``F[_]: cats.effect.Effect``     ``fs2.Stream[F, Byte]``                           no                         no
 ``FinagleBackend``                   ``com.twitter.util.Future``      n/a                                               no                         no
@@ -121,4 +121,4 @@ Depending on the capabilities that a backend supports, the exact backend type di
 Each backend type extends `GenericBackend` has two type parameters:
 
 * `F[_]`, the type constructor used to represent side effects. That is, when you invoke `send(backend)` on a request description, do you get a `Response[_]` directly, or is it wrapped in a `Future` or a `Task`?
-* `P`, the capabilities supported by the backend, in addition to `Effect[F]`. If `Any`, no additional capabilities are provided. Might include `Streams` (the ability to send and receive streaming bodies) and `WebSockets` (the ability to handle websocket requests).
+* `P`, the capabilities supported by the backend, in addition to `Effect[F]`. If `Any`, no additional capabilities are provided. Might include `Streams` (the ability to send and receive streaming bodies) and `WebSockets` (the ability to handle websocket requests).

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.client4" %% "core" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "core" % "4.0.0-M11"
 ```
 
 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.client4" %% "core" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "core" % "4.0.0-M11"
 ```
 
 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.client4" %% "okhttp-backend" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "okhttp-backend" % "4.0.0-M11"
 ```
 
 Create the backend using:

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

@@ -260,7 +260,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.client4" %% "core" % "4.0.0-M10" % Test classifier "tests"
+"com.softwaremill.sttp.client4" %% "core" % "4.0.0-M11" % Test classifier "tests"
 ```
 
 Implement your backend and extend the `HttpTest` class:
@@ -290,9 +290,9 @@ import sttp.client4.impl.cats.implicits._
 from the cats integration module. The module should be available on the classpath after adding following dependency:
 
 ```scala
-"com.softwaremill.sttp.client4" %% "cats" % "4.0.0-M10" // for cats-effect 3.x
+"com.softwaremill.sttp.client4" %% "cats" % "4.0.0-M11" // for cats-effect 3.x
 // or
-"com.softwaremill.sttp.client4" %% "catsce2" % "4.0.0-M10" // for cats-effect 2.x
+"com.softwaremill.sttp.client4" %% "catsce2" % "4.0.0-M11" // 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.client4" %% "slf4j-backend" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "slf4j-backend" % "4.0.0-M11"
 ``` 
 
 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).
@@ -53,5 +53,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.client4" %% "scribe-backend" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "scribe-backend" % "4.0.0-M11"
 ``` 

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.client4" %% "opentelemetry-metrics-backend" % "4.0.0-M10"
+"com.softwaremill.sttp.client4" %% "opentelemetry-metrics-backend" % "4.0.0-M11"
 ```
 
 Then an instance can be obtained as follows:
@@ -55,7 +55,7 @@ OpenTelemetryMetricsBackend(
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client4" %% "opentelemetry-tracing-zio-backend" % "4.0.0-M10"  // for ZIO 2.x
+"com.softwaremill.sttp.client4" %% "opentelemetry-tracing-zio-backend" % "4.0.0-M11"  // for ZIO 2.x
 ```
 
 This backend depends on [zio-opentelemetry](https://github.com/zio/zio-telemetry).