Skip to content

Commit fdcb4e4

Browse files
algolia-botmillotp
algolia-bot
and
millotp
committed
fix(specs): add ACL to missing endpoints (#5529) (generated) [skip ci]
Co-authored-by: Pierre Millot <[email protected]>
1 parent 1eee2a5 commit fdcb4e4

File tree

48 files changed

+1203
-49
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1203
-49
lines changed

‎clients/algoliasearch-client-csharp/algoliasearch/Clients/IngestionClient.cs‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,11 @@ SourceCreateResponse CreateSource(
149149
/// <summary>
150150
/// Creates a new task.
151151
/// </summary>
152+
///
153+
/// Required API Key ACLs:
154+
/// - addObject
155+
/// - deleteIndex
156+
/// - editSettings
152157
/// <param name="taskCreate">Request body for creating a task.</param>
153158
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
154159
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -165,6 +170,11 @@ Task<TaskCreateResponse> CreateTaskAsync(
165170
/// <summary>
166171
/// Creates a new task. (Synchronous version)
167172
/// </summary>
173+
///
174+
/// Required API Key ACLs:
175+
/// - addObject
176+
/// - deleteIndex
177+
/// - editSettings
168178
/// <param name="taskCreate">Request body for creating a task.</param>
169179
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
170180
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -181,6 +191,11 @@ TaskCreateResponse CreateTask(
181191
/// <summary>
182192
/// Creates a new task using the v1 endpoint, please use `createTask` instead.
183193
/// </summary>
194+
///
195+
/// Required API Key ACLs:
196+
/// - addObject
197+
/// - deleteIndex
198+
/// - editSettings
184199
/// <param name="taskCreate">Request body for creating a task.</param>
185200
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
186201
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -198,6 +213,11 @@ Task<TaskCreateResponse> CreateTaskV1Async(
198213
/// <summary>
199214
/// Creates a new task using the v1 endpoint, please use `createTask` instead. (Synchronous version)
200215
/// </summary>
216+
///
217+
/// Required API Key ACLs:
218+
/// - addObject
219+
/// - deleteIndex
220+
/// - editSettings
201221
/// <param name="taskCreate">Request body for creating a task.</param>
202222
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
203223
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -215,6 +235,11 @@ TaskCreateResponse CreateTaskV1(
215235
/// <summary>
216236
/// Creates a new transformation.
217237
/// </summary>
238+
///
239+
/// Required API Key ACLs:
240+
/// - addObject
241+
/// - deleteIndex
242+
/// - editSettings
218243
/// <param name="transformationCreate">Request body for creating a transformation.</param>
219244
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
220245
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -231,6 +256,11 @@ Task<TransformationCreateResponse> CreateTransformationAsync(
231256
/// <summary>
232257
/// Creates a new transformation. (Synchronous version)
233258
/// </summary>
259+
///
260+
/// Required API Key ACLs:
261+
/// - addObject
262+
/// - deleteIndex
263+
/// - editSettings
234264
/// <param name="transformationCreate">Request body for creating a transformation.</param>
235265
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
236266
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -525,6 +555,11 @@ DeleteResponse DeleteSource(
525555
/// <summary>
526556
/// Deletes a task by its ID.
527557
/// </summary>
558+
///
559+
/// Required API Key ACLs:
560+
/// - addObject
561+
/// - deleteIndex
562+
/// - editSettings
528563
/// <param name="taskID">Unique identifier of a task.</param>
529564
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
530565
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -541,6 +576,11 @@ Task<DeleteResponse> DeleteTaskAsync(
541576
/// <summary>
542577
/// Deletes a task by its ID. (Synchronous version)
543578
/// </summary>
579+
///
580+
/// Required API Key ACLs:
581+
/// - addObject
582+
/// - deleteIndex
583+
/// - editSettings
544584
/// <param name="taskID">Unique identifier of a task.</param>
545585
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
546586
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -557,6 +597,11 @@ DeleteResponse DeleteTask(
557597
/// <summary>
558598
/// Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
559599
/// </summary>
600+
///
601+
/// Required API Key ACLs:
602+
/// - addObject
603+
/// - deleteIndex
604+
/// - editSettings
560605
/// <param name="taskID">Unique identifier of a task.</param>
561606
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
562607
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -574,6 +619,11 @@ Task<DeleteResponse> DeleteTaskV1Async(
574619
/// <summary>
575620
/// Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead. (Synchronous version)
576621
/// </summary>
622+
///
623+
/// Required API Key ACLs:
624+
/// - addObject
625+
/// - deleteIndex
626+
/// - editSettings
577627
/// <param name="taskID">Unique identifier of a task.</param>
578628
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
579629
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -591,6 +641,11 @@ DeleteResponse DeleteTaskV1(
591641
/// <summary>
592642
/// Deletes a transformation by its ID.
593643
/// </summary>
644+
///
645+
/// Required API Key ACLs:
646+
/// - addObject
647+
/// - deleteIndex
648+
/// - editSettings
594649
/// <param name="transformationID">Unique identifier of a transformation.</param>
595650
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
596651
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -607,6 +662,11 @@ Task<DeleteResponse> DeleteTransformationAsync(
607662
/// <summary>
608663
/// Deletes a transformation by its ID. (Synchronous version)
609664
/// </summary>
665+
///
666+
/// Required API Key ACLs:
667+
/// - addObject
668+
/// - deleteIndex
669+
/// - editSettings
610670
/// <param name="transformationID">Unique identifier of a transformation.</param>
611671
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
612672
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -1795,6 +1855,11 @@ WatchResponse PushTask(
17951855
/// <summary>
17961856
/// Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
17971857
/// </summary>
1858+
///
1859+
/// Required API Key ACLs:
1860+
/// - addObject
1861+
/// - deleteIndex
1862+
/// - editSettings
17981863
/// <param name="taskID">Unique identifier of a task.</param>
17991864
/// <param name="taskReplace"></param>
18001865
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -1813,6 +1878,11 @@ Task<TaskUpdateResponse> ReplaceTaskAsync(
18131878
/// <summary>
18141879
/// Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields. (Synchronous version)
18151880
/// </summary>
1881+
///
1882+
/// Required API Key ACLs:
1883+
/// - addObject
1884+
/// - deleteIndex
1885+
/// - editSettings
18161886
/// <param name="taskID">Unique identifier of a task.</param>
18171887
/// <param name="taskReplace"></param>
18181888
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -2493,6 +2563,11 @@ SourceUpdateResponse UpdateSource(
24932563
/// <summary>
24942564
/// Partially updates a task by its ID.
24952565
/// </summary>
2566+
///
2567+
/// Required API Key ACLs:
2568+
/// - addObject
2569+
/// - deleteIndex
2570+
/// - editSettings
24962571
/// <param name="taskID">Unique identifier of a task.</param>
24972572
/// <param name="taskUpdate"></param>
24982573
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -2511,6 +2586,11 @@ Task<TaskUpdateResponse> UpdateTaskAsync(
25112586
/// <summary>
25122587
/// Partially updates a task by its ID. (Synchronous version)
25132588
/// </summary>
2589+
///
2590+
/// Required API Key ACLs:
2591+
/// - addObject
2592+
/// - deleteIndex
2593+
/// - editSettings
25142594
/// <param name="taskID">Unique identifier of a task.</param>
25152595
/// <param name="taskUpdate"></param>
25162596
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -2529,6 +2609,11 @@ TaskUpdateResponse UpdateTask(
25292609
/// <summary>
25302610
/// Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
25312611
/// </summary>
2612+
///
2613+
/// Required API Key ACLs:
2614+
/// - addObject
2615+
/// - deleteIndex
2616+
/// - editSettings
25322617
/// <param name="taskID">Unique identifier of a task.</param>
25332618
/// <param name="taskUpdate"></param>
25342619
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -2548,6 +2633,11 @@ Task<TaskUpdateResponse> UpdateTaskV1Async(
25482633
/// <summary>
25492634
/// Updates a task by its ID using the v1 endpoint, please use `updateTask` instead. (Synchronous version)
25502635
/// </summary>
2636+
///
2637+
/// Required API Key ACLs:
2638+
/// - addObject
2639+
/// - deleteIndex
2640+
/// - editSettings
25512641
/// <param name="taskID">Unique identifier of a task.</param>
25522642
/// <param name="taskUpdate"></param>
25532643
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -2567,6 +2657,11 @@ TaskUpdateResponse UpdateTaskV1(
25672657
/// <summary>
25682658
/// Updates a transformation by its ID.
25692659
/// </summary>
2660+
///
2661+
/// Required API Key ACLs:
2662+
/// - addObject
2663+
/// - deleteIndex
2664+
/// - editSettings
25702665
/// <param name="transformationID">Unique identifier of a transformation.</param>
25712666
/// <param name="transformationCreate"></param>
25722667
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -2585,6 +2680,11 @@ Task<TransformationUpdateResponse> UpdateTransformationAsync(
25852680
/// <summary>
25862681
/// Updates a transformation by its ID. (Synchronous version)
25872682
/// </summary>
2683+
///
2684+
/// Required API Key ACLs:
2685+
/// - addObject
2686+
/// - deleteIndex
2687+
/// - editSettings
25882688
/// <param name="transformationID">Unique identifier of a transformation.</param>
25892689
/// <param name="transformationCreate"></param>
25902690
/// <param name="options">Add extra http header or query parameters to Algolia.</param>

‎clients/algoliasearch-client-csharp/algoliasearch/Clients/SearchClient.cs‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,9 @@ CreatedAtResponse AssignUserId(
190190
/// <summary>
191191
/// 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).
192192
/// </summary>
193+
///
194+
/// Required API Key ACLs:
195+
/// - addObject
193196
/// <param name="indexName">Name of the index on which to perform the operation.</param>
194197
/// <param name="batchWriteParams"></param>
195198
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -208,6 +211,9 @@ Task<BatchResponse> BatchAsync(
208211
/// <summary>
209212
/// 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). (Synchronous version)
210213
/// </summary>
214+
///
215+
/// Required API Key ACLs:
216+
/// - addObject
211217
/// <param name="indexName">Name of the index on which to perform the operation.</param>
212218
/// <param name="batchWriteParams"></param>
213219
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -918,6 +924,9 @@ DeletedAtResponse DeleteSynonym(
918924
/// <summary>
919925
/// 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>`.
920926
/// </summary>
927+
///
928+
/// Required API Key ACLs:
929+
/// - search
921930
/// <param name="key">API key.</param>
922931
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
923932
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -934,6 +943,9 @@ Task<GetApiKeyResponse> GetApiKeyAsync(
934943
/// <summary>
935944
/// 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>`. (Synchronous version)
936945
/// </summary>
946+
///
947+
/// Required API Key ACLs:
948+
/// - search
937949
/// <param name="key">API key.</param>
938950
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
939951
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -1664,6 +1676,9 @@ ListUserIdsResponse ListUserIds(
16641676
/// <summary>
16651677
/// 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).
16661678
/// </summary>
1679+
///
1680+
/// Required API Key ACLs:
1681+
/// - addObject
16671682
/// <param name="batchParams"></param>
16681683
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
16691684
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -1680,6 +1695,9 @@ Task<MultipleBatchResponse> MultipleBatchAsync(
16801695
/// <summary>
16811696
/// 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). (Synchronous version)
16821697
/// </summary>
1698+
///
1699+
/// Required API Key ACLs:
1700+
/// - addObject
16831701
/// <param name="batchParams"></param>
16841702
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
16851703
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>

‎clients/algoliasearch-client-dart/packages/client_search/lib/src/api/search_client.dart‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,9 @@ final class SearchClient implements ApiClient {
253253

254254
/// 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).
255255
///
256+
/// Required API Key ACLs:
257+
/// - addObject
258+
///
256259
/// Parameters:
257260
/// * [indexName] Name of the index on which to perform the operation.
258261
/// * [batchWriteParams]
@@ -899,6 +902,9 @@ final class SearchClient implements ApiClient {
899902

900903
/// 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>`.
901904
///
905+
/// Required API Key ACLs:
906+
/// - search
907+
///
902908
/// Parameters:
903909
/// * [key] API key.
904910
/// * [requestOptions] additional request configuration.
@@ -1511,6 +1517,9 @@ final class SearchClient implements ApiClient {
15111517

15121518
/// 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).
15131519
///
1520+
/// Required API Key ACLs:
1521+
/// - addObject
1522+
///
15141523
/// Parameters:
15151524
/// * [batchParams]
15161525
/// * [requestOptions] additional request configuration.

0 commit comments

Comments
 (0)