Skip to content

Commit f321fc6

Browse files
committed
fix(specs): Typos in API descriptions (generated)
algolia/api-clients-automation#3932 Co-authored-by: algolia-bot <[email protected]>
1 parent 55b53b1 commit f321fc6

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

lib/Api/IngestionClient.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ public function createTaskV1($taskCreate, $requestOptions = [])
317317
* - $transformationCreate['code'] => (string) The source code of the transformation. (required)
318318
* - $transformationCreate['name'] => (string) The uniquely identified name of your transformation. (required)
319319
* - $transformationCreate['description'] => (string) A descriptive name for your transformation of what it does.
320-
* - $transformationCreate['authenticationIDs'] => (array) The authentications associated for the current transformation.
320+
* - $transformationCreate['authenticationIDs'] => (array) The authentications associated with the current transformation.
321321
*
322322
* @see TransformationCreate
323323
*
@@ -1352,7 +1352,7 @@ public function listDestinations($itemsPerPage = null, $page = null, $type = nul
13521352
}
13531353

13541354
/**
1355-
* Retrieves a list of events for a task run, identified by it's ID.
1355+
* Retrieves a list of events for a task run, identified by its ID.
13561356
*
13571357
* Required API Key ACLs:
13581358
* - addObject
@@ -2592,7 +2592,7 @@ public function updateTaskV1($taskID, $taskUpdate, $requestOptions = [])
25922592
* - $transformationCreate['code'] => (string) The source code of the transformation. (required)
25932593
* - $transformationCreate['name'] => (string) The uniquely identified name of your transformation. (required)
25942594
* - $transformationCreate['description'] => (string) A descriptive name for your transformation of what it does.
2595-
* - $transformationCreate['authenticationIDs'] => (array) The authentications associated for the current transformation.
2595+
* - $transformationCreate['authenticationIDs'] => (array) The authentications associated with the current transformation.
25962596
*
25972597
* @see TransformationCreate
25982598
*

lib/Api/MonitoringClient.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ public function customPut($path, $parameters = null, $body = null, $requestOptio
264264
/**
265265
* Retrieves known incidents for the selected clusters.
266266
*
267-
* @param string $clusters Subset of clusters, separated by comma. (required)
267+
* @param string $clusters Subset of clusters, separated by commas. (required)
268268
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
269269
*
270270
* @return \Algolia\AlgoliaSearch\Model\Monitoring\IncidentsResponse|array<string, mixed>
@@ -298,7 +298,7 @@ public function getClusterIncidents($clusters, $requestOptions = [])
298298
/**
299299
* Retrieves the status of selected clusters.
300300
*
301-
* @param string $clusters Subset of clusters, separated by comma. (required)
301+
* @param string $clusters Subset of clusters, separated by commas. (required)
302302
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
303303
*
304304
* @return \Algolia\AlgoliaSearch\Model\Monitoring\StatusResponse|array<string, mixed>
@@ -349,7 +349,7 @@ public function getIncidents($requestOptions = [])
349349
/**
350350
* Retrieves average times for indexing operations for selected clusters.
351351
*
352-
* @param string $clusters Subset of clusters, separated by comma. (required)
352+
* @param string $clusters Subset of clusters, separated by commas. (required)
353353
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
354354
*
355355
* @return \Algolia\AlgoliaSearch\Model\Monitoring\IndexingTimeResponse|array<string, mixed>
@@ -383,7 +383,7 @@ public function getIndexingTime($clusters, $requestOptions = [])
383383
/**
384384
* Retrieves the average latency for search requests for selected clusters.
385385
*
386-
* @param string $clusters Subset of clusters, separated by comma. (required)
386+
* @param string $clusters Subset of clusters, separated by commas. (required)
387387
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
388388
*
389389
* @return \Algolia\AlgoliaSearch\Model\Monitoring\LatencyResponse|array<string, mixed>
@@ -467,7 +467,7 @@ public function getMetrics($metric, $period, $requestOptions = [])
467467
/**
468468
* Test whether clusters are reachable or not.
469469
*
470-
* @param string $clusters Subset of clusters, separated by comma. (required)
470+
* @param string $clusters Subset of clusters, separated by commas. (required)
471471
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
472472
*
473473
* @return array<string, mixed>|array<string,array>

lib/Model/Ingestion/Transformation.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ public function getAuthenticationIDs()
251251
/**
252252
* Sets authenticationIDs.
253253
*
254-
* @param null|string[] $authenticationIDs the authentications associated for the current transformation
254+
* @param null|string[] $authenticationIDs the authentications associated with the current transformation
255255
*
256256
* @return self
257257
*/

lib/Model/Ingestion/TransformationCreate.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ public function getAuthenticationIDs()
271271
/**
272272
* Sets authenticationIDs.
273273
*
274-
* @param null|string[] $authenticationIDs the authentications associated for the current transformation
274+
* @param null|string[] $authenticationIDs the authentications associated with the current transformation
275275
*
276276
* @return self
277277
*/

0 commit comments

Comments
 (0)