From 20399a844c70fe8a7ecaf1f8734cc7418cc6070d Mon Sep 17 00:00:00 2001 From: Kai Welke Date: Wed, 13 Aug 2025 10:30:11 +0200 Subject: [PATCH] fix(specs): define batch actions --- specs/common/schemas/Batch.yml | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/specs/common/schemas/Batch.yml b/specs/common/schemas/Batch.yml index f9f9a27f5c5..c0e436528c7 100644 --- a/specs/common/schemas/Batch.yml +++ b/specs/common/schemas/Batch.yml @@ -48,4 +48,19 @@ action: - deleteObject - delete - clear - description: Type of indexing operation. + description: | + Which indexing operation to perform: + + - `addObject`: adds records to an index. + Equivalent to the "Add a new record (with auto-generated object ID)" operation. + - `updateObject`: adds or replaces records in an index. + Equivalent to the "Add or replace a record" operation. + - `partialUpdateObject`: adds or updates attributes within records. + Equivalent to the "Add or update attributes" operation with the `createIfNoExists` parameter set to true. + (If a record with the specified `objectID` doesn't exist in the specified index, this action creates adds the record to the index) + - `partialUpdateObjectNoCreate`: same as `partialUpdateObject`, but with `createIfNoExists` set to false. + (A record isn't added to the index if its `objectID` doesn't exist) + - `deleteObject`: delete records from an index. + Equivalent to the "Delete a record" operation. + - `delete`. Delete an index. Equivalent to the "Delete an index" operation. + - `clear`: delete all records from an index. Equivalent to the "Delete all records from an index operation".