From 7b2cc0198a1b8318d1a87bfc6d09413f9ffff95b Mon Sep 17 00:00:00 2001 From: Rob Date: Mon, 14 Jul 2025 10:07:05 +0200 Subject: [PATCH] Update api.mustache The spec for these looks correct, so I am guessing this template is the cause for the erroneous docblocks in the generated client code. --- templates/php/api.mustache | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/templates/php/api.mustache b/templates/php/api.mustache index f973dbe9b0a..a7ff22fb826 100644 --- a/templates/php/api.mustache +++ b/templates/php/api.mustache @@ -674,7 +674,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException; * @param string $indexName The `indexName` to replace `objects` in. * @param array $objects The array of `objects` to store in the given Algolia `indexName`. * @param bool $waitForTasks Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable - * @param array $batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000. + * @param int $batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000. * @param array $requestOptions Request options */ public function saveObjects($indexName, $objects, $waitForTasks = false, $batchSize = 1000, $requestOptions = []) @@ -691,7 +691,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException; * @param string $indexName the `indexName` to replace `objects` in * @param array $objects the array of `objects` to store in the given Algolia `indexName` * @param bool $waitForTasks Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable - * @param array $batchSize The size of the chunk of `objects`. The number of `push` calls will be equal to `length(objects) / batchSize`. Defaults to 1000. + * @param int $batchSize The size of the chunk of `objects`. The number of `push` calls will be equal to `length(objects) / batchSize`. Defaults to 1000. * @param array $requestOptions Request options */ public function saveObjectsWithTransformation($indexName, $objects, $waitForTasks = false, $batchSize = 1000, $requestOptions = []) @@ -709,7 +709,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException; * @param string $indexName The `indexName` to delete `objectIDs` from. * @param array $objectIDs The `objectIDs` to delete. * @param bool $waitForTasks Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable - * @param array $batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000. + * @param int $batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000. * @param array $requestOptions Request options */ public function deleteObjects($indexName, $objectIDs, $waitForTasks = false, $batchSize = 1000, $requestOptions = []) @@ -730,7 +730,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException; * @param array $objects The array of `objects` to store in the given Algolia `indexName`. * @param bool $createIfNotExists To be provided if non-existing objects are passed, otherwise, the call will fail.. * @param bool $waitForTasks Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable - * @param array $batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000. + * @param int $batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000. * @param array $requestOptions Request options */ public function partialUpdateObjects($indexName, $objects, $createIfNotExists, $waitForTasks = false, $batchSize = 1000, $requestOptions = []) { @@ -747,7 +747,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException; * @param array $objects the array of `objects` to store in the given Algolia `indexName` * @param bool $createIfNotExists To be provided if non-existing objects are passed, otherwise, the call will fail.. * @param bool $waitForTasks Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable - * @param array $batchSize The size of the chunk of `objects`. The number of `push` calls will be equal to `length(objects) / batchSize`. Defaults to 1000. + * @param int $batchSize The size of the chunk of `objects`. The number of `push` calls will be equal to `length(objects) / batchSize`. Defaults to 1000. * @param array $requestOptions Request options */ public function partialUpdateObjectsWithTransformation($indexName, $objects, $createIfNotExists, $waitForTasks = false, $batchSize = 1000, $requestOptions = []) @@ -766,7 +766,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException; * @param array $objects the array of `objects` to store in the given Algolia `indexName` * @param array $action the `batch` `action` to perform on the given array of `objects`, defaults to `addObject` * @param bool $waitForTasks whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable - * @param array $batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000. + * @param int $batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000. * @param array $requestOptions Request options */ public function chunkedBatch( @@ -892,4 +892,4 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException; ); } } -{{/operations}} \ No newline at end of file +{{/operations}}