fix(specs): different summaries for saveObject/addOrUpdate methods (g…

…enerated) algolia/api-clients-automation#4223 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Kai Welke <[email protected]>
algolia · Dec 10, 2024 · 9d58886 · 9d58886
1 parent ec0a289
commit 9d58886
Showing 1 changed file with 24 additions and 18 deletions.
diff --git a/algoliasearch/src/main/java/com/algolia/api/SearchClient.java b/algoliasearch/src/main/java/com/algolia/api/SearchClient.java
@@ -118,9 +118,11 @@ public CompletableFuture<AddApiKeyResponse> addApiKeyAsync(@Nonnull ApiKey apiKe
 
   /**
    * If a record with the specified object ID exists, the existing record is replaced. Otherwise, a
-   * new record is added to the index. 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).
+   * 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).
    *
    * @param indexName Name of the index on which to perform the operation. (required)
    * @param objectID Unique record identifier. (required)
@@ -141,9 +143,11 @@ public UpdatedAtWithObjectIdResponse addOrUpdateObject(
 
   /**
    * If a record with the specified object ID exists, the existing record is replaced. Otherwise, a
-   * new record is added to the index. 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).
+   * 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).
    *
    * @param indexName Name of the index on which to perform the operation. (required)
    * @param objectID Unique record identifier. (required)
@@ -158,10 +162,11 @@ public UpdatedAtWithObjectIdResponse addOrUpdateObject(@Nonnull String indexName
 
   /**
    * (asynchronously) If a record with the specified object ID exists, the existing record is
-   * replaced. Otherwise, a new record is added to the index. 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).
+   * 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).
    *
    * @param indexName Name of the index on which to perform the operation. (required)
    * @param objectID Unique record identifier. (required)
@@ -193,10 +198,11 @@ public CompletableFuture<UpdatedAtWithObjectIdResponse> addOrUpdateObjectAsync(
 
   /**
    * (asynchronously) If a record with the specified object ID exists, the existing record is
-   * replaced. Otherwise, a new record is added to the index. 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).
+   * 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).
    *
    * @param indexName Name of the index on which to perform the operation. (required)
    * @param objectID Unique record identifier. (required)
@@ -4120,7 +4126,7 @@ public CompletableFuture<AddApiKeyResponse> restoreApiKeyAsync(@Nonnull String k
   }
 
   /**
-   * Adds a record to an index or replace it. - If the record doesn't have an object ID, a new
+   * 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. - If a record with the specified
    * object ID doesn't exist, a new record is added to your index. - If you add a record to an index
@@ -4143,7 +4149,7 @@ public SaveObjectResponse saveObject(@Nonnull String indexName, @Nonnull Object
   }
 
   /**
-   * Adds a record to an index or replace it. - If the record doesn't have an object ID, a new
+   * 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. - If a record with the specified
    * object ID doesn't exist, a new record is added to your index. - If you add a record to an index
@@ -4163,7 +4169,7 @@ public SaveObjectResponse saveObject(@Nonnull String indexName, @Nonnull Object
   }
 
   /**
-   * (asynchronously) Adds a record to an index or replace it. - If the record doesn't have an
+   * (asynchronously) 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. - If a record with the
    * specified object ID doesn't exist, a new record is added to your index. - If you add a record
@@ -4194,7 +4200,7 @@ public CompletableFuture<SaveObjectResponse> saveObjectAsync(
   }
 
   /**
-   * (asynchronously) Adds a record to an index or replace it. - If the record doesn't have an
+   * (asynchronously) 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. - If a record with the
    * specified object ID doesn't exist, a new record is added to your index. - If you add a record