From 866d859f8a1718fcb8dce6f4361343a8c685eaf1 Mon Sep 17 00:00:00 2001 From: Kai Welke Date: Tue, 10 Dec 2024 11:33:25 +0100 Subject: [PATCH] fix(specs): different summaries for saveObject/addOrUpdate methods (#4223) --- specs/search/paths/objects/object.yml | 1 + specs/search/paths/objects/objects.yml | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/specs/search/paths/objects/object.yml b/specs/search/paths/objects/object.yml index 51c9d703fc..a615e26f3b 100644 --- a/specs/search/paths/objects/object.yml +++ b/specs/search/paths/objects/object.yml @@ -55,6 +55,7 @@ put: If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. + If you want to use auto-generated object IDs, use the [`saveObject` operation](#tag/Records/operation/saveObject). To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). parameters: diff --git a/specs/search/paths/objects/objects.yml b/specs/search/paths/objects/objects.yml index 4b5908cf80..6d9e1ceba3 100644 --- a/specs/search/paths/objects/objects.yml +++ b/specs/search/paths/objects/objects.yml @@ -5,7 +5,7 @@ post: x-acl: - addObject description: | - Adds a record to an index or replace it. + Adds a record to an index or replaces it. - If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. @@ -16,7 +16,7 @@ post: To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). - summary: Add or replace a record + summary: Add a new record (with auto-generated object ID) parameters: - $ref: '../../../common/parameters.yml#/IndexName' requestBody: