Skip to content

Commit b0a24b6

Browse files
authored
docs: use the correct link for replaceAllObjects (#5185)
1 parent 1c2222a commit b0a24b6

File tree

10 files changed

+15
-15
lines changed

10 files changed

+15
-15
lines changed

clients/algoliasearch-client-csharp/algoliasearch/Utils/SearchClientExtensions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ List<SearchForFacetValuesResponse> SearchForFacets(
230230
/// Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are untouched.
231231
/// 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.
232232
/// Finally, the temporary one replaces the existing index.
233-
/// See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
233+
/// See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
234234
/// </summary>
235235
/// <param name="indexName">The index in which to perform the request.</param>
236236
/// <param name="objects">The list of `objects` to store in the given Algolia `indexName`.</param>

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/extensions/SearchClient.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -432,7 +432,7 @@ public suspend fun SearchClient.partialUpdateObjects(
432432
* Internally, this method copies the existing index settings, synonyms and query rules and indexes all
433433
* passed objects. Finally, the temporary one replaces the existing index.
434434
*
435-
* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
435+
* See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
436436
*
437437
* @param indexName The index in which to perform the request.
438438
* @param objects The list of objects to replace.

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/extension/package.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -419,7 +419,7 @@ package object extension {
419419
* settings, synonyms and query rules and indexes all passed objects. Finally, the temporary one replaces the
420420
* existing index.
421421
*
422-
* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
422+
* See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
423423
*
424424
* @param indexName
425425
* The index in which to perform the request.

clients/algoliasearch-client-swift/Sources/Search/Extra/SearchClientExtension.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -547,7 +547,7 @@ public extension SearchClient {
547547

548548
/// Replace all objects in an index
549549
///
550-
/// See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
550+
/// See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation
551551
/// details.
552552
/// - parameter indexName: The name of the index where to replace the objects
553553
/// - parameter objects: The new objects

templates/go/search_helpers.mustache

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -601,7 +601,7 @@ func (c *APIClient) ChunkedBatch(indexName string, objects []map[string]any, act
601601

602602
/*
603603
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.
604-
See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
604+
See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
605605

606606
@param indexName string - the index name to replace objects into.
607607
@param objects []map[string]any - List of objects to replace.
@@ -695,7 +695,7 @@ func (c *APIClient) ReplaceAllObjectsWithTransformation(indexName string, object
695695

696696
/*
697697
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.
698-
See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
698+
See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
699699

700700
@param indexName string - the index name to replace objects into.
701701
@param objects []map[string]any - List of objects to replace.

templates/java/api_helpers.mustache

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1191,7 +1191,7 @@ public <T> List<BatchResponse> partialUpdateObjects(
11911191
/**
11921192
* Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are
11931193
* untouched. Replace all records in an index without any downtime. See
1194-
* https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
1194+
* https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation
11951195
* details.
11961196
*
11971197
* @param indexName The `indexName` to replace `objects` in.
@@ -1207,7 +1207,7 @@ public <T> ReplaceAllObjectsResponse replaceAllObjects(String indexName, Iterabl
12071207
/**
12081208
* Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are
12091209
* untouched. Replace all records in an index without any downtime. See
1210-
* https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
1210+
* https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation
12111211
* details.
12121212
*
12131213
* @param indexName The `indexName` to replace `objects` in.
@@ -1225,7 +1225,7 @@ public <T> ReplaceAllObjectsResponse replaceAllObjects(String indexName, Iterabl
12251225
/**
12261226
* Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are
12271227
* untouched. Replace all records in an index without any downtime. See
1228-
* https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
1228+
* https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation
12291229
* details.
12301230
*
12311231
* @param indexName The `indexName` to replace `objects` in.
@@ -1244,7 +1244,7 @@ public <T> ReplaceAllObjectsResponse replaceAllObjects(String indexName, Iterabl
12441244
/**
12451245
* Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are
12461246
* untouched. Replace all records in an index without any downtime. See
1247-
* https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
1247+
* https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation
12481248
* details.
12491249
*
12501250
* @param indexName The `indexName` to replace `objects` in.

templates/javascript/clients/client/api/helpers.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,7 @@ async partialUpdateObjects(
391391

392392
/**
393393
* 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.
394-
* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
394+
* See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
395395
*
396396
* @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.
397397
* @param replaceAllObjects - The `replaceAllObjects` object.

templates/javascript/clients/client/api/nodeHelpers.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ generateSecuredApiKey: ({
3737

3838
/**
3939
* Helper: Copies the given `sourceIndexName` records, rules and synonyms to an other Algolia application for the given `destinationIndexName`.
40-
* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
40+
* See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
4141
*
4242
* @summary Helper: Copies the given `sourceIndexName` records, rules and synonyms to an other Algolia application for the given `destinationIndexName`.
4343
* @param accountCopyIndex - The `accountCopyIndex` object.

templates/php/api.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -608,7 +608,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
608608

609609
/**
610610
* Helper: Replace all objects in an index using a temporary one.
611-
* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
611+
* See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
612612
*
613613
* @param string $indexName The `indexName` to replace `objects` in.
614614
* @param array $objects The array of `objects` to store in the given Algolia `indexName`.

templates/python/search_helpers.mustache

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,7 @@
393393
"""
394394
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.
395395
396-
See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
396+
See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
397397
"""
398398
if self._ingestion_transporter is None:
399399
raise ValueError("`region` must be provided at client instantiation before calling this method.")
@@ -466,7 +466,7 @@
466466
"""
467467
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.
468468
469-
See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
469+
See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
470470
"""
471471
tmp_index_name = self.create_temporary_name(index_name)
472472

0 commit comments

Comments
 (0)