Skip to content

Commit

Permalink
fix(specs): note on Analytics API server (generated)
Browse files Browse the repository at this point in the history
algolia/api-clients-automation#3650

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
  • Loading branch information
3 people committed Sep 4, 2024
1 parent 509f56d commit b2adf71
Show file tree
Hide file tree
Showing 79 changed files with 260 additions and 181 deletions.
7 changes: 4 additions & 3 deletions src/main/scala/algoliasearch/abtesting/ABTest.scala
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
* experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
* (alias: `https://analytics.algolia.com`) - `https://analytics.de.algolia.com` Use the URL that matches your
* [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.**
* ## Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
* servers, based on your geographical location) Use the URL that matches your [analytics
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
* Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
* `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
* permissions to make the request. The required access control list (ACL) to make a request is listed in each
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
* experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
* (alias: `https://analytics.algolia.com`) - `https://analytics.de.algolia.com` Use the URL that matches your
* [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.**
* ## Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
* servers, based on your geographical location) Use the URL that matches your [analytics
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
* Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
* `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
* permissions to make the request. The required access control list (ACL) to make a request is listed in each
Expand Down
7 changes: 4 additions & 3 deletions src/main/scala/algoliasearch/abtesting/ABTestResponse.scala
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
* experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
* (alias: `https://analytics.algolia.com`) - `https://analytics.de.algolia.com` Use the URL that matches your
* [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.**
* ## Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
* servers, based on your geographical location) Use the URL that matches your [analytics
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
* Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
* `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
* permissions to make the request. The required access control list (ACL) to make a request is listed in each
Expand Down
7 changes: 4 additions & 3 deletions src/main/scala/algoliasearch/abtesting/AbTestsVariant.scala
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
* experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
* (alias: `https://analytics.algolia.com`) - `https://analytics.de.algolia.com` Use the URL that matches your
* [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.**
* ## Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
* servers, based on your geographical location) Use the URL that matches your [analytics
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
* Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
* `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
* permissions to make the request. The required access control list (ACL) to make a request is listed in each
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
* experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
* (alias: `https://analytics.algolia.com`) - `https://analytics.de.algolia.com` Use the URL that matches your
* [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.**
* ## Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
* servers, based on your geographical location) Use the URL that matches your [analytics
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
* Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
* `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
* permissions to make the request. The required access control list (ACL) to make a request is listed in each
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
* experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
* (alias: `https://analytics.algolia.com`) - `https://analytics.de.algolia.com` Use the URL that matches your
* [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.**
* ## Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
* servers, based on your geographical location) Use the URL that matches your [analytics
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
* Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
* `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
* permissions to make the request. The required access control list (ACL) to make a request is listed in each
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
* experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
* (alias: `https://analytics.algolia.com`) - `https://analytics.de.algolia.com` Use the URL that matches your
* [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.**
* ## Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
* servers, based on your geographical location) Use the URL that matches your [analytics
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
* Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
* `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
* permissions to make the request. The required access control list (ACL) to make a request is listed in each
Expand Down
7 changes: 4 additions & 3 deletions src/main/scala/algoliasearch/abtesting/Currency.scala
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
* experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
* (alias: `https://analytics.algolia.com`) - `https://analytics.de.algolia.com` Use the URL that matches your
* [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.**
* ## Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
* servers, based on your geographical location) Use the URL that matches your [analytics
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
* Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
* `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
* permissions to make the request. The required access control list (ACL) to make a request is listed in each
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
* experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
* (alias: `https://analytics.algolia.com`) - `https://analytics.de.algolia.com` Use the URL that matches your
* [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.**
* ## Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
* servers, based on your geographical location) Use the URL that matches your [analytics
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
* Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
* `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
* permissions to make the request. The required access control list (ACL) to make a request is listed in each
Expand Down
7 changes: 4 additions & 3 deletions src/main/scala/algoliasearch/abtesting/Effect.scala
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
* experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
* (alias: `https://analytics.algolia.com`) - `https://analytics.de.algolia.com` Use the URL that matches your
* [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.**
* ## Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
* servers, based on your geographical location) Use the URL that matches your [analytics
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
* Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
* `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
* permissions to make the request. The required access control list (ACL) to make a request is listed in each
Expand Down
7 changes: 4 additions & 3 deletions src/main/scala/algoliasearch/abtesting/EmptySearch.scala
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
* experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
* (alias: `https://analytics.algolia.com`) - `https://analytics.de.algolia.com` Use the URL that matches your
* [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.**
* ## Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
* servers, based on your geographical location) Use the URL that matches your [analytics
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
* Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
* `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
* permissions to make the request. The required access control list (ACL) to make a request is listed in each
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
* experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
* (alias: `https://analytics.algolia.com`) - `https://analytics.de.algolia.com` Use the URL that matches your
* [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.**
* ## Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
* servers, based on your geographical location) Use the URL that matches your [analytics
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
* Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
* `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
* permissions to make the request. The required access control list (ACL) to make a request is listed in each
Expand Down
7 changes: 4 additions & 3 deletions src/main/scala/algoliasearch/abtesting/ErrorBase.scala
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
* experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
* (alias: `https://analytics.algolia.com`) - `https://analytics.de.algolia.com` Use the URL that matches your
* [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.**
* ## Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
* servers, based on your geographical location) Use the URL that matches your [analytics
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
* Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
* `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
* permissions to make the request. The required access control list (ACL) to make a request is listed in each
Expand Down
7 changes: 4 additions & 3 deletions src/main/scala/algoliasearch/abtesting/FilterEffects.scala
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
* experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
* (alias: `https://analytics.algolia.com`) - `https://analytics.de.algolia.com` Use the URL that matches your
* [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.**
* ## Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
* servers, based on your geographical location) Use the URL that matches your [analytics
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
* Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
* plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
* `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
* permissions to make the request. The required access control list (ACL) to make a request is listed in each
Expand Down
Loading

0 comments on commit b2adf71

Please sign in to comment.