Skip to content

Commit

Permalink
fix(specs): Typos in API descriptions (generated)
Browse files Browse the repository at this point in the history
  • Loading branch information
algolia-bot committed Oct 9, 2024
1 parent 55b53b1 commit f321fc6
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions lib/Api/IngestionClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ public function createTaskV1($taskCreate, $requestOptions = [])
* - $transformationCreate['code'] => (string) The source code of the transformation. (required)
* - $transformationCreate['name'] => (string) The uniquely identified name of your transformation. (required)
* - $transformationCreate['description'] => (string) A descriptive name for your transformation of what it does.
* - $transformationCreate['authenticationIDs'] => (array) The authentications associated for the current transformation.
* - $transformationCreate['authenticationIDs'] => (array) The authentications associated with the current transformation.
*
* @see TransformationCreate
*
Expand Down Expand Up @@ -1352,7 +1352,7 @@ public function listDestinations($itemsPerPage = null, $page = null, $type = nul
}

/**
* Retrieves a list of events for a task run, identified by it's ID.
* Retrieves a list of events for a task run, identified by its ID.
*
* Required API Key ACLs:
* - addObject
Expand Down Expand Up @@ -2592,7 +2592,7 @@ public function updateTaskV1($taskID, $taskUpdate, $requestOptions = [])
* - $transformationCreate['code'] => (string) The source code of the transformation. (required)
* - $transformationCreate['name'] => (string) The uniquely identified name of your transformation. (required)
* - $transformationCreate['description'] => (string) A descriptive name for your transformation of what it does.
* - $transformationCreate['authenticationIDs'] => (array) The authentications associated for the current transformation.
* - $transformationCreate['authenticationIDs'] => (array) The authentications associated with the current transformation.
*
* @see TransformationCreate
*
Expand Down
10 changes: 5 additions & 5 deletions lib/Api/MonitoringClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ public function customPut($path, $parameters = null, $body = null, $requestOptio
/**
* Retrieves known incidents for the selected clusters.
*
* @param string $clusters Subset of clusters, separated by comma. (required)
* @param string $clusters Subset of clusters, separated by commas. (required)
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
*
* @return \Algolia\AlgoliaSearch\Model\Monitoring\IncidentsResponse|array<string, mixed>
Expand Down Expand Up @@ -298,7 +298,7 @@ public function getClusterIncidents($clusters, $requestOptions = [])
/**
* Retrieves the status of selected clusters.
*
* @param string $clusters Subset of clusters, separated by comma. (required)
* @param string $clusters Subset of clusters, separated by commas. (required)
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
*
* @return \Algolia\AlgoliaSearch\Model\Monitoring\StatusResponse|array<string, mixed>
Expand Down Expand Up @@ -349,7 +349,7 @@ public function getIncidents($requestOptions = [])
/**
* Retrieves average times for indexing operations for selected clusters.
*
* @param string $clusters Subset of clusters, separated by comma. (required)
* @param string $clusters Subset of clusters, separated by commas. (required)
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
*
* @return \Algolia\AlgoliaSearch\Model\Monitoring\IndexingTimeResponse|array<string, mixed>
Expand Down Expand Up @@ -383,7 +383,7 @@ public function getIndexingTime($clusters, $requestOptions = [])
/**
* Retrieves the average latency for search requests for selected clusters.
*
* @param string $clusters Subset of clusters, separated by comma. (required)
* @param string $clusters Subset of clusters, separated by commas. (required)
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
*
* @return \Algolia\AlgoliaSearch\Model\Monitoring\LatencyResponse|array<string, mixed>
Expand Down Expand Up @@ -467,7 +467,7 @@ public function getMetrics($metric, $period, $requestOptions = [])
/**
* Test whether clusters are reachable or not.
*
* @param string $clusters Subset of clusters, separated by comma. (required)
* @param string $clusters Subset of clusters, separated by commas. (required)
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
*
* @return array<string, mixed>|array<string,array>
Expand Down
2 changes: 1 addition & 1 deletion lib/Model/Ingestion/Transformation.php
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ public function getAuthenticationIDs()
/**
* Sets authenticationIDs.
*
* @param null|string[] $authenticationIDs the authentications associated for the current transformation
* @param null|string[] $authenticationIDs the authentications associated with the current transformation
*
* @return self
*/
Expand Down
2 changes: 1 addition & 1 deletion lib/Model/Ingestion/TransformationCreate.php
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ public function getAuthenticationIDs()
/**
* Sets authenticationIDs.
*
* @param null|string[] $authenticationIDs the authentications associated for the current transformation
* @param null|string[] $authenticationIDs the authentications associated with the current transformation
*
* @return self
*/
Expand Down

0 comments on commit f321fc6

Please sign in to comment.