Skip to content

Commit 111c2d5

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 062fcc3 commit 111c2d5

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed

packages/client-search/src/searchClient.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -908,6 +908,9 @@ export function createSearchClient({
908908

909909
/**
910910
* 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).
911+
*
912+
* Required API Key ACLs:
913+
* - addObject
911914
* @param batch - The batch object.
912915
* @param batch.indexName - Name of the index on which to perform the operation.
913916
* @param batch.batchWriteParams - The batchWriteParams object.
@@ -1532,6 +1535,9 @@ export function createSearchClient({
15321535

15331536
/**
15341537
* 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>`.
1538+
*
1539+
* Required API Key ACLs:
1540+
* - search
15351541
* @param getApiKey - The getApiKey object.
15361542
* @param getApiKey.key - API key.
15371543
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2122,6 +2128,9 @@ export function createSearchClient({
21222128

21232129
/**
21242130
* 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).
2131+
*
2132+
* Required API Key ACLs:
2133+
* - addObject
21252134
* @param batchParams - The batchParams object.
21262135
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
21272136
*/

packages/ingestion/src/ingestionClient.ts

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -451,6 +451,11 @@ export function createIngestionClient({
451451

452452
/**
453453
* Creates a new task.
454+
*
455+
* Required API Key ACLs:
456+
* - addObject
457+
* - deleteIndex
458+
* - editSettings
454459
* @param taskCreate - Request body for creating a task.
455460
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
456461
*/
@@ -487,6 +492,11 @@ export function createIngestionClient({
487492
/**
488493
* Creates a new task using the v1 endpoint, please use `createTask` instead.
489494
*
495+
* Required API Key ACLs:
496+
* - addObject
497+
* - deleteIndex
498+
* - editSettings
499+
*
490500
* @deprecated
491501
* @param taskCreate - Request body for creating a task.
492502
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -526,6 +536,11 @@ export function createIngestionClient({
526536

527537
/**
528538
* Creates a new transformation.
539+
*
540+
* Required API Key ACLs:
541+
* - addObject
542+
* - deleteIndex
543+
* - editSettings
529544
* @param transformationCreate - Request body for creating a transformation.
530545
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
531546
*/
@@ -777,6 +792,11 @@ export function createIngestionClient({
777792

778793
/**
779794
* Deletes a task by its ID.
795+
*
796+
* Required API Key ACLs:
797+
* - addObject
798+
* - deleteIndex
799+
* - editSettings
780800
* @param deleteTask - The deleteTask object.
781801
* @param deleteTask.taskID - Unique identifier of a task.
782802
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -803,6 +823,11 @@ export function createIngestionClient({
803823
/**
804824
* Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
805825
*
826+
* Required API Key ACLs:
827+
* - addObject
828+
* - deleteIndex
829+
* - editSettings
830+
*
806831
* @deprecated
807832
* @param deleteTaskV1 - The deleteTaskV1 object.
808833
* @param deleteTaskV1.taskID - Unique identifier of a task.
@@ -829,6 +854,11 @@ export function createIngestionClient({
829854

830855
/**
831856
* Deletes a transformation by its ID.
857+
*
858+
* Required API Key ACLs:
859+
* - addObject
860+
* - deleteIndex
861+
* - editSettings
832862
* @param deleteTransformation - The deleteTransformation object.
833863
* @param deleteTransformation.transformationID - Unique identifier of a transformation.
834864
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1921,6 +1951,11 @@ export function createIngestionClient({
19211951

19221952
/**
19231953
* Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
1954+
*
1955+
* Required API Key ACLs:
1956+
* - addObject
1957+
* - deleteIndex
1958+
* - editSettings
19241959
* @param replaceTask - The replaceTask object.
19251960
* @param replaceTask.taskID - Unique identifier of a task.
19261961
* @param replaceTask.taskReplace - The taskReplace object.
@@ -2532,6 +2567,11 @@ export function createIngestionClient({
25322567

25332568
/**
25342569
* Partially updates a task by its ID.
2570+
*
2571+
* Required API Key ACLs:
2572+
* - addObject
2573+
* - deleteIndex
2574+
* - editSettings
25352575
* @param updateTask - The updateTask object.
25362576
* @param updateTask.taskID - Unique identifier of a task.
25372577
* @param updateTask.taskUpdate - The taskUpdate object.
@@ -2564,6 +2604,11 @@ export function createIngestionClient({
25642604
/**
25652605
* Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
25662606
*
2607+
* Required API Key ACLs:
2608+
* - addObject
2609+
* - deleteIndex
2610+
* - editSettings
2611+
*
25672612
* @deprecated
25682613
* @param updateTaskV1 - The updateTaskV1 object.
25692614
* @param updateTaskV1.taskID - Unique identifier of a task.
@@ -2599,6 +2644,11 @@ export function createIngestionClient({
25992644

26002645
/**
26012646
* Updates a transformation by its ID.
2647+
*
2648+
* Required API Key ACLs:
2649+
* - addObject
2650+
* - deleteIndex
2651+
* - editSettings
26022652
* @param updateTransformation - The updateTransformation object.
26032653
* @param updateTransformation.transformationID - Unique identifier of a transformation.
26042654
* @param updateTransformation.transformationCreate - The transformationCreate object.

0 commit comments

Comments
 (0)