fix(specs): Typos in API descriptions (generated)

algolia/api-clients-automation#3932 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
algolia · Oct 9, 2024 · 502ebdb · 502ebdb
1 parent 8a575ac
commit 502ebdb
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 13 deletions.
diff --git a/packages/ingestion/model/transformation.ts b/packages/ingestion/model/transformation.ts
@@ -7,7 +7,7 @@ export type Transformation = {
   transformationID: string;
 
   /**
-   * The authentications associated for the current transformation.
+   * The authentications associated with the current transformation.
    */
   authenticationIDs?: Array<string>;
 

diff --git a/packages/ingestion/model/transformationCreate.ts b/packages/ingestion/model/transformationCreate.ts
@@ -20,7 +20,7 @@ export type TransformationCreate = {
   description?: string;
 
   /**
-   * The authentications associated for the current transformation.
+   * The authentications associated with the current transformation.
    */
   authenticationIDs?: Array<string>;
 };
diff --git a/packages/ingestion/src/ingestionClient.ts b/packages/ingestion/src/ingestionClient.ts
@@ -1268,7 +1268,7 @@ export function createIngestionClient({
     },
 
     /**
-     * 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

diff --git a/packages/monitoring/model/clientMethodProps.ts b/packages/monitoring/model/clientMethodProps.ts
@@ -72,7 +72,7 @@ export type CustomPutProps = {
  */
 export type GetClusterIncidentsProps = {
   /**
-   * Subset of clusters, separated by comma.
+   * Subset of clusters, separated by commas.
    */
   clusters: string;
 };
@@ -82,7 +82,7 @@ export type GetClusterIncidentsProps = {
  */
 export type GetClusterStatusProps = {
   /**
-   * Subset of clusters, separated by comma.
+   * Subset of clusters, separated by commas.
    */
   clusters: string;
 };
@@ -92,7 +92,7 @@ export type GetClusterStatusProps = {
  */
 export type GetIndexingTimeProps = {
   /**
-   * Subset of clusters, separated by comma.
+   * Subset of clusters, separated by commas.
    */
   clusters: string;
 };
@@ -102,7 +102,7 @@ export type GetIndexingTimeProps = {
  */
 export type GetLatencyProps = {
   /**
-   * Subset of clusters, separated by comma.
+   * Subset of clusters, separated by commas.
    */
   clusters: string;
 };
@@ -126,7 +126,7 @@ export type GetMetricsProps = {
  */
 export type GetReachabilityProps = {
   /**
-   * Subset of clusters, separated by comma.
+   * Subset of clusters, separated by commas.
    */
   clusters: string;
 };
diff --git a/packages/monitoring/src/monitoringClient.ts b/packages/monitoring/src/monitoringClient.ts
@@ -231,7 +231,7 @@ export function createMonitoringClient({
     /**
      * Retrieves known incidents for the selected clusters.
      * @param getClusterIncidents - The getClusterIncidents object.
-     * @param getClusterIncidents.clusters - Subset of clusters, separated by comma.
+     * @param getClusterIncidents.clusters - Subset of clusters, separated by commas.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getClusterIncidents(
@@ -259,7 +259,7 @@ export function createMonitoringClient({
     /**
      * Retrieves the status of selected clusters.
      * @param getClusterStatus - The getClusterStatus object.
-     * @param getClusterStatus.clusters - Subset of clusters, separated by comma.
+     * @param getClusterStatus.clusters - Subset of clusters, separated by commas.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getClusterStatus({ clusters }: GetClusterStatusProps, requestOptions?: RequestOptions): Promise<StatusResponse> {
@@ -303,7 +303,7 @@ export function createMonitoringClient({
     /**
      * Retrieves average times for indexing operations for selected clusters.
      * @param getIndexingTime - The getIndexingTime object.
-     * @param getIndexingTime.clusters - Subset of clusters, separated by comma.
+     * @param getIndexingTime.clusters - Subset of clusters, separated by commas.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getIndexingTime(
@@ -331,7 +331,7 @@ export function createMonitoringClient({
     /**
      * Retrieves the average latency for search requests for selected clusters.
      * @param getLatency - The getLatency object.
-     * @param getLatency.clusters - Subset of clusters, separated by comma.
+     * @param getLatency.clusters - Subset of clusters, separated by commas.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getLatency({ clusters }: GetLatencyProps, requestOptions?: RequestOptions): Promise<LatencyResponse> {
@@ -388,7 +388,7 @@ export function createMonitoringClient({
     /**
      * Test whether clusters are reachable or not.
      * @param getReachability - The getReachability object.
-     * @param getReachability.clusters - Subset of clusters, separated by comma.
+     * @param getReachability.clusters - Subset of clusters, separated by commas.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getReachability(