Skip to content

Commit ef91c31

Browse files
algolia-botmillotp
andcommitted
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>
1 parent 46ae2e7 commit ef91c31

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed

client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,11 @@ public class IngestionClient(
114114
/**
115115
* Creates a new task.
116116
*
117+
* Required API Key ACLs:
118+
* - addObject
119+
* - deleteIndex
120+
* - editSettings
121+
*
117122
* @param taskCreate Request body for creating a task.
118123
* @param requestOptions additional request configuration.
119124
*/
@@ -129,6 +134,11 @@ public class IngestionClient(
129134
/**
130135
* Creates a new task using the v1 endpoint, please use `createTask` instead.
131136
*
137+
* Required API Key ACLs:
138+
* - addObject
139+
* - deleteIndex
140+
* - editSettings
141+
*
132142
* @param taskCreate Request body for creating a task.
133143
* @param requestOptions additional request configuration.
134144
* @deprecated
@@ -145,6 +155,11 @@ public class IngestionClient(
145155
/**
146156
* Creates a new transformation.
147157
*
158+
* Required API Key ACLs:
159+
* - addObject
160+
* - deleteIndex
161+
* - editSettings
162+
*
148163
* @param transformationCreate Request body for creating a transformation.
149164
* @param requestOptions additional request configuration.
150165
*/
@@ -334,6 +349,11 @@ public class IngestionClient(
334349
/**
335350
* Deletes a task by its ID.
336351
*
352+
* Required API Key ACLs:
353+
* - addObject
354+
* - deleteIndex
355+
* - editSettings
356+
*
337357
* @param taskID Unique identifier of a task.
338358
* @param requestOptions additional request configuration.
339359
*/
@@ -350,6 +370,11 @@ public class IngestionClient(
350370
/**
351371
* Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
352372
*
373+
* Required API Key ACLs:
374+
* - addObject
375+
* - deleteIndex
376+
* - editSettings
377+
*
353378
* @param taskID Unique identifier of a task.
354379
* @param requestOptions additional request configuration.
355380
* @deprecated
@@ -367,6 +392,11 @@ public class IngestionClient(
367392
/**
368393
* Deletes a transformation by its ID.
369394
*
395+
* Required API Key ACLs:
396+
* - addObject
397+
* - deleteIndex
398+
* - editSettings
399+
*
370400
* @param transformationID Unique identifier of a transformation.
371401
* @param requestOptions additional request configuration.
372402
*/
@@ -1139,6 +1169,11 @@ public class IngestionClient(
11391169
* Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of
11401170
* fields.
11411171
*
1172+
* Required API Key ACLs:
1173+
* - addObject
1174+
* - deleteIndex
1175+
* - editSettings
1176+
*
11421177
* @param taskID Unique identifier of a task.
11431178
* @param taskReplace
11441179
* @param requestOptions additional request configuration.
@@ -1565,6 +1600,11 @@ public class IngestionClient(
15651600
/**
15661601
* Partially updates a task by its ID.
15671602
*
1603+
* Required API Key ACLs:
1604+
* - addObject
1605+
* - deleteIndex
1606+
* - editSettings
1607+
*
15681608
* @param taskID Unique identifier of a task.
15691609
* @param taskUpdate
15701610
* @param requestOptions additional request configuration.
@@ -1587,6 +1627,11 @@ public class IngestionClient(
15871627
/**
15881628
* Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
15891629
*
1630+
* Required API Key ACLs:
1631+
* - addObject
1632+
* - deleteIndex
1633+
* - editSettings
1634+
*
15901635
* @param taskID Unique identifier of a task.
15911636
* @param taskUpdate
15921637
* @param requestOptions additional request configuration.
@@ -1610,6 +1655,11 @@ public class IngestionClient(
16101655
/**
16111656
* Updates a transformation by its ID.
16121657
*
1658+
* Required API Key ACLs:
1659+
* - addObject
1660+
* - deleteIndex
1661+
* - editSettings
1662+
*
16131663
* @param transformationID Unique identifier of a transformation.
16141664
* @param transformationCreate
16151665
* @param requestOptions additional request configuration.

client/src/commonMain/kotlin/com/algolia/client/api/SearchClient.kt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,9 @@ public class SearchClient(
163163
* This operation is subject to
164164
* [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
165165
*
166+
* Required API Key ACLs:
167+
* - addObject
168+
*
166169
* @param indexName Name of the index on which to perform the operation.
167170
* @param batchWriteParams
168171
* @param requestOptions additional request configuration.
@@ -645,6 +648,9 @@ public class SearchClient(
645648
* other API keys, you can only retrieve information for that key, with the description replaced
646649
* by `<redacted>`.
647650
*
651+
* Required API Key ACLs:
652+
* - search
653+
*
648654
* @param key API key.
649655
* @param requestOptions additional request configuration.
650656
*/
@@ -1092,6 +1098,9 @@ public class SearchClient(
10921098
* requests of the same name. This operation is subject to
10931099
* [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
10941100
*
1101+
* Required API Key ACLs:
1102+
* - addObject
1103+
*
10951104
* @param batchParams
10961105
* @param requestOptions additional request configuration.
10971106
*/

0 commit comments

Comments
 (0)