Skip to content

Commit b71cb6b

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 ba2062d commit b71cb6b

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed

lib/Api/IngestionClient.php

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,11 @@ public function createSource($sourceCreate, $requestOptions = [])
283283
/**
284284
* Creates a new task.
285285
*
286+
* Required API Key ACLs:
287+
* - addObject
288+
* - deleteIndex
289+
* - editSettings
290+
*
286291
* @param array|TaskCreate $taskCreate Request body for creating a task. (required)
287292
* - $taskCreate['sourceID'] => (string) Universally uniqud identifier (UUID) of a source. (required)
288293
* - $taskCreate['destinationID'] => (string) Universally unique identifier (UUID) of a destination resource. (required)
@@ -322,6 +327,11 @@ public function createTask($taskCreate, $requestOptions = [])
322327
/**
323328
* Creates a new task using the v1 endpoint, please use `createTask` instead.
324329
*
330+
* Required API Key ACLs:
331+
* - addObject
332+
* - deleteIndex
333+
* - editSettings
334+
*
325335
* @param array|TaskCreateV1 $taskCreate Request body for creating a task. (required)
326336
* - $taskCreate['sourceID'] => (string) Universally uniqud identifier (UUID) of a source. (required)
327337
* - $taskCreate['destinationID'] => (string) Universally unique identifier (UUID) of a destination resource. (required)
@@ -360,6 +370,11 @@ public function createTaskV1($taskCreate, $requestOptions = [])
360370
/**
361371
* Creates a new transformation.
362372
*
373+
* Required API Key ACLs:
374+
* - addObject
375+
* - deleteIndex
376+
* - editSettings
377+
*
363378
* @param array|TransformationCreate $transformationCreate Request body for creating a transformation. (required)
364379
* - $transformationCreate['code'] => (string) It is deprecated. Use the `input` field with proper `type` instead to specify the transformation code.
365380
* - $transformationCreate['name'] => (string) The uniquely identified name of your transformation. (required)
@@ -669,6 +684,11 @@ public function deleteSource($sourceID, $requestOptions = [])
669684
/**
670685
* Deletes a task by its ID.
671686
*
687+
* Required API Key ACLs:
688+
* - addObject
689+
* - deleteIndex
690+
* - editSettings
691+
*
672692
* @param string $taskID Unique identifier of a task. (required)
673693
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
674694
*
@@ -703,6 +723,11 @@ public function deleteTask($taskID, $requestOptions = [])
703723
/**
704724
* Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
705725
*
726+
* Required API Key ACLs:
727+
* - addObject
728+
* - deleteIndex
729+
* - editSettings
730+
*
706731
* @param string $taskID Unique identifier of a task. (required)
707732
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
708733
*
@@ -739,6 +764,11 @@ public function deleteTaskV1($taskID, $requestOptions = [])
739764
/**
740765
* Deletes a transformation by its ID.
741766
*
767+
* Required API Key ACLs:
768+
* - addObject
769+
* - deleteIndex
770+
* - editSettings
771+
*
742772
* @param string $transformationID Unique identifier of a transformation. (required)
743773
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
744774
*
@@ -1948,6 +1978,11 @@ public function pushTask($taskID, $pushTaskPayload, $watch = null, $requestOptio
19481978
/**
19491979
* Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
19501980
*
1981+
* Required API Key ACLs:
1982+
* - addObject
1983+
* - deleteIndex
1984+
* - editSettings
1985+
*
19511986
* @param string $taskID Unique identifier of a task. (required)
19521987
* @param array|TaskReplace $taskReplace taskReplace (required)
19531988
* - $taskReplace['destinationID'] => (string) Universally unique identifier (UUID) of a destination resource. (required)
@@ -2645,6 +2680,11 @@ public function updateSource($sourceID, $sourceUpdate, $requestOptions = [])
26452680
/**
26462681
* Partially updates a task by its ID.
26472682
*
2683+
* Required API Key ACLs:
2684+
* - addObject
2685+
* - deleteIndex
2686+
* - editSettings
2687+
*
26482688
* @param string $taskID Unique identifier of a task. (required)
26492689
* @param array|TaskUpdate $taskUpdate taskUpdate (required)
26502690
* - $taskUpdate['destinationID'] => (string) Universally unique identifier (UUID) of a destination resource.
@@ -2697,6 +2737,11 @@ public function updateTask($taskID, $taskUpdate, $requestOptions = [])
26972737
/**
26982738
* Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
26992739
*
2740+
* Required API Key ACLs:
2741+
* - addObject
2742+
* - deleteIndex
2743+
* - editSettings
2744+
*
27002745
* @param string $taskID Unique identifier of a task. (required)
27012746
* @param array|TaskUpdateV1 $taskUpdate taskUpdate (required)
27022747
* - $taskUpdate['destinationID'] => (string) Universally unique identifier (UUID) of a destination resource.
@@ -2748,6 +2793,11 @@ public function updateTaskV1($taskID, $taskUpdate, $requestOptions = [])
27482793
/**
27492794
* Updates a transformation by its ID.
27502795
*
2796+
* Required API Key ACLs:
2797+
* - addObject
2798+
* - deleteIndex
2799+
* - editSettings
2800+
*
27512801
* @param string $transformationID Unique identifier of a transformation. (required)
27522802
* @param array|TransformationCreate $transformationCreate transformationCreate (required)
27532803
* - $transformationCreate['code'] => (string) It is deprecated. Use the `input` field with proper `type` instead to specify the transformation code.

lib/Api/SearchClient.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,9 @@ public function assignUserId($xAlgoliaUserID, $assignUserIdParams, $requestOptio
372372
/**
373373
* 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).
374374
*
375+
* Required API Key ACLs:
376+
* - addObject
377+
*
375378
* @param string $indexName Name of the index on which to perform the operation. (required)
376379
* @param array|BatchWriteParams $batchWriteParams batchWriteParams (required)
377380
* - $batchWriteParams['requests'] => (array) (required)
@@ -1165,6 +1168,9 @@ public function deleteSynonym($indexName, $objectID, $forwardToReplicas = null,
11651168
/**
11661169
* 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>`.
11671170
*
1171+
* Required API Key ACLs:
1172+
* - search
1173+
*
11681174
* @param string $key API key. (required)
11691175
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
11701176
*
@@ -1819,6 +1825,9 @@ public function listUserIds($page = null, $hitsPerPage = null, $requestOptions =
18191825
/**
18201826
* 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).
18211827
*
1828+
* Required API Key ACLs:
1829+
* - addObject
1830+
*
18221831
* @param array|BatchParams $batchParams batchParams (required)
18231832
* - $batchParams['requests'] => (array) (required)
18241833
*

0 commit comments

Comments
 (0)