Skip to content

Commit 0f66f93

Browse files
algolia-botKeylor42
andcommitted
docs(personalization): add rate limit information for personalization API (generated)
algolia/api-clients-automation#4725 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Keylor42 <[email protected]>
1 parent 02a5f3c commit 0f66f93

9 files changed

+54
-18
lines changed

src/main/scala/algoliasearch/personalization/DeleteUserProfileResponse.scala

+6-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

src/main/scala/algoliasearch/personalization/ErrorBase.scala

+6-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

src/main/scala/algoliasearch/personalization/EventType.scala

+6-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

src/main/scala/algoliasearch/personalization/EventsScoring.scala

+6-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

src/main/scala/algoliasearch/personalization/FacetsScoring.scala

+6-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

src/main/scala/algoliasearch/personalization/GetUserTokenResponse.scala

+6-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

src/main/scala/algoliasearch/personalization/JsonSupport.scala

+6-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

src/main/scala/algoliasearch/personalization/PersonalizationStrategyParams.scala

+6-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

src/main/scala/algoliasearch/personalization/SetPersonalizationStrategyResponse.scala

+6-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

0 commit comments

Comments
 (0)