Skip to content

Commit

Permalink
docs: remove clients documentation (#3526) (generated) [skip ci]
Browse files Browse the repository at this point in the history
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
  • Loading branch information
algolia-bot and shortcuts committed Aug 19, 2024
1 parent aeb7b3a commit 561ea56
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 10 deletions.

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 @@ -6321,8 +6321,8 @@ public <T> List<BatchResponse> chunkedBatch(
/**
* 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/contributing/add-new-api-client#5-helpers for
* implementation details.
* https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
* details.
*
* @param indexName The `indexName` to replace `objects` in.
* @param objects The array of `objects` to store in the given Algolia `indexName`.
Expand Down Expand Up @@ -6437,8 +6437,8 @@ public <T> List<BatchResponse> 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/contributing/add-new-api-client#5-helpers for
* implementation details.
* https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
* details.
*
* @param indexName The `indexName` to replace `objects` in.
* @param objects The array of `objects` to store in the given Algolia `indexName`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -657,7 +657,7 @@ export function createSearchClient({

/**
* 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/contributing/add-new-api-client#5-helpers for implementation details.
* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers 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.
Expand Down
2 changes: 1 addition & 1 deletion clients/algoliasearch-client-php/lib/Api/SearchClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -2895,7 +2895,7 @@ public function browseSynonyms($indexName, $requestOptions = [])

/**
* Helper: Replace all objects in an index using a temporary one.
* See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers 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`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -535,7 +535,7 @@ async def replace_all_objects(
"""
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/contributing/add-new-api-client#5-helpers for implementation details.
See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
"""
tmp_index_name = self.create_temporary_name(index_name)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -326,8 +326,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/add-new-api-client#5-helpers for implementation details.
*
* @param indexName
* The index in which to perform the request.
Expand Down

0 comments on commit 561ea56

Please sign in to comment.