Skip to content

Commit de3180e

Browse files
algolia-botkai687
andcommitted
fix(specs): different summaries for saveObject/addOrUpdate methods (#4223) (generated) [skip ci]
Co-authored-by: Kai Welke <[email protected]>
1 parent 866d859 commit de3180e

File tree

34 files changed

+138
-122
lines changed

34 files changed

+138
-122
lines changed

clients/algoliasearch-client-csharp/algoliasearch/Clients/SearchClient.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public partial interface ISearchClient
5252
AddApiKeyResponse AddApiKey(ApiKey apiKey, RequestOptions options = null, CancellationToken cancellationToken = default);
5353

5454
/// <summary>
55-
/// 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).
55+
/// 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).
5656
/// </summary>
5757
///
5858
/// Required API Key ACLs:
@@ -69,7 +69,7 @@ public partial interface ISearchClient
6969
Task<UpdatedAtWithObjectIdResponse> AddOrUpdateObjectAsync(string indexName, string objectID, object body, RequestOptions options = null, CancellationToken cancellationToken = default);
7070

7171
/// <summary>
72-
/// 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). (Synchronous version)
72+
/// 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). (Synchronous version)
7373
/// </summary>
7474
///
7575
/// Required API Key ACLs:
@@ -1448,7 +1448,7 @@ public partial interface ISearchClient
14481448
AddApiKeyResponse RestoreApiKey(string key, RequestOptions options = null, CancellationToken cancellationToken = default);
14491449

14501450
/// <summary>
1451-
/// Adds a record to an index or replace 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 that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). 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).
1451+
/// 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 that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). 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).
14521452
/// </summary>
14531453
///
14541454
/// Required API Key ACLs:
@@ -1464,7 +1464,7 @@ public partial interface ISearchClient
14641464
Task<SaveObjectResponse> SaveObjectAsync(string indexName, object body, RequestOptions options = null, CancellationToken cancellationToken = default);
14651465

14661466
/// <summary>
1467-
/// Adds a record to an index or replace 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 that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). 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). (Synchronous version)
1467+
/// 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 that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). 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). (Synchronous version)
14681468
/// </summary>
14691469
///
14701470
/// Required API Key ACLs:

clients/algoliasearch-client-dart/packages/client_search/lib/src/api/search_client.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ final class SearchClient implements ApiClient {
128128
);
129129
}
130130

131-
/// 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).
131+
/// 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).
132132
///
133133
/// Required API Key ACLs:
134134
/// - addObject
@@ -1711,7 +1711,7 @@ final class SearchClient implements ApiClient {
17111711
);
17121712
}
17131713

1714-
/// Adds a record to an index or replace 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 that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). 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).
1714+
/// 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 that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). 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).
17151715
///
17161716
/// Required API Key ACLs:
17171717
/// - addObject

clients/algoliasearch-client-go/algolia/search/api_search.go

Lines changed: 4 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/SearchClient.java

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,11 @@ public CompletableFuture<AddApiKeyResponse> addApiKeyAsync(@Nonnull ApiKey apiKe
118118

119119
/**
120120
* If a record with the specified object ID exists, the existing record is replaced. Otherwise, a
121-
* new record is added to the index. To update _some_ attributes of an existing record, use the
122-
* [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or
123-
* replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
121+
* new record is added to the index. If you want to use auto-generated object IDs, use the
122+
* [`saveObject` operation](#tag/Records/operation/saveObject). To update _some_ attributes of an
123+
* existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject)
124+
* instead. To add, update, or replace multiple records, use the [`batch`
125+
* operation](#tag/Records/operation/batch).
124126
*
125127
* @param indexName Name of the index on which to perform the operation. (required)
126128
* @param objectID Unique record identifier. (required)
@@ -141,9 +143,11 @@ public UpdatedAtWithObjectIdResponse addOrUpdateObject(
141143

142144
/**
143145
* If a record with the specified object ID exists, the existing record is replaced. Otherwise, a
144-
* new record is added to the index. To update _some_ attributes of an existing record, use the
145-
* [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or
146-
* replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
146+
* new record is added to the index. If you want to use auto-generated object IDs, use the
147+
* [`saveObject` operation](#tag/Records/operation/saveObject). To update _some_ attributes of an
148+
* existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject)
149+
* instead. To add, update, or replace multiple records, use the [`batch`
150+
* operation](#tag/Records/operation/batch).
147151
*
148152
* @param indexName Name of the index on which to perform the operation. (required)
149153
* @param objectID Unique record identifier. (required)
@@ -158,10 +162,11 @@ public UpdatedAtWithObjectIdResponse addOrUpdateObject(@Nonnull String indexName
158162

159163
/**
160164
* (asynchronously) If a record with the specified object ID exists, the existing record is
161-
* replaced. Otherwise, a new record is added to the index. To update _some_ attributes of an
162-
* existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject)
163-
* instead. To add, update, or replace multiple records, use the [`batch`
164-
* operation](#tag/Records/operation/batch).
165+
* replaced. Otherwise, a new record is added to the index. If you want to use auto-generated
166+
* object IDs, use the [`saveObject` operation](#tag/Records/operation/saveObject). To update
167+
* _some_ attributes of an existing record, use the [`partial`
168+
* operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace
169+
* multiple records, use the [`batch` operation](#tag/Records/operation/batch).
165170
*
166171
* @param indexName Name of the index on which to perform the operation. (required)
167172
* @param objectID Unique record identifier. (required)
@@ -193,10 +198,11 @@ public CompletableFuture<UpdatedAtWithObjectIdResponse> addOrUpdateObjectAsync(
193198

194199
/**
195200
* (asynchronously) If a record with the specified object ID exists, the existing record is
196-
* replaced. Otherwise, a new record is added to the index. To update _some_ attributes of an
197-
* existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject)
198-
* instead. To add, update, or replace multiple records, use the [`batch`
199-
* operation](#tag/Records/operation/batch).
201+
* replaced. Otherwise, a new record is added to the index. If you want to use auto-generated
202+
* object IDs, use the [`saveObject` operation](#tag/Records/operation/saveObject). To update
203+
* _some_ attributes of an existing record, use the [`partial`
204+
* operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace
205+
* multiple records, use the [`batch` operation](#tag/Records/operation/batch).
200206
*
201207
* @param indexName Name of the index on which to perform the operation. (required)
202208
* @param objectID Unique record identifier. (required)
@@ -4120,7 +4126,7 @@ public CompletableFuture<AddApiKeyResponse> restoreApiKeyAsync(@Nonnull String k
41204126
}
41214127

41224128
/**
4123-
* Adds a record to an index or replace it. - If the record doesn't have an object ID, a new
4129+
* Adds a record to an index or replaces it. - If the record doesn't have an object ID, a new
41244130
* record with an auto-generated object ID is added to your index. - If a record with the
41254131
* specified object ID exists, the existing record is replaced. - If a record with the specified
41264132
* 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
41434149
}
41444150

41454151
/**
4146-
* Adds a record to an index or replace it. - If the record doesn't have an object ID, a new
4152+
* Adds a record to an index or replaces it. - If the record doesn't have an object ID, a new
41474153
* record with an auto-generated object ID is added to your index. - If a record with the
41484154
* specified object ID exists, the existing record is replaced. - If a record with the specified
41494155
* 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
41634169
}
41644170

41654171
/**
4166-
* (asynchronously) Adds a record to an index or replace it. - If the record doesn't have an
4172+
* (asynchronously) Adds a record to an index or replaces it. - If the record doesn't have an
41674173
* object ID, a new record with an auto-generated object ID is added to your index. - If a record
41684174
* with the specified object ID exists, the existing record is replaced. - If a record with the
41694175
* 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(
41944200
}
41954201

41964202
/**
4197-
* (asynchronously) Adds a record to an index or replace it. - If the record doesn't have an
4203+
* (asynchronously) Adds a record to an index or replaces it. - If the record doesn't have an
41984204
* object ID, a new record with an auto-generated object ID is added to your index. - If a record
41994205
* with the specified object ID exists, the existing record is replaced. - If a record with the
42004206
* specified object ID doesn't exist, a new record is added to your index. - If you add a record

clients/algoliasearch-client-javascript/packages/client-search/src/searchClient.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -767,7 +767,7 @@ export function createSearchClient({
767767
},
768768

769769
/**
770-
* 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).
770+
* 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).
771771
*
772772
* Required API Key ACLs:
773773
* - addObject
@@ -2289,7 +2289,7 @@ export function createSearchClient({
22892289
},
22902290

22912291
/**
2292-
* Adds a record to an index or replace 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 that doesn\'t exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). 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).
2292+
* 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 that doesn\'t exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). 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).
22932293
*
22942294
* Required API Key ACLs:
22952295
* - addObject

0 commit comments

Comments
 (0)