Skip to content

Commit

Permalink
fix(specs): different summaries for saveObject/addOrUpdate methods (#…
Browse files Browse the repository at this point in the history
…4223) (generated) [skip ci]

Co-authored-by: Kai Welke <kai.welke@algolia.com>
  • Loading branch information
algolia-bot and kai687 committed Dec 10, 2024
1 parent 866d859 commit de3180e
Show file tree
Hide file tree
Showing 34 changed files with 138 additions and 122 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public partial interface ISearchClient
AddApiKeyResponse AddApiKey(ApiKey apiKey, RequestOptions options = null, CancellationToken cancellationToken = default);

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

/// <summary>
/// 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)
/// 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)
/// </summary>
///
/// Required API Key ACLs:
Expand Down Expand Up @@ -1448,7 +1448,7 @@ public partial interface ISearchClient
AddApiKeyResponse RestoreApiKey(string key, RequestOptions options = null, CancellationToken cancellationToken = default);

/// <summary>
/// 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).
/// 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).
/// </summary>
///
/// Required API Key ACLs:
Expand All @@ -1464,7 +1464,7 @@ public partial interface ISearchClient
Task<SaveObjectResponse> SaveObjectAsync(string indexName, object body, RequestOptions options = null, CancellationToken cancellationToken = default);

/// <summary>
/// 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)
/// 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)
/// </summary>
///
/// Required API Key ACLs:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ final class SearchClient implements ApiClient {
);
}

/// 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).
/// 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).
///
/// Required API Key ACLs:
/// - addObject
Expand Down Expand Up @@ -1711,7 +1711,7 @@ final class SearchClient implements ApiClient {
);
}

/// 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).
/// 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).
///
/// Required API Key ACLs:
/// - addObject
Expand Down
6 changes: 4 additions & 2 deletions clients/algoliasearch-client-go/algolia/search/api_search.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -767,7 +767,7 @@ export function createSearchClient({
},

/**
* 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).
* 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).
*
* Required API Key ACLs:
* - addObject
Expand Down Expand Up @@ -2289,7 +2289,7 @@ export function createSearchClient({
},

/**
* 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).
* 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).
*
* Required API Key ACLs:
* - addObject
Expand Down
Loading

0 comments on commit de3180e

Please sign in to comment.