chore: more composition API update for docs (generated)

algolia/api-clients-automation#4453 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Emmanuel Krebs <e-krebs@users.noreply.github.com>
algolia · Feb 11, 2025 · 3aac035 · 3aac035
1 parent d218f42
commit 3aac035
Show file tree

Hide file tree

Showing 60 changed files with 300 additions and 300 deletions.
diff --git a/src/main/scala/algoliasearch/composition/AroundPrecision.scala b/src/main/scala/algoliasearch/composition/AroundPrecision.scala
@@ -1,8 +1,8 @@
-/** Composition API (beta) The Algolia Composition API lets you run search requests on your Compositions. ## Client
-  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official
-  * API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). See:
-  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
-  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+/** Composition API (beta) The Algolia Composition API lets you run composed search requests on your Compositions. The
+  * Composition API is in Beta. ## Client libraries Use Algolia's API clients and libraries to reliably integrate
+  * Algolia's APIs with your apps. See: [Algolia's
+  * ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
+  * The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
   * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
   * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
   * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##

diff --git a/src/main/scala/algoliasearch/composition/AroundRadius.scala b/src/main/scala/algoliasearch/composition/AroundRadius.scala
@@ -1,8 +1,8 @@
-/** Composition API (beta) The Algolia Composition API lets you run search requests on your Compositions. ## Client
-  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official
-  * API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). See:
-  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
-  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+/** Composition API (beta) The Algolia Composition API lets you run composed search requests on your Compositions. The
+  * Composition API is in Beta. ## Client libraries Use Algolia's API clients and libraries to reliably integrate
+  * Algolia's APIs with your apps. See: [Algolia's
+  * ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
+  * The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
   * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
   * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
   * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##

diff --git a/src/main/scala/algoliasearch/composition/AroundRadiusAll.scala b/src/main/scala/algoliasearch/composition/AroundRadiusAll.scala
@@ -1,8 +1,8 @@
-/** Composition API (beta) The Algolia Composition API lets you run search requests on your Compositions. ## Client
-  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official
-  * API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). See:
-  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
-  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+/** Composition API (beta) The Algolia Composition API lets you run composed search requests on your Compositions. The
+  * Composition API is in Beta. ## Client libraries Use Algolia's API clients and libraries to reliably integrate
+  * Algolia's APIs with your apps. See: [Algolia's
+  * ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
+  * The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
   * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
   * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
   * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##

diff --git a/src/main/scala/algoliasearch/composition/Banner.scala b/src/main/scala/algoliasearch/composition/Banner.scala
@@ -1,8 +1,8 @@
-/** Composition API (beta) The Algolia Composition API lets you run search requests on your Compositions. ## Client
-  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official
-  * API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). See:
-  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
-  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+/** Composition API (beta) The Algolia Composition API lets you run composed search requests on your Compositions. The
+  * Composition API is in Beta. ## Client libraries Use Algolia's API clients and libraries to reliably integrate
+  * Algolia's APIs with your apps. See: [Algolia's
+  * ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
+  * The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
   * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
   * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
   * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##

diff --git a/src/main/scala/algoliasearch/composition/BannerImage.scala b/src/main/scala/algoliasearch/composition/BannerImage.scala
@@ -1,8 +1,8 @@
-/** Composition API (beta) The Algolia Composition API lets you run search requests on your Compositions. ## Client
-  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official
-  * API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). See:
-  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
-  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+/** Composition API (beta) The Algolia Composition API lets you run composed search requests on your Compositions. The
+  * Composition API is in Beta. ## Client libraries Use Algolia's API clients and libraries to reliably integrate
+  * Algolia's APIs with your apps. See: [Algolia's
+  * ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
+  * The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
   * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
   * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
   * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##

diff --git a/src/main/scala/algoliasearch/composition/BannerImageUrl.scala b/src/main/scala/algoliasearch/composition/BannerImageUrl.scala
@@ -1,8 +1,8 @@
-/** Composition API (beta) The Algolia Composition API lets you run search requests on your Compositions. ## Client
-  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official
-  * API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). See:
-  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
-  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+/** Composition API (beta) The Algolia Composition API lets you run composed search requests on your Compositions. The
+  * Composition API is in Beta. ## Client libraries Use Algolia's API clients and libraries to reliably integrate
+  * Algolia's APIs with your apps. See: [Algolia's
+  * ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
+  * The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
   * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
   * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
   * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##

diff --git a/src/main/scala/algoliasearch/composition/BannerLink.scala b/src/main/scala/algoliasearch/composition/BannerLink.scala
@@ -1,8 +1,8 @@
-/** Composition API (beta) The Algolia Composition API lets you run search requests on your Compositions. ## Client
-  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official
-  * API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). See:
-  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
-  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+/** Composition API (beta) The Algolia Composition API lets you run composed search requests on your Compositions. The
+  * Composition API is in Beta. ## Client libraries Use Algolia's API clients and libraries to reliably integrate
+  * Algolia's APIs with your apps. See: [Algolia's
+  * ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
+  * The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
   * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
   * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
   * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##

diff --git a/src/main/scala/algoliasearch/composition/BaseSearchResponse.scala b/src/main/scala/algoliasearch/composition/BaseSearchResponse.scala
@@ -1,8 +1,8 @@
-/** Composition API (beta) The Algolia Composition API lets you run search requests on your Compositions. ## Client
-  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official
-  * API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). See:
-  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
-  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+/** Composition API (beta) The Algolia Composition API lets you run composed search requests on your Compositions. The
+  * Composition API is in Beta. ## Client libraries Use Algolia's API clients and libraries to reliably integrate
+  * Algolia's APIs with your apps. See: [Algolia's
+  * ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
+  * The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
   * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
   * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
   * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##

diff --git a/src/main/scala/algoliasearch/composition/CompositionBaseSearchResponse.scala b/src/main/scala/algoliasearch/composition/CompositionBaseSearchResponse.scala
@@ -1,8 +1,8 @@
-/** Composition API (beta) The Algolia Composition API lets you run search requests on your Compositions. ## Client
-  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official
-  * API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). See:
-  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
-  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+/** Composition API (beta) The Algolia Composition API lets you run composed search requests on your Compositions. The
+  * Composition API is in Beta. ## Client libraries Use Algolia's API clients and libraries to reliably integrate
+  * Algolia's APIs with your apps. See: [Algolia's
+  * ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
+  * The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
   * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
   * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
   * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##

diff --git a/src/main/scala/algoliasearch/composition/CompositionIdRankingInfo.scala b/src/main/scala/algoliasearch/composition/CompositionIdRankingInfo.scala
@@ -1,8 +1,8 @@
-/** Composition API (beta) The Algolia Composition API lets you run search requests on your Compositions. ## Client
-  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official
-  * API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). See:
-  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
-  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+/** Composition API (beta) The Algolia Composition API lets you run composed search requests on your Compositions. The
+  * Composition API is in Beta. ## Client libraries Use Algolia's API clients and libraries to reliably integrate
+  * Algolia's APIs with your apps. See: [Algolia's
+  * ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
+  * The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
   * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
   * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
   * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##

diff --git a/src/main/scala/algoliasearch/composition/CompositionRankingInfo.scala b/src/main/scala/algoliasearch/composition/CompositionRankingInfo.scala
@@ -1,8 +1,8 @@
-/** Composition API (beta) The Algolia Composition API lets you run search requests on your Compositions. ## Client
-  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official
-  * API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). See:
-  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
-  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+/** Composition API (beta) The Algolia Composition API lets you run composed search requests on your Compositions. The
+  * Composition API is in Beta. ## Client libraries Use Algolia's API clients and libraries to reliably integrate
+  * Algolia's APIs with your apps. See: [Algolia's
+  * ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
+  * The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
   * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
   * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
   * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##

diff --git a/src/main/scala/algoliasearch/composition/CompositionRunAppliedRules.scala b/src/main/scala/algoliasearch/composition/CompositionRunAppliedRules.scala
@@ -1,8 +1,8 @@
-/** Composition API (beta) The Algolia Composition API lets you run search requests on your Compositions. ## Client
-  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official
-  * API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). See:
-  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
-  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+/** Composition API (beta) The Algolia Composition API lets you run composed search requests on your Compositions. The
+  * Composition API is in Beta. ## Client libraries Use Algolia's API clients and libraries to reliably integrate
+  * Algolia's APIs with your apps. See: [Algolia's
+  * ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
+  * The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
   * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
   * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
   * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##

diff --git a/src/main/scala/algoliasearch/composition/CompositionRunSearchResponse.scala b/src/main/scala/algoliasearch/composition/CompositionRunSearchResponse.scala
@@ -1,8 +1,8 @@
-/** Composition API (beta) The Algolia Composition API lets you run search requests on your Compositions. ## Client
-  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official
-  * API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). See:
-  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
-  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+/** Composition API (beta) The Algolia Composition API lets you run composed search requests on your Compositions. The
+  * Composition API is in Beta. ## Client libraries Use Algolia's API clients and libraries to reliably integrate
+  * Algolia's APIs with your apps. See: [Algolia's
+  * ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
+  * The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
   * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
   * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
   * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##

diff --git a/src/main/scala/algoliasearch/composition/CompositionsSearchResponse.scala b/src/main/scala/algoliasearch/composition/CompositionsSearchResponse.scala
@@ -1,8 +1,8 @@
-/** Composition API (beta) The Algolia Composition API lets you run search requests on your Compositions. ## Client
-  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official
-  * API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/). See:
-  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
-  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+/** Composition API (beta) The Algolia Composition API lets you run composed search requests on your Compositions. The
+  * Composition API is in Beta. ## Client libraries Use Algolia's API clients and libraries to reliably integrate
+  * Algolia's APIs with your apps. See: [Algolia's
+  * ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
+  * The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
   * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
   * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
   * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##