Skip to content

Commit 3f33278

Browse files
algolia-botmillotp
andcommitted
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 cb2c0df commit 3f33278

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed

src/main/scala/algoliasearch/api/IngestionClient.scala

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,11 @@ class IngestionClient(
229229
}
230230

231231
/** Creates a new task.
232+
*
233+
* Required API Key ACLs:
234+
* - addObject
235+
* - deleteIndex
236+
* - editSettings
232237
*
233238
* @param taskCreate
234239
* Request body for creating a task.
@@ -248,6 +253,11 @@ class IngestionClient(
248253
}
249254

250255
/** Creates a new task using the v1 endpoint, please use `createTask` instead.
256+
*
257+
* Required API Key ACLs:
258+
* - addObject
259+
* - deleteIndex
260+
* - editSettings
251261
*
252262
* @deprecated
253263
*
@@ -269,6 +279,11 @@ class IngestionClient(
269279
}
270280

271281
/** Creates a new transformation.
282+
*
283+
* Required API Key ACLs:
284+
* - addObject
285+
* - deleteIndex
286+
* - editSettings
272287
*
273288
* @param transformationCreate
274289
* Request body for creating a transformation.
@@ -461,6 +476,11 @@ class IngestionClient(
461476
}
462477

463478
/** Deletes a task by its ID.
479+
*
480+
* Required API Key ACLs:
481+
* - addObject
482+
* - deleteIndex
483+
* - editSettings
464484
*
465485
* @param taskID
466486
* Unique identifier of a task.
@@ -479,6 +499,11 @@ class IngestionClient(
479499
}
480500

481501
/** Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
502+
*
503+
* Required API Key ACLs:
504+
* - addObject
505+
* - deleteIndex
506+
* - editSettings
482507
*
483508
* @deprecated
484509
*
@@ -499,6 +524,11 @@ class IngestionClient(
499524
}
500525

501526
/** Deletes a transformation by its ID.
527+
*
528+
* Required API Key ACLs:
529+
* - addObject
530+
* - deleteIndex
531+
* - editSettings
502532
*
503533
* @param transformationID
504534
* Unique identifier of a transformation.
@@ -1308,6 +1338,11 @@ class IngestionClient(
13081338
}
13091339

13101340
/** Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
1341+
*
1342+
* Required API Key ACLs:
1343+
* - addObject
1344+
* - deleteIndex
1345+
* - editSettings
13111346
*
13121347
* @param taskID
13131348
* Unique identifier of a task.
@@ -1716,6 +1751,11 @@ class IngestionClient(
17161751
}
17171752

17181753
/** Partially updates a task by its ID.
1754+
*
1755+
* Required API Key ACLs:
1756+
* - addObject
1757+
* - deleteIndex
1758+
* - editSettings
17191759
*
17201760
* @param taskID
17211761
* Unique identifier of a task.
@@ -1736,6 +1776,11 @@ class IngestionClient(
17361776
}
17371777

17381778
/** Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
1779+
*
1780+
* Required API Key ACLs:
1781+
* - addObject
1782+
* - deleteIndex
1783+
* - editSettings
17391784
*
17401785
* @deprecated
17411786
*
@@ -1758,6 +1803,11 @@ class IngestionClient(
17581803
}
17591804

17601805
/** Updates a transformation by its ID.
1806+
*
1807+
* Required API Key ACLs:
1808+
* - addObject
1809+
* - deleteIndex
1810+
* - editSettings
17611811
*
17621812
* @param transformationID
17631813
* Unique identifier of a transformation.

src/main/scala/algoliasearch/api/SearchClient.scala

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,9 @@ class SearchClient(
259259
* the individual API requests of the same name. This operation is subject to [indexing rate
260260
* limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
261261
*
262+
* Required API Key ACLs:
263+
* - addObject
264+
*
262265
* @param indexName
263266
* Name of the index on which to perform the operation.
264267
*/
@@ -731,6 +734,9 @@ class SearchClient(
731734
* information for any of your application's keys. When authenticating with other API keys, you can only retrieve
732735
* information for that key, with the description replaced by `<redacted>`.
733736
*
737+
* Required API Key ACLs:
738+
* - search
739+
*
734740
* @param key
735741
* API key.
736742
*/
@@ -1178,6 +1184,9 @@ class SearchClient(
11781184
* order they are specified. - Actions are equivalent to the individual API requests of the same name. This operation
11791185
* is subject to [indexing rate
11801186
* limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
1187+
*
1188+
* Required API Key ACLs:
1189+
* - addObject
11811190
*/
11821191
def multipleBatch(batchParams: BatchParams, requestOptions: Option[RequestOptions] = None)(implicit
11831192
ec: ExecutionContext

0 commit comments

Comments
 (0)