feat: add rate limit headers description (generated)

Co-authored-by: Thomas Paulmyer <[email protected]>

Author: algolia-bot

clients/algoliasearch-client-csharp/algoliasearch/Clients/PersonalizationConfiguration.cs

@@ -1,7 +1,7 @@
 /*
 * Personalization API
 *
-* The Personalization API lets you access user profiles built from the personalization strategy.  ## Base URLs  The base URLs for requests to the Personalization API are:  - `https://personalization.us.algolia.com` - `https://personalization.eu.algolia.com`  Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics).  **All requests must use HTTPS.**  ## Authentication  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 endpoint's reference.  You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).  ## Request format  Request bodies must be JSON objects.  ## Response status and errors  The Personalization API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.  Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information.  ## Version  The current version of the Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL. 
+* The Personalization API lets you access user profiles built from the personalization strategy.  ## Base URLs  The base URLs for requests to the Personalization API are:  - `https://personalization.us.algolia.com` - `https://personalization.eu.algolia.com`  Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics).  **All requests must use HTTPS.**  ## Authentication  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 endpoint's reference.  You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).  ## Request format  Request bodies must be JSON objects.  ## Response status and errors  The Personalization API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.  Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information.  ## Rate limiting  When making requests to the Personalization API, you are limited to 40 API calls per second per application.  The following headers provide information about your current limit:  - `x-ratelimit-limit`: The number of requests allowed every second. - `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix timestamp](https://www.unixtimestamp.com/) of the next time period.  ## Version  The current version of the Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL. 
 *
 * The version of the OpenAPI document: 1.0.0
 * Generated by: https://github.com/openapitools/openapi-generator.git

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/DeleteUserProfileResponse.scala

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

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/ErrorBase.scala

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

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/EventType.scala

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

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/EventsScoring.scala

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

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/FacetsScoring.scala

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

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/GetUserTokenResponse.scala

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

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/JsonSupport.scala

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

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/PersonalizationStrategyParams.scala

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

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/SetPersonalizationStrategyResponse.scala

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

docs/bundled/personalization.yml

@@ -61,6 +61,27 @@ info:
     Error responses have a `message` property with more information.
 
 
+    ## Rate limiting
+
+
+    When making requests to the Personalization API, you are limited to 40 API
+    calls per second per application.
+
+
+    The following headers provide information about your current limit:
+
+
+    - `x-ratelimit-limit`: The number of requests allowed every second.
+
+    - `x-ratelimit-remaining`: The number of requests remaining in the current
+
+    second period.
+
+    - `x-ratelimit-reset`: [Unix timestamp](https://www.unixtimestamp.com/) of
+
+    the next time period.
+
+
     ## Version
 
 
@@ -1017,6 +1038,13 @@ paths:
       responses:
         '200':
           description: OK
+          headers:
+            x-ratelimit-limit:
+              $ref: '#/components/headers/x-ratelimit-limit'
+            x-ratelimit-remaining:
+              $ref: '#/components/headers/x-ratelimit-remaining'
+            x-ratelimit-reset:
+              $ref: '#/components/headers/x-ratelimit-reset'
           content:
             application/json:
               schema:
@@ -1283,6 +1311,13 @@ paths:
       responses:
         '200':
           description: OK
+          headers:
+            x-ratelimit-limit:
+              $ref: '#/components/headers/x-ratelimit-limit'
+            x-ratelimit-remaining:
+              $ref: '#/components/headers/x-ratelimit-remaining'
+            x-ratelimit-reset:
+              $ref: '#/components/headers/x-ratelimit-reset'
           content:
             application/json:
               schema:
@@ -1534,6 +1569,13 @@ paths:
       responses:
         '200':
           description: OK
+          headers:
+            x-ratelimit-limit:
+              $ref: '#/components/headers/x-ratelimit-limit'
+            x-ratelimit-remaining:
+              $ref: '#/components/headers/x-ratelimit-remaining'
+            x-ratelimit-reset:
+              $ref: '#/components/headers/x-ratelimit-reset'
           content:
             application/json:
               schema:
@@ -2263,6 +2305,24 @@ components:
         application/json:
           schema:
             $ref: '#/components/schemas/ErrorBase'
+  headers:
+    x-ratelimit-limit:
+      description: Number of allowed requests per one minute.
+      example: 100
+      schema:
+        type: integer
+    x-ratelimit-remaining:
+      description: Number of remaining requests in the current period.
+      example: 99
+      schema:
+        type: integer
+    x-ratelimit-reset:
+      description: >-
+        Timstamp when the rate limit will reset, measured in seconds since the
+        Unix epoch.
+      example: 1710682486
+      schema:
+        type: integer
 x-tagGroups:
   - name: General
     tags: