Docs

softwaremill · Jan 8, 2025 · b7750b4 · b7750b4
1 parent bf01203
commit b7750b4
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -118,10 +118,11 @@ Type `basicRequest.` and see where your IDE’s auto-complete gets you!
 sttp is a family of Scala HTTP-related projects, and currently includes:
 
 * sttp client: this project
-* [sttp tapir](https://github.com/softwaremill/tapir): Typed API descRiptions
+* [sttp tapir](https://github.com/softwaremill/tapir): rapid development of self-documenting APIs
 * [sttp model](https://github.com/softwaremill/sttp-model): simple HTTP model classes (used by client & tapir)
 * [sttp shared](https://github.com/softwaremill/sttp-shared): shared web socket, FP abstractions, capabilities and streaming code.
 * [sttp apispec](https://github.com/softwaremill/sttp-apispec): OpenAPI, AsyncAPI and JSON Schema models.
+* [sttp openai](https://github.com/softwaremill/sttp-openai): Scala client wrapper for OpenAI and OpenAI-compatible APIs. Use the power of ChatGPT inside your code!
 
 ## Contributing
 

diff --git a/docs/backends/summary.md b/docs/backends/summary.md
@@ -14,7 +14,7 @@ As a starting point, the default backends are good choice. Depending on the plat
 
 These default backends provide limited customisation options, hence for any more advanced use-cases, simply substitute them with a specific implementation. E.g. the `HttpClientSyncBackend` backend, which is the underlying implementation of `DefaultSyncBackend`, offers customisation options not available in the default one.
 
-## Backends overview
+## JVM backends
 
 Which one to choose?
 
@@ -61,6 +61,8 @@ Backends supporting cats-effect are available in versions for cats-effect 2.x (d
 
 All backends that support asynchronous/non-blocking streams, also support server-sent events.
 
+## Backend wrappers
+
 There are also backends which wrap other backends to provide additional functionality. These include:
 
 * `TryBackend`, which safely wraps any exceptions thrown by a synchronous backend in `scala.util.Try`
@@ -72,6 +74,9 @@ There are also backends which wrap other backends to provide additional function
 * `ResolveRelativeUrisBackend` to resolve relative URIs given a base URI, or an arbitrary effectful function
 * `ListenerBackend` to listen for backend lifecycle events. See the [dedicated section](wrappers/custom.md).
 * `FollowRedirectsBackend`, which handles redirects. All implementation backends are created wrapped with this one.
+* `CachingBackend`, which caches responses. See the [dedicated section](wrappers/caching.md).
+
+## Scala.JS backends
 
 In addition, there are also backends for Scala.JS:
 
@@ -87,6 +92,8 @@ Class                            Effect type                      Supported stre
 ================================ ================================ ========================================= ===================
 ```
 
+## Scala Native backends
+
 And a backend for scala-native:
 
 ```{eval-rst}

diff --git a/docs/index.md b/docs/index.md
@@ -64,7 +64,7 @@ sttp client is licensed under Apache2, the source code is [available on GitHub](
 sttp is a family of Scala HTTP-related projects, and currently includes:
 
 * sttp client: this project
-* [sttp tapir](https://github.com/softwaremill/tapir): Typed API descRiptions
+* [sttp tapir](https://github.com/softwaremill/tapir): rapid development of self-documenting APIs
 * [sttp model](https://github.com/softwaremill/sttp-model): simple HTTP model classes (used by client & tapir)
 * [sttp shared](https://github.com/softwaremill/sttp-shared): shared web socket, FP abstractions, capabilities and streaming code.
 * [sttp apispec](https://github.com/softwaremill/sttp-apispec): OpenAPI, AsyncAPI and JSON Schema models.