Skip to content

Commit 0009c12

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 f516db4 commit 0009c12

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

src/main/scala/algoliasearch/ingestion/Action.scala

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,16 @@ import org.json4s._
2323

2424
sealed trait Action
2525

26-
/** Type of indexing operation.
26+
/** Which indexing operation to perform: - `addObject`: adds records to an index. Equivalent to the \"Add a new record
27+
* (with auto-generated object ID)\" operation. - `updateObject`: adds or replaces records in an index. Equivalent to
28+
* the \"Add or replace a record\" operation. - `partialUpdateObject`: adds or updates attributes within records.
29+
* Equivalent to the \"Add or update attributes\" operation with the `createIfNoExists` parameter set to true. (If a
30+
* record with the specified `objectID` doesn't exist in the specified index, this action creates adds the record to
31+
* the index) - `partialUpdateObjectNoCreate`: same as `partialUpdateObject`, but with `createIfNoExists` set to false.
32+
* (A record isn't added to the index if its `objectID` doesn't exist) - `deleteObject`: delete records from an index.
33+
* Equivalent to the \"Delete a record\" operation. - `delete`. Delete an index. Equivalent to the \"Delete an index\"
34+
* operation. - `clear`: delete all records from an index. Equivalent to the \"Delete all records from an index
35+
* operation\".
2736
*/
2837
object Action {
2938
case object AddObject extends Action {

src/main/scala/algoliasearch/search/Action.scala

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,16 @@ import org.json4s._
3737

3838
sealed trait Action
3939

40-
/** Type of indexing operation.
40+
/** Which indexing operation to perform: - `addObject`: adds records to an index. Equivalent to the \"Add a new record
41+
* (with auto-generated object ID)\" operation. - `updateObject`: adds or replaces records in an index. Equivalent to
42+
* the \"Add or replace a record\" operation. - `partialUpdateObject`: adds or updates attributes within records.
43+
* Equivalent to the \"Add or update attributes\" operation with the `createIfNoExists` parameter set to true. (If a
44+
* record with the specified `objectID` doesn't exist in the specified index, this action creates adds the record to
45+
* the index) - `partialUpdateObjectNoCreate`: same as `partialUpdateObject`, but with `createIfNoExists` set to false.
46+
* (A record isn't added to the index if its `objectID` doesn't exist) - `deleteObject`: delete records from an index.
47+
* Equivalent to the \"Delete a record\" operation. - `delete`. Delete an index. Equivalent to the \"Delete an index\"
48+
* operation. - `clear`: delete all records from an index. Equivalent to the \"Delete all records from an index
49+
* operation\".
4150
*/
4251
object Action {
4352
case object AddObject extends Action {

0 commit comments

Comments
 (0)