Skip to content

Commit 1ad1945

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 891613e commit 1ad1945

File tree

2 files changed

+46
-13
lines changed

2 files changed

+46
-13
lines changed

Sources/Ingestion/IngestionClient.swift

Lines changed: 40 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,10 @@ open class IngestionClient {
205205
}
206206

207207
// Creates a new task.
208-
//
208+
// Required API Key ACLs:
209+
// - addObject
210+
// - deleteIndex
211+
// - editSettings
209212
//
210213
// - parameter taskCreate: (body) Request body for creating a task.
211214
// - returns: RequestBuilder<TaskCreateResponse>
@@ -254,7 +257,10 @@ open class IngestionClient {
254257
}
255258

256259
/// Creates a new task using the v1 endpoint, please use `createTask` instead.
257-
///
260+
/// Required API Key ACLs:
261+
/// - addObject
262+
/// - deleteIndex
263+
/// - editSettings
258264
///
259265
/// - parameter taskCreate: (body) Request body for creating a task.
260266
/// - returns: RequestBuilder<TaskCreateResponse>
@@ -303,7 +309,10 @@ open class IngestionClient {
303309
}
304310

305311
// Creates a new transformation.
306-
//
312+
// Required API Key ACLs:
313+
// - addObject
314+
// - deleteIndex
315+
// - editSettings
307316
//
308317
// - parameter transformationCreate: (body) Request body for creating a transformation.
309318
// - returns: RequestBuilder<TransformationCreateResponse>
@@ -810,7 +819,10 @@ open class IngestionClient {
810819
}
811820

812821
// Deletes a task by its ID.
813-
//
822+
// Required API Key ACLs:
823+
// - addObject
824+
// - deleteIndex
825+
// - editSettings
814826
//
815827
// - parameter taskID: (path) Unique identifier of a task.
816828
// - returns: RequestBuilder<DeleteResponse>
@@ -868,7 +880,10 @@ open class IngestionClient {
868880
}
869881

870882
/// Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
871-
///
883+
/// Required API Key ACLs:
884+
/// - addObject
885+
/// - deleteIndex
886+
/// - editSettings
872887
///
873888
/// - parameter taskID: (path) Unique identifier of a task.
874889
/// - returns: RequestBuilder<DeleteResponse>
@@ -929,7 +944,10 @@ open class IngestionClient {
929944
}
930945

931946
// Deletes a transformation by its ID.
932-
//
947+
// Required API Key ACLs:
948+
// - addObject
949+
// - deleteIndex
950+
// - editSettings
933951
//
934952
// - parameter transformationID: (path) Unique identifier of a transformation.
935953
// - returns: RequestBuilder<DeleteResponse>
@@ -2755,7 +2773,10 @@ open class IngestionClient {
27552773
}
27562774

27572775
// Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
2758-
//
2776+
// Required API Key ACLs:
2777+
// - addObject
2778+
// - deleteIndex
2779+
// - editSettings
27592780
//
27602781
// - parameter taskID: (path) Unique identifier of a task.
27612782
//
@@ -3736,7 +3757,10 @@ open class IngestionClient {
37363757
}
37373758

37383759
// Partially updates a task by its ID.
3739-
//
3760+
// Required API Key ACLs:
3761+
// - addObject
3762+
// - deleteIndex
3763+
// - editSettings
37403764
//
37413765
// - parameter taskID: (path) Unique identifier of a task.
37423766
//
@@ -3803,7 +3827,10 @@ open class IngestionClient {
38033827
}
38043828

38053829
/// Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
3806-
///
3830+
/// Required API Key ACLs:
3831+
/// - addObject
3832+
/// - deleteIndex
3833+
/// - editSettings
38073834
///
38083835
/// - parameter taskID: (path) Unique identifier of a task.
38093836
///
@@ -3870,7 +3897,10 @@ open class IngestionClient {
38703897
}
38713898

38723899
// Updates a transformation by its ID.
3873-
//
3900+
// Required API Key ACLs:
3901+
// - addObject
3902+
// - deleteIndex
3903+
// - editSettings
38743904
//
38753905
// - parameter transformationID: (path) Unique identifier of a transformation.
38763906
//

Sources/Search/SearchClient.swift

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,8 @@ open class SearchClient {
307307
// and increases data integrity. - Actions are applied in the order they're specified. - Actions are equivalent to
308308
// the individual API requests of the same name. This operation is subject to [indexing rate
309309
// limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
310-
//
310+
// Required API Key ACLs:
311+
// - addObject
311312
//
312313
// - parameter indexName: (path) Name of the index on which to perform the operation.
313314
//
@@ -1561,7 +1562,8 @@ open class SearchClient {
15611562
// Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request
15621563
// information for any of your application's keys. When authenticating with other API keys, you can only retrieve
15631564
// information for that key, with the description replaced by `<redacted>`.
1564-
//
1565+
// Required API Key ACLs:
1566+
// - search
15651567
//
15661568
// - parameter key: (path) API key.
15671569
// - returns: RequestBuilder<GetApiKeyResponse>
@@ -2694,7 +2696,8 @@ open class SearchClient {
26942696
// order they are specified. - Actions are equivalent to the individual API requests of the same name. This
26952697
// operation is subject to [indexing rate
26962698
// limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
2697-
//
2699+
// Required API Key ACLs:
2700+
// - addObject
26982701
//
26992702
// - parameter batchParams: (body)
27002703
// - returns: RequestBuilder<MultipleBatchResponse>

0 commit comments

Comments
 (0)