Skip to content

Commit ca6f3ca

Browse files
authored
fix(specs): define batch actions (#5242)
1 parent 347d278 commit ca6f3ca

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

specs/common/schemas/Batch.yml

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,19 @@ action:
4848
- deleteObject
4949
- delete
5050
- clear
51-
description: Type of indexing operation.
51+
description: |
52+
Which indexing operation to perform:
53+
54+
- `addObject`: adds records to an index.
55+
Equivalent to the "Add a new record (with auto-generated object ID)" operation.
56+
- `updateObject`: adds or replaces records in an index.
57+
Equivalent to the "Add or replace a record" operation.
58+
- `partialUpdateObject`: adds or updates attributes within records.
59+
Equivalent to the "Add or update attributes" operation with the `createIfNoExists` parameter set to true.
60+
(If a record with the specified `objectID` doesn't exist in the specified index, this action creates adds the record to the index)
61+
- `partialUpdateObjectNoCreate`: same as `partialUpdateObject`, but with `createIfNoExists` set to false.
62+
(A record isn't added to the index if its `objectID` doesn't exist)
63+
- `deleteObject`: delete records from an index.
64+
Equivalent to the "Delete a record" operation.
65+
- `delete`. Delete an index. Equivalent to the "Delete an index" operation.
66+
- `clear`: delete all records from an index. Equivalent to the "Delete all records from an index operation".

0 commit comments

Comments
 (0)