fix(specs): add ACL to missing endpoints (generated)

algolia/api-clients-automation#5529

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>

Author: algolia-bot

lib/algolia/api/ingestion_client.rb

@@ -220,7 +220,11 @@ def create_source(source_create, request_options = {})
     end
 
     # Creates a new task.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_create [TaskCreate] Request body for creating a task. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -250,7 +254,11 @@ def create_task_with_http_info(task_create, request_options = {})
     end
 
     # Creates a new task.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_create [TaskCreate] Request body for creating a task. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [TaskCreateResponse]
@@ -260,7 +268,11 @@ def create_task(task_create, request_options = {})
     end
 
     # Creates a new task using the v1 endpoint, please use `createTask` instead.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # THIS OPERATION IS DEPRECATED
     # @param task_create [TaskCreateV1] Request body for creating a task. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -291,7 +303,11 @@ def create_task_v1_with_http_info(task_create, request_options = {})
     end
 
     # Creates a new task using the v1 endpoint, please use `createTask` instead.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_create [TaskCreateV1] Request body for creating a task. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [TaskCreateResponse]
@@ -301,7 +317,11 @@ def create_task_v1(task_create, request_options = {})
     end
 
     # Creates a new transformation.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param transformation_create [TransformationCreate] Request body for creating a transformation. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -331,7 +351,11 @@ def create_transformation_with_http_info(transformation_create, request_options
     end
 
     # Creates a new transformation.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param transformation_create [TransformationCreate] Request body for creating a transformation. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [TransformationCreateResponse]
@@ -670,7 +694,11 @@ def delete_source(source_id, request_options = {})
     end
 
     # Deletes a task by its ID.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -700,7 +728,11 @@ def delete_task_with_http_info(task_id, request_options = {})
     end
 
     # Deletes a task by its ID.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [DeleteResponse]
@@ -710,7 +742,11 @@ def delete_task(task_id, request_options = {})
     end
 
     # Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # THIS OPERATION IS DEPRECATED
     # @param task_id [String] Unique identifier of a task. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -741,7 +777,11 @@ def delete_task_v1_with_http_info(task_id, request_options = {})
     end
 
     # Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [DeleteResponse]
@@ -751,7 +791,11 @@ def delete_task_v1(task_id, request_options = {})
     end
 
     # Deletes a transformation by its ID.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param transformation_id [String] Unique identifier of a transformation. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -784,7 +828,11 @@ def delete_transformation_with_http_info(transformation_id, request_options = {}
     end
 
     # Deletes a transformation by its ID.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param transformation_id [String] Unique identifier of a transformation. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [DeleteResponse]
@@ -2277,7 +2325,11 @@ def push_task(task_id, push_task_payload, watch = nil, request_options = {})
     end
 
     # Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
     # @param task_replace [TaskReplace]  (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -2312,7 +2364,11 @@ def replace_task_with_http_info(task_id, task_replace, request_options = {})
     end
 
     # Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
     # @param task_replace [TaskReplace]  (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -3104,7 +3160,11 @@ def update_source(source_id, source_update, request_options = {})
     end
 
     # Partially updates a task by its ID.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
     # @param task_update [TaskUpdate]  (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -3139,7 +3199,11 @@ def update_task_with_http_info(task_id, task_update, request_options = {})
     end
 
     # Partially updates a task by its ID.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
     # @param task_update [TaskUpdate]  (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -3150,7 +3214,11 @@ def update_task(task_id, task_update, request_options = {})
     end
 
     # Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # THIS OPERATION IS DEPRECATED
     # @param task_id [String] Unique identifier of a task. (required)
     # @param task_update [TaskUpdateV1]  (required)
@@ -3186,7 +3254,11 @@ def update_task_v1_with_http_info(task_id, task_update, request_options = {})
     end
 
     # Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
     # @param task_update [TaskUpdateV1]  (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -3197,7 +3269,11 @@ def update_task_v1(task_id, task_update, request_options = {})
     end
 
     # Updates a transformation by its ID.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param transformation_id [String] Unique identifier of a transformation. (required)
     # @param transformation_create [TransformationCreate]  (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -3235,7 +3311,11 @@ def update_transformation_with_http_info(transformation_id, transformation_creat
     end
 
     # Updates a transformation by its ID.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param transformation_id [String] Unique identifier of a transformation. (required)
     # @param transformation_create [TransformationCreate]  (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

lib/algolia/api/search_client.rb

@@ -268,7 +268,9 @@ def assign_user_id(x_algolia_user_id, assign_user_id_params, request_options = {
     end
 
     # Adds, updates, or deletes records in one index with a single API request.  Batching index updates reduces latency and increases data integrity.  - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name.  This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
     # @param index_name [String] Name of the index on which to perform the operation. (required)
     # @param batch_write_params [BatchWriteParams]  (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -303,7 +305,9 @@ def batch_with_http_info(index_name, batch_write_params, request_options = {})
     end
 
     # Adds, updates, or deletes records in one index with a single API request.  Batching index updates reduces latency and increases data integrity.  - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name.  This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
     # @param index_name [String] Name of the index on which to perform the operation. (required)
     # @param batch_write_params [BatchWriteParams]  (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -1134,7 +1138,9 @@ def delete_synonym(index_name, algolia_object_id, forward_to_replicas = nil, req
     end
 
     # Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
-
+    #
+    # Required API Key ACLs:
+    #   - search
     # @param key [String] API key. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -1164,7 +1170,9 @@ def get_api_key_with_http_info(key, request_options = {})
     end
 
     # Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
-
+    #
+    # Required API Key ACLs:
+    #   - search
     # @param key [String] API key. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [GetApiKeyResponse]
@@ -1976,7 +1984,9 @@ def list_user_ids(page = nil, hits_per_page = nil, request_options = {})
     end
 
     # Adds, updates, or deletes records in multiple indices with a single API request.  - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name.  This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
     # @param batch_params [BatchParams]  (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -2006,7 +2016,9 @@ def multiple_batch_with_http_info(batch_params, request_options = {})
     end
 
     # Adds, updates, or deletes records in multiple indices with a single API request.  - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name.  This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
     # @param batch_params [BatchParams]  (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [MultipleBatchResponse]