Fix docs

softwaremill · Jul 13, 2023 · 5060120 · 5060120
1 parent 9af5780
commit 5060120
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 14 deletions.
diff --git a/docs/conf/redirects.md b/docs/conf/redirects.md
@@ -36,8 +36,8 @@ You can disable the stripping of all sensitive headers using the following code:
 import sttp.client4._
 import sttp.client4.wrappers.{FollowRedirectsBackend, FollowRedirectsConfig}
 
-val myBackend: SyncBackend = DefaultSyncBackend()
-val backend: SyncBackend = FollowRedirectsBackend(
+val myBackend: WebSocketBackend[Identity] = DefaultSyncBackend()
+val backend: WebSocketBackend[Identity] = FollowRedirectsBackend(
  delegate = myBackend, 
  FollowRedirectsConfig(
  sensitiveHeaders = Set.empty
@@ -52,8 +52,8 @@ import sttp.client4._
 import sttp.model._
 import sttp.client4.wrappers.{FollowRedirectsBackend, FollowRedirectsConfig}
 
-val myBackend: SyncBackend = DefaultSyncBackend()
-val backend: SyncBackend = FollowRedirectsBackend(
+val myBackend: WebSocketBackend[Identity] = DefaultSyncBackend()
+val backend: WebSocketBackend[Identity] = FollowRedirectsBackend(
  delegate = myBackend,
  FollowRedirectsConfig(
  sensitiveHeaders = HeaderNames.SensitiveHeaders.filterNot(_ == HeaderNames.Authorization.toLowerCase)
@@ -104,8 +104,8 @@ import sttp.client4._
 import sttp.client4.wrappers.{FollowRedirectsBackend, FollowRedirectsConfig}
 import sttp.model.Uri.QuerySegmentEncoding
 
-val myBackend: SyncBackend = DefaultSyncBackend()
-val backend: SyncBackend = FollowRedirectsBackend(
+val myBackend: WebSocketBackend[Identity] = DefaultSyncBackend()
+val backend: WebSocketBackend[Identity] = FollowRedirectsBackend(
  delegate = myBackend,
  FollowRedirectsConfig(
  // encodes all special characters in the query segment, including the allowed ones

diff --git a/docs/json.md b/docs/json.md
@@ -46,7 +46,7 @@ Response can be parsed into json using `asJson[T]`, provided there's an implicit
 import sttp.client4._
 import sttp.client4.circe._
 
-val backend: SyncBackend = DefaultSyncBackend()
+val backend: WebSocketBackend[Identity] = DefaultSyncBackend()
 
 import io.circe.generic.auto._
 val requestPayload = RequestPayload("some data")
@@ -80,7 +80,7 @@ Usage example:
 import sttp.client4._
 import sttp.client4.json4s._
 
-val backend: SyncBackend = DefaultSyncBackend()
+val backend: WebSocketBackend[Identity] = DefaultSyncBackend()
 
 val requestPayload = RequestPayload("some data")
 
@@ -112,7 +112,7 @@ import sttp.client4._
 import sttp.client4.sprayJson._
 import spray.json._
 
-val backend: SyncBackend = DefaultSyncBackend()
+val backend: WebSocketBackend[Identity] = DefaultSyncBackend()
 
 implicit val payloadJsonFormat: RootJsonFormat[RequestPayload] = ???
 implicit val myResponseJsonFormat: RootJsonFormat[ResponsePayload] = ???
@@ -163,7 +163,7 @@ import sttp.client4._
 import sttp.client4.ziojson._
 import zio.json._
 
-val backend: SyncBackend = DefaultSyncBackend()
+val backend: WebSocketBackend[Identity] = DefaultSyncBackend()
 
 implicit val payloadJsonEncoder: JsonEncoder[RequestPayload] = DeriveJsonEncoder.gen[RequestPayload]
 implicit val myResponseJsonDecoder: JsonDecoder[ResponsePayload] = DeriveJsonDecoder.gen[ResponsePayload]
@@ -203,7 +203,7 @@ import sttp.client4.jsoniter._
 import com.github.plokhotnyuk.jsoniter_scala.core._
 import com.github.plokhotnyuk.jsoniter_scala.macros._
 
-val backend: SyncBackend = DefaultSyncBackend()
+val backend: WebSocketBackend[Identity] = DefaultSyncBackend()
 
 implicit val payloadJsonCodec: JsonValueCodec[RequestPayload] = JsonCodecMaker.make
 //note that the jsoniter doesn't support 'implicit defs' and so either has to be generated seperatly
@@ -240,7 +240,7 @@ import sttp.client4._
 import sttp.client4.upicklejson._
 import upickle.default._
 
-val backend: SyncBackend = DefaultSyncBackend()
+val backend: WebSocketBackend[Identity] = DefaultSyncBackend()
 
 implicit val requestPayloadRW: ReadWriter[RequestPayload] = macroRW[RequestPayload]
 implicit val responsePayloadRW: ReadWriter[ResponsePayload] = macroRW[ResponsePayload]

diff --git a/docs/requests/authentication.md b/docs/requests/authentication.md
@@ -32,7 +32,7 @@ In order to add digest authentication support just wrap other backend as follows
 ```scala mdoc:compile-only
 import sttp.client4.wrappers.DigestAuthenticationBackend
 
-val myBackend: SyncBackend = DefaultSyncBackend()
+val myBackend: WebSocketBackend[Identity] = DefaultSyncBackend()
 DigestAuthenticationBackend(myBackend)
 ```
 

diff --git a/docs/testing.md b/docs/testing.md
@@ -230,7 +230,7 @@ It is also possible to create a stub backend which delegates calls to another (p
 
 ```scala mdoc:compile-only
 val testingBackend =
- SyncBackendStub.withFallback(DefaultSyncBackend())
+ WebSocketBackendStub.withFallback(DefaultSyncBackend())
  .whenRequestMatches(_.uri.path.startsWith(List("a")))
  .thenRespond("I'm a STUB!")