Skip to content

Commit 502ebdb

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

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

packages/ingestion/model/transformation.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export type Transformation = {
77
transformationID: string;
88

99
/**
10-
* The authentications associated for the current transformation.
10+
* The authentications associated with the current transformation.
1111
*/
1212
authenticationIDs?: Array<string>;
1313

packages/ingestion/model/transformationCreate.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export type TransformationCreate = {
2020
description?: string;
2121

2222
/**
23-
* The authentications associated for the current transformation.
23+
* The authentications associated with the current transformation.
2424
*/
2525
authenticationIDs?: Array<string>;
2626
};

packages/ingestion/src/ingestionClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1268,7 +1268,7 @@ export function createIngestionClient({
12681268
},
12691269

12701270
/**
1271-
* Retrieves a list of events for a task run, identified by it\'s ID.
1271+
* Retrieves a list of events for a task run, identified by its ID.
12721272
*
12731273
* Required API Key ACLs:
12741274
* - addObject

packages/monitoring/model/clientMethodProps.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ export type CustomPutProps = {
7272
*/
7373
export type GetClusterIncidentsProps = {
7474
/**
75-
* Subset of clusters, separated by comma.
75+
* Subset of clusters, separated by commas.
7676
*/
7777
clusters: string;
7878
};
@@ -82,7 +82,7 @@ export type GetClusterIncidentsProps = {
8282
*/
8383
export type GetClusterStatusProps = {
8484
/**
85-
* Subset of clusters, separated by comma.
85+
* Subset of clusters, separated by commas.
8686
*/
8787
clusters: string;
8888
};
@@ -92,7 +92,7 @@ export type GetClusterStatusProps = {
9292
*/
9393
export type GetIndexingTimeProps = {
9494
/**
95-
* Subset of clusters, separated by comma.
95+
* Subset of clusters, separated by commas.
9696
*/
9797
clusters: string;
9898
};
@@ -102,7 +102,7 @@ export type GetIndexingTimeProps = {
102102
*/
103103
export type GetLatencyProps = {
104104
/**
105-
* Subset of clusters, separated by comma.
105+
* Subset of clusters, separated by commas.
106106
*/
107107
clusters: string;
108108
};
@@ -126,7 +126,7 @@ export type GetMetricsProps = {
126126
*/
127127
export type GetReachabilityProps = {
128128
/**
129-
* Subset of clusters, separated by comma.
129+
* Subset of clusters, separated by commas.
130130
*/
131131
clusters: string;
132132
};

packages/monitoring/src/monitoringClient.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ export function createMonitoringClient({
231231
/**
232232
* Retrieves known incidents for the selected clusters.
233233
* @param getClusterIncidents - The getClusterIncidents object.
234-
* @param getClusterIncidents.clusters - Subset of clusters, separated by comma.
234+
* @param getClusterIncidents.clusters - Subset of clusters, separated by commas.
235235
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
236236
*/
237237
getClusterIncidents(
@@ -259,7 +259,7 @@ export function createMonitoringClient({
259259
/**
260260
* Retrieves the status of selected clusters.
261261
* @param getClusterStatus - The getClusterStatus object.
262-
* @param getClusterStatus.clusters - Subset of clusters, separated by comma.
262+
* @param getClusterStatus.clusters - Subset of clusters, separated by commas.
263263
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
264264
*/
265265
getClusterStatus({ clusters }: GetClusterStatusProps, requestOptions?: RequestOptions): Promise<StatusResponse> {
@@ -303,7 +303,7 @@ export function createMonitoringClient({
303303
/**
304304
* Retrieves average times for indexing operations for selected clusters.
305305
* @param getIndexingTime - The getIndexingTime object.
306-
* @param getIndexingTime.clusters - Subset of clusters, separated by comma.
306+
* @param getIndexingTime.clusters - Subset of clusters, separated by commas.
307307
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
308308
*/
309309
getIndexingTime(
@@ -331,7 +331,7 @@ export function createMonitoringClient({
331331
/**
332332
* Retrieves the average latency for search requests for selected clusters.
333333
* @param getLatency - The getLatency object.
334-
* @param getLatency.clusters - Subset of clusters, separated by comma.
334+
* @param getLatency.clusters - Subset of clusters, separated by commas.
335335
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
336336
*/
337337
getLatency({ clusters }: GetLatencyProps, requestOptions?: RequestOptions): Promise<LatencyResponse> {
@@ -388,7 +388,7 @@ export function createMonitoringClient({
388388
/**
389389
* Test whether clusters are reachable or not.
390390
* @param getReachability - The getReachability object.
391-
* @param getReachability.clusters - Subset of clusters, separated by comma.
391+
* @param getReachability.clusters - Subset of clusters, separated by commas.
392392
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
393393
*/
394394
getReachability(

0 commit comments

Comments
 (0)