Skip to content

Commit ce8942b

Browse files
algolia-botkai687
andcommitted
fix(specs): define batch actions (generated)
algolia/api-clients-automation#5242 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Kai Welke <[email protected]>
1 parent 4df3fbd commit ce8942b

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

Sources/Ingestion/Models/IngestionAction.swift

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,16 @@ import Foundation
66
import Core
77
#endif
88

9-
/// Type of indexing operation.
9+
/// Which indexing operation to perform: - `addObject`: adds records to an index. Equivalent to the \"Add a new
10+
/// record (with auto-generated object ID)\" operation. - `updateObject`: adds or replaces records in an index.
11+
/// Equivalent to the \"Add or replace a record\" operation. - `partialUpdateObject`: adds or updates attributes within
12+
/// records. Equivalent to the \"Add or update attributes\" operation with the `createIfNoExists` parameter set to
13+
/// true. (If a record with the specified `objectID` doesn't exist in the specified index, this action creates adds
14+
/// the record to the index) - `partialUpdateObjectNoCreate`: same as `partialUpdateObject`, but with `createIfNoExists`
15+
/// set to false. (A record isn't added to the index if its `objectID` doesn't exist) - `deleteObject`: delete
16+
/// records from an index. Equivalent to the \"Delete a record\" operation. - `delete`. Delete an index. Equivalent to
17+
/// the \"Delete an index\" operation. - `clear`: delete all records from an index. Equivalent to the \"Delete all
18+
/// records from an index operation\".
1019
public enum IngestionAction: String, Codable, CaseIterable {
1120
case addObject
1221
case updateObject

Sources/Search/Models/SearchAction.swift

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,16 @@ import Foundation
66
import Core
77
#endif
88

9-
/// Type of indexing operation.
9+
/// Which indexing operation to perform: - `addObject`: adds records to an index. Equivalent to the \"Add a new
10+
/// record (with auto-generated object ID)\" operation. - `updateObject`: adds or replaces records in an index.
11+
/// Equivalent to the \"Add or replace a record\" operation. - `partialUpdateObject`: adds or updates attributes within
12+
/// records. Equivalent to the \"Add or update attributes\" operation with the `createIfNoExists` parameter set to
13+
/// true. (If a record with the specified `objectID` doesn't exist in the specified index, this action creates adds
14+
/// the record to the index) - `partialUpdateObjectNoCreate`: same as `partialUpdateObject`, but with `createIfNoExists`
15+
/// set to false. (A record isn't added to the index if its `objectID` doesn't exist) - `deleteObject`: delete
16+
/// records from an index. Equivalent to the \"Delete a record\" operation. - `delete`. Delete an index. Equivalent to
17+
/// the \"Delete an index\" operation. - `clear`: delete all records from an index. Equivalent to the \"Delete all
18+
/// records from an index operation\".
1019
public enum SearchAction: String, Codable, CaseIterable {
1120
case addObject
1221
case updateObject

0 commit comments

Comments
 (0)