From be55c0c6c9b12caa37e9e19ccf0d666ae2fe2470 Mon Sep 17 00:00:00 2001 From: Pierre Millot Date: Wed, 30 Jul 2025 10:54:00 +0200 Subject: [PATCH 1/2] docs: use the correct link for replaceAllObjects --- .../algoliasearch/Utils/SearchClientExtensions.cs | 2 +- .../com/algolia/client/extensions/SearchClient.kt | 2 +- .../main/scala/algoliasearch/extension/package.scala | 2 +- .../Sources/Search/Extra/SearchClientExtension.swift | 2 +- templates/go/search_helpers.mustache | 6 +++--- templates/java/api_helpers.mustache | 10 +++++----- .../javascript/clients/client/api/helpers.mustache | 4 ++-- .../javascript/clients/client/api/nodeHelpers.mustache | 4 ++-- templates/php/api.mustache | 4 ++-- templates/python/search_helpers.mustache | 6 +++--- 10 files changed, 21 insertions(+), 21 deletions(-) diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Utils/SearchClientExtensions.cs b/clients/algoliasearch-client-csharp/algoliasearch/Utils/SearchClientExtensions.cs index c110137594d..8ad6ba4468f 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Utils/SearchClientExtensions.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Utils/SearchClientExtensions.cs @@ -230,7 +230,7 @@ List SearchForFacets( /// Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are untouched. /// Replace all objects in an index without any downtime. Internally, this method copies the existing index settings, synonyms and query rules and indexes all passed objects. /// Finally, the temporary one replaces the existing index. - /// See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details. + /// See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details. /// /// The index in which to perform the request. /// The list of `objects` to store in the given Algolia `indexName`. diff --git a/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/extensions/SearchClient.kt b/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/extensions/SearchClient.kt index 14810031bf4..b1dc24f08a8 100644 --- a/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/extensions/SearchClient.kt +++ b/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/extensions/SearchClient.kt @@ -432,7 +432,7 @@ public suspend fun SearchClient.partialUpdateObjects( * Internally, this method copies the existing index settings, synonyms and query rules and indexes all * passed objects. Finally, the temporary one replaces the existing index. * - * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details. + * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details. * * @param indexName The index in which to perform the request. * @param objects The list of objects to replace. diff --git a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/extension/package.scala b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/extension/package.scala index 3b6165526b4..5fd6768c3b1 100644 --- a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/extension/package.scala +++ b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/extension/package.scala @@ -419,7 +419,7 @@ package object extension { * settings, synonyms and query rules and indexes all passed objects. Finally, the temporary one replaces the * existing index. * - * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details. + * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details. * * @param indexName * The index in which to perform the request. diff --git a/clients/algoliasearch-client-swift/Sources/Search/Extra/SearchClientExtension.swift b/clients/algoliasearch-client-swift/Sources/Search/Extra/SearchClientExtension.swift index 097069bfd84..78a4a3b5a3a 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Extra/SearchClientExtension.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Extra/SearchClientExtension.swift @@ -547,7 +547,7 @@ public extension SearchClient { /// Replace all objects in an index /// - /// See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation + /// See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation /// details. /// - parameter indexName: The name of the index where to replace the objects /// - parameter objects: The new objects diff --git a/templates/go/search_helpers.mustache b/templates/go/search_helpers.mustache index 988aed65412..fb801d0cd82 100644 --- a/templates/go/search_helpers.mustache +++ b/templates/go/search_helpers.mustache @@ -601,7 +601,7 @@ func (c *APIClient) ChunkedBatch(indexName string, objects []map[string]any, act /* ReplaceAllObjectsWithTransformation is similar to the `replaceAllObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method. -See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details. +See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details. @param indexName string - the index name to replace objects into. @param objects []map[string]any - List of objects to replace. @@ -695,7 +695,7 @@ func (c *APIClient) ReplaceAllObjectsWithTransformation(indexName string, object /* ReplaceAllObjects replaces all objects (records) in the given `indexName` with the given `objects`. A temporary index is created during this process in order to backup your data. -See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details. +See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details. @param indexName string - the index name to replace objects into. @param objects []map[string]any - List of objects to replace. @@ -837,4 +837,4 @@ func (c *APIClient) PartialUpdateObjectsWithTransformation(indexName string, obj } return c.ingestionTransporter.ChunkedPush(indexName, objects, ingestion.Action(action), nil, toIngestionChunkedBatchOptions(partialUpdateObjectsToChunkedBatchOptions(opts))...) //nolint:wrapcheck -} \ No newline at end of file +} diff --git a/templates/java/api_helpers.mustache b/templates/java/api_helpers.mustache index e79dbba6e64..5e6483f74be 100644 --- a/templates/java/api_helpers.mustache +++ b/templates/java/api_helpers.mustache @@ -1191,7 +1191,7 @@ public List partialUpdateObjects( /** * Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are * untouched. Replace all records in an index without any downtime. See - * https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation + * https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation * details. * * @param indexName The `indexName` to replace `objects` in. @@ -1207,7 +1207,7 @@ public ReplaceAllObjectsResponse replaceAllObjects(String indexName, Iterabl /** * Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are * untouched. Replace all records in an index without any downtime. See - * https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation + * https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation * details. * * @param indexName The `indexName` to replace `objects` in. @@ -1225,7 +1225,7 @@ public ReplaceAllObjectsResponse replaceAllObjects(String indexName, Iterabl /** * Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are * untouched. Replace all records in an index without any downtime. See - * https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation + * https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation * details. * * @param indexName The `indexName` to replace `objects` in. @@ -1244,7 +1244,7 @@ public ReplaceAllObjectsResponse replaceAllObjects(String indexName, Iterabl /** * Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are * untouched. Replace all records in an index without any downtime. See - * https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation + * https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation * details. * * @param indexName The `indexName` to replace `objects` in. @@ -1582,4 +1582,4 @@ public boolean indexExists(String indexName) { } return true; } -{{/isSearchClient}} \ No newline at end of file +{{/isSearchClient}} diff --git a/templates/javascript/clients/client/api/helpers.mustache b/templates/javascript/clients/client/api/helpers.mustache index eb781bc99c0..13f659412a2 100644 --- a/templates/javascript/clients/client/api/helpers.mustache +++ b/templates/javascript/clients/client/api/helpers.mustache @@ -391,7 +391,7 @@ async partialUpdateObjects( /** * Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data. - * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details. + * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details. * * @summary Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data. * @param replaceAllObjects - The `replaceAllObjects` object. @@ -513,4 +513,4 @@ searchForFacets( requestOptions?: RequestOptions | undefined ): Promise<{results: Array}> { return this.search(searchMethodParams, requestOptions) as Promise<{results: Array}>; -}, \ No newline at end of file +}, diff --git a/templates/javascript/clients/client/api/nodeHelpers.mustache b/templates/javascript/clients/client/api/nodeHelpers.mustache index 146eecd1e3d..4c4030c1fb1 100644 --- a/templates/javascript/clients/client/api/nodeHelpers.mustache +++ b/templates/javascript/clients/client/api/nodeHelpers.mustache @@ -37,7 +37,7 @@ generateSecuredApiKey: ({ /** * Helper: Copies the given `sourceIndexName` records, rules and synonyms to an other Algolia application for the given `destinationIndexName`. - * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details. + * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details. * * @summary Helper: Copies the given `sourceIndexName` records, rules and synonyms to an other Algolia application for the given `destinationIndexName`. * @param accountCopyIndex - The `accountCopyIndex` object. @@ -133,4 +133,4 @@ async accountCopyIndex( for (const response of responses) { await destinationClient.waitForTask({ indexName: destinationIndexName, taskID: response.taskID }); } -}, \ No newline at end of file +}, diff --git a/templates/php/api.mustache b/templates/php/api.mustache index ef85c064f57..f084ca1e490 100644 --- a/templates/php/api.mustache +++ b/templates/php/api.mustache @@ -608,7 +608,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException; /** * Helper: Replace all objects in an index using a temporary one. - * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details. + * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details. * * @param string $indexName The `indexName` to replace `objects` in. * @param array $objects The array of `objects` to store in the given Algolia `indexName`. @@ -893,4 +893,4 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException; ); } } -{{/operations}} \ No newline at end of file +{{/operations}} diff --git a/templates/python/search_helpers.mustache b/templates/python/search_helpers.mustache index 635f0caaf4b..dbdc9d5e5c4 100644 --- a/templates/python/search_helpers.mustache +++ b/templates/python/search_helpers.mustache @@ -393,7 +393,7 @@ """ Helper: Similar to the `replaceAllObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method. - See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details. + See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details. """ if self._ingestion_transporter is None: raise ValueError("`region` must be provided at client instantiation before calling this method.") @@ -466,7 +466,7 @@ """ Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data. - See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details. + See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details. """ tmp_index_name = self.create_temporary_name(index_name) @@ -534,4 +534,4 @@ return False raise e - return True \ No newline at end of file + return True From 7ea00a34eb00f10d556349d0c89edb20f6b1bf5c Mon Sep 17 00:00:00 2001 From: Pierre Millot Date: Wed, 30 Jul 2025 10:57:16 +0200 Subject: [PATCH 2/2] new line --- templates/go/search_helpers.mustache | 2 +- templates/java/api_helpers.mustache | 2 +- templates/javascript/clients/client/api/helpers.mustache | 2 +- templates/javascript/clients/client/api/nodeHelpers.mustache | 2 +- templates/php/api.mustache | 2 +- templates/python/search_helpers.mustache | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/templates/go/search_helpers.mustache b/templates/go/search_helpers.mustache index fb801d0cd82..200a3ff5f96 100644 --- a/templates/go/search_helpers.mustache +++ b/templates/go/search_helpers.mustache @@ -837,4 +837,4 @@ func (c *APIClient) PartialUpdateObjectsWithTransformation(indexName string, obj } return c.ingestionTransporter.ChunkedPush(indexName, objects, ingestion.Action(action), nil, toIngestionChunkedBatchOptions(partialUpdateObjectsToChunkedBatchOptions(opts))...) //nolint:wrapcheck -} +} \ No newline at end of file diff --git a/templates/java/api_helpers.mustache b/templates/java/api_helpers.mustache index 5e6483f74be..cc970d3293d 100644 --- a/templates/java/api_helpers.mustache +++ b/templates/java/api_helpers.mustache @@ -1582,4 +1582,4 @@ public boolean indexExists(String indexName) { } return true; } -{{/isSearchClient}} +{{/isSearchClient}} \ No newline at end of file diff --git a/templates/javascript/clients/client/api/helpers.mustache b/templates/javascript/clients/client/api/helpers.mustache index 13f659412a2..9aef376e5c0 100644 --- a/templates/javascript/clients/client/api/helpers.mustache +++ b/templates/javascript/clients/client/api/helpers.mustache @@ -513,4 +513,4 @@ searchForFacets( requestOptions?: RequestOptions | undefined ): Promise<{results: Array}> { return this.search(searchMethodParams, requestOptions) as Promise<{results: Array}>; -}, +}, \ No newline at end of file diff --git a/templates/javascript/clients/client/api/nodeHelpers.mustache b/templates/javascript/clients/client/api/nodeHelpers.mustache index 4c4030c1fb1..23545fdc444 100644 --- a/templates/javascript/clients/client/api/nodeHelpers.mustache +++ b/templates/javascript/clients/client/api/nodeHelpers.mustache @@ -133,4 +133,4 @@ async accountCopyIndex( for (const response of responses) { await destinationClient.waitForTask({ indexName: destinationIndexName, taskID: response.taskID }); } -}, +}, \ No newline at end of file diff --git a/templates/php/api.mustache b/templates/php/api.mustache index f084ca1e490..9fc271f71cb 100644 --- a/templates/php/api.mustache +++ b/templates/php/api.mustache @@ -893,4 +893,4 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException; ); } } -{{/operations}} +{{/operations}} \ No newline at end of file diff --git a/templates/python/search_helpers.mustache b/templates/python/search_helpers.mustache index dbdc9d5e5c4..1a01b4f7568 100644 --- a/templates/python/search_helpers.mustache +++ b/templates/python/search_helpers.mustache @@ -534,4 +534,4 @@ return False raise e - return True + return True \ No newline at end of file