Skip to content

Commit 3aefb91

Browse files
algolia-botmillotp
algolia-bot
and
millotp
committed
fix(specs): add ACL to missing endpoints (generated)
algolia/api-clients-automation#5529 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
1 parent b629cdb commit 3aefb91

File tree

2 files changed

+118
-26
lines changed

2 files changed

+118
-26
lines changed

‎lib/algolia/api/ingestion_client.rb‎

Lines changed: 100 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,11 @@ def create_source(source_create, request_options = {})
220220
end
221221

222222
# Creates a new task.
223-
223+
#
224+
# Required API Key ACLs:
225+
# - addObject
226+
# - deleteIndex
227+
# - editSettings
224228
# @param task_create [TaskCreate] Request body for creating a task. (required)
225229
# @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)
226230
# @return [Http::Response] the response
@@ -250,7 +254,11 @@ def create_task_with_http_info(task_create, request_options = {})
250254
end
251255

252256
# Creates a new task.
253-
257+
#
258+
# Required API Key ACLs:
259+
# - addObject
260+
# - deleteIndex
261+
# - editSettings
254262
# @param task_create [TaskCreate] Request body for creating a task. (required)
255263
# @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)
256264
# @return [TaskCreateResponse]
@@ -260,7 +268,11 @@ def create_task(task_create, request_options = {})
260268
end
261269

262270
# Creates a new task using the v1 endpoint, please use `createTask` instead.
263-
271+
#
272+
# Required API Key ACLs:
273+
# - addObject
274+
# - deleteIndex
275+
# - editSettings
264276
# THIS OPERATION IS DEPRECATED
265277
# @param task_create [TaskCreateV1] Request body for creating a task. (required)
266278
# @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 = {})
291303
end
292304

293305
# Creates a new task using the v1 endpoint, please use `createTask` instead.
294-
306+
#
307+
# Required API Key ACLs:
308+
# - addObject
309+
# - deleteIndex
310+
# - editSettings
295311
# @param task_create [TaskCreateV1] Request body for creating a task. (required)
296312
# @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)
297313
# @return [TaskCreateResponse]
@@ -301,7 +317,11 @@ def create_task_v1(task_create, request_options = {})
301317
end
302318

303319
# Creates a new transformation.
304-
320+
#
321+
# Required API Key ACLs:
322+
# - addObject
323+
# - deleteIndex
324+
# - editSettings
305325
# @param transformation_create [TransformationCreate] Request body for creating a transformation. (required)
306326
# @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)
307327
# @return [Http::Response] the response
@@ -331,7 +351,11 @@ def create_transformation_with_http_info(transformation_create, request_options
331351
end
332352

333353
# Creates a new transformation.
334-
354+
#
355+
# Required API Key ACLs:
356+
# - addObject
357+
# - deleteIndex
358+
# - editSettings
335359
# @param transformation_create [TransformationCreate] Request body for creating a transformation. (required)
336360
# @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)
337361
# @return [TransformationCreateResponse]
@@ -670,7 +694,11 @@ def delete_source(source_id, request_options = {})
670694
end
671695

672696
# Deletes a task by its ID.
673-
697+
#
698+
# Required API Key ACLs:
699+
# - addObject
700+
# - deleteIndex
701+
# - editSettings
674702
# @param task_id [String] Unique identifier of a task. (required)
675703
# @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)
676704
# @return [Http::Response] the response
@@ -700,7 +728,11 @@ def delete_task_with_http_info(task_id, request_options = {})
700728
end
701729

702730
# Deletes a task by its ID.
703-
731+
#
732+
# Required API Key ACLs:
733+
# - addObject
734+
# - deleteIndex
735+
# - editSettings
704736
# @param task_id [String] Unique identifier of a task. (required)
705737
# @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)
706738
# @return [DeleteResponse]
@@ -710,7 +742,11 @@ def delete_task(task_id, request_options = {})
710742
end
711743

712744
# Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
713-
745+
#
746+
# Required API Key ACLs:
747+
# - addObject
748+
# - deleteIndex
749+
# - editSettings
714750
# THIS OPERATION IS DEPRECATED
715751
# @param task_id [String] Unique identifier of a task. (required)
716752
# @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 = {})
741777
end
742778

743779
# Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
744-
780+
#
781+
# Required API Key ACLs:
782+
# - addObject
783+
# - deleteIndex
784+
# - editSettings
745785
# @param task_id [String] Unique identifier of a task. (required)
746786
# @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)
747787
# @return [DeleteResponse]
@@ -751,7 +791,11 @@ def delete_task_v1(task_id, request_options = {})
751791
end
752792

753793
# Deletes a transformation by its ID.
754-
794+
#
795+
# Required API Key ACLs:
796+
# - addObject
797+
# - deleteIndex
798+
# - editSettings
755799
# @param transformation_id [String] Unique identifier of a transformation. (required)
756800
# @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)
757801
# @return [Http::Response] the response
@@ -784,7 +828,11 @@ def delete_transformation_with_http_info(transformation_id, request_options = {}
784828
end
785829

786830
# Deletes a transformation by its ID.
787-
831+
#
832+
# Required API Key ACLs:
833+
# - addObject
834+
# - deleteIndex
835+
# - editSettings
788836
# @param transformation_id [String] Unique identifier of a transformation. (required)
789837
# @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)
790838
# @return [DeleteResponse]
@@ -2277,7 +2325,11 @@ def push_task(task_id, push_task_payload, watch = nil, request_options = {})
22772325
end
22782326

22792327
# Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
2280-
2328+
#
2329+
# Required API Key ACLs:
2330+
# - addObject
2331+
# - deleteIndex
2332+
# - editSettings
22812333
# @param task_id [String] Unique identifier of a task. (required)
22822334
# @param task_replace [TaskReplace] (required)
22832335
# @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 = {})
23122364
end
23132365

23142366
# Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
2315-
2367+
#
2368+
# Required API Key ACLs:
2369+
# - addObject
2370+
# - deleteIndex
2371+
# - editSettings
23162372
# @param task_id [String] Unique identifier of a task. (required)
23172373
# @param task_replace [TaskReplace] (required)
23182374
# @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 = {})
31043160
end
31053161

31063162
# Partially updates a task by its ID.
3107-
3163+
#
3164+
# Required API Key ACLs:
3165+
# - addObject
3166+
# - deleteIndex
3167+
# - editSettings
31083168
# @param task_id [String] Unique identifier of a task. (required)
31093169
# @param task_update [TaskUpdate] (required)
31103170
# @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 = {})
31393199
end
31403200

31413201
# Partially updates a task by its ID.
3142-
3202+
#
3203+
# Required API Key ACLs:
3204+
# - addObject
3205+
# - deleteIndex
3206+
# - editSettings
31433207
# @param task_id [String] Unique identifier of a task. (required)
31443208
# @param task_update [TaskUpdate] (required)
31453209
# @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 = {})
31503214
end
31513215

31523216
# Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
3153-
3217+
#
3218+
# Required API Key ACLs:
3219+
# - addObject
3220+
# - deleteIndex
3221+
# - editSettings
31543222
# THIS OPERATION IS DEPRECATED
31553223
# @param task_id [String] Unique identifier of a task. (required)
31563224
# @param task_update [TaskUpdateV1] (required)
@@ -3186,7 +3254,11 @@ def update_task_v1_with_http_info(task_id, task_update, request_options = {})
31863254
end
31873255

31883256
# Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
3189-
3257+
#
3258+
# Required API Key ACLs:
3259+
# - addObject
3260+
# - deleteIndex
3261+
# - editSettings
31903262
# @param task_id [String] Unique identifier of a task. (required)
31913263
# @param task_update [TaskUpdateV1] (required)
31923264
# @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 = {})
31973269
end
31983270

31993271
# Updates a transformation by its ID.
3200-
3272+
#
3273+
# Required API Key ACLs:
3274+
# - addObject
3275+
# - deleteIndex
3276+
# - editSettings
32013277
# @param transformation_id [String] Unique identifier of a transformation. (required)
32023278
# @param transformation_create [TransformationCreate] (required)
32033279
# @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
32353311
end
32363312

32373313
# Updates a transformation by its ID.
3238-
3314+
#
3315+
# Required API Key ACLs:
3316+
# - addObject
3317+
# - deleteIndex
3318+
# - editSettings
32393319
# @param transformation_id [String] Unique identifier of a transformation. (required)
32403320
# @param transformation_create [TransformationCreate] (required)
32413321
# @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‎

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,9 @@ def assign_user_id(x_algolia_user_id, assign_user_id_params, request_options = {
268268
end
269269

270270
# 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).
271-
271+
#
272+
# Required API Key ACLs:
273+
# - addObject
272274
# @param index_name [String] Name of the index on which to perform the operation. (required)
273275
# @param batch_write_params [BatchWriteParams] (required)
274276
# @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 = {})
303305
end
304306

305307
# 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).
306-
308+
#
309+
# Required API Key ACLs:
310+
# - addObject
307311
# @param index_name [String] Name of the index on which to perform the operation. (required)
308312
# @param batch_write_params [BatchWriteParams] (required)
309313
# @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
11341138
end
11351139

11361140
# 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>`.
1137-
1141+
#
1142+
# Required API Key ACLs:
1143+
# - search
11381144
# @param key [String] API key. (required)
11391145
# @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)
11401146
# @return [Http::Response] the response
@@ -1164,7 +1170,9 @@ def get_api_key_with_http_info(key, request_options = {})
11641170
end
11651171

11661172
# 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>`.
1167-
1173+
#
1174+
# Required API Key ACLs:
1175+
# - search
11681176
# @param key [String] API key. (required)
11691177
# @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)
11701178
# @return [GetApiKeyResponse]
@@ -1976,7 +1984,9 @@ def list_user_ids(page = nil, hits_per_page = nil, request_options = {})
19761984
end
19771985

19781986
# 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).
1979-
1987+
#
1988+
# Required API Key ACLs:
1989+
# - addObject
19801990
# @param batch_params [BatchParams] (required)
19811991
# @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)
19821992
# @return [Http::Response] the response
@@ -2006,7 +2016,9 @@ def multiple_batch_with_http_info(batch_params, request_options = {})
20062016
end
20072017

20082018
# 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).
2009-
2019+
#
2020+
# Required API Key ACLs:
2021+
# - addObject
20102022
# @param batch_params [BatchParams] (required)
20112023
# @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)
20122024
# @return [MultipleBatchResponse]

0 commit comments

Comments
 (0)