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

algolia-bot · algolia-bot · commit 2d2081ae55be · 2024-10-09T16:39:50.000Z
algolia/api-clients-automation#3932 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
diff --git a/algoliasearch/src/main/java/com/algolia/api/IngestionClient.java b/algoliasearch/src/main/java/com/algolia/api/IngestionClient.java
@@ -1987,7 +1987,7 @@ public CompletableFuture<ListDestinationsResponse> listDestinationsAsync() throw
   }
 
   /**
-   * 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.
    *
    * @param runID Unique identifier of a task run. (required)
    * @param itemsPerPage Number of items per page. (optional, default to 10)
@@ -2022,7 +2022,7 @@ public ListEventsResponse listEvents(
   }
 
   /**
-   * 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.
    *
    * @param runID Unique identifier of a task run. (required)
    * @param itemsPerPage Number of items per page. (optional, default to 10)
@@ -2052,7 +2052,7 @@ public ListEventsResponse listEvents(
   }
 
   /**
-   * 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.
    *
    * @param runID Unique identifier of a task run. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
@@ -2064,7 +2064,7 @@ public ListEventsResponse listEvents(@Nonnull String runID, RequestOptions reque
   }
 
   /**
-   * 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.
    *
    * @param runID Unique identifier of a task run. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
@@ -2074,7 +2074,7 @@ public ListEventsResponse listEvents(@Nonnull String runID) throws AlgoliaRuntim
   }
 
   /**
-   * (asynchronously) Retrieves a list of events for a task run, identified by it's ID.
+   * (asynchronously) Retrieves a list of events for a task run, identified by its ID.
    *
    * @param runID Unique identifier of a task run. (required)
    * @param itemsPerPage Number of items per page. (optional, default to 10)
@@ -2121,7 +2121,7 @@ public CompletableFuture<ListEventsResponse> listEventsAsync(
   }
 
   /**
-   * (asynchronously) Retrieves a list of events for a task run, identified by it's ID.
+   * (asynchronously) Retrieves a list of events for a task run, identified by its ID.
    *
    * @param runID Unique identifier of a task run. (required)
    * @param itemsPerPage Number of items per page. (optional, default to 10)
@@ -2151,7 +2151,7 @@ public CompletableFuture<ListEventsResponse> listEventsAsync(
   }
 
   /**
-   * (asynchronously) Retrieves a list of events for a task run, identified by it's ID.
+   * (asynchronously) Retrieves a list of events for a task run, identified by its ID.
    *
    * @param runID Unique identifier of a task run. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
@@ -2164,7 +2164,7 @@ public CompletableFuture<ListEventsResponse> listEventsAsync(@Nonnull String run
   }
 
   /**
-   * (asynchronously) Retrieves a list of events for a task run, identified by it's ID.
+   * (asynchronously) Retrieves a list of events for a task run, identified by its ID.
    *
    * @param runID Unique identifier of a task run. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
diff --git a/algoliasearch/src/main/java/com/algolia/api/MonitoringClient.java b/algoliasearch/src/main/java/com/algolia/api/MonitoringClient.java
@@ -452,7 +452,7 @@ public CompletableFuture<Object> customPutAsync(@Nonnull String path) throws Alg
   /**
    * Retrieves known incidents for the selected clusters.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
@@ -464,7 +464,7 @@ public IncidentsResponse getClusterIncidents(@Nonnull String clusters, RequestOp
   /**
    * Retrieves known incidents for the selected clusters.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public IncidentsResponse getClusterIncidents(@Nonnull String clusters) throws AlgoliaRuntimeException {
@@ -474,7 +474,7 @@ public IncidentsResponse getClusterIncidents(@Nonnull String clusters) throws Al
   /**
    * (asynchronously) Retrieves known incidents for the selected clusters.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
@@ -491,7 +491,7 @@ public CompletableFuture<IncidentsResponse> getClusterIncidentsAsync(@Nonnull St
   /**
    * (asynchronously) Retrieves known incidents for the selected clusters.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public CompletableFuture<IncidentsResponse> getClusterIncidentsAsync(@Nonnull String clusters) throws AlgoliaRuntimeException {
@@ -501,7 +501,7 @@ public CompletableFuture<IncidentsResponse> getClusterIncidentsAsync(@Nonnull St
   /**
    * Retrieves the status of selected clusters.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
@@ -513,7 +513,7 @@ public StatusResponse getClusterStatus(@Nonnull String clusters, RequestOptions
   /**
    * Retrieves the status of selected clusters.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public StatusResponse getClusterStatus(@Nonnull String clusters) throws AlgoliaRuntimeException {
@@ -523,7 +523,7 @@ public StatusResponse getClusterStatus(@Nonnull String clusters) throws AlgoliaR
   /**
    * (asynchronously) Retrieves the status of selected clusters.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
@@ -540,7 +540,7 @@ public CompletableFuture<StatusResponse> getClusterStatusAsync(@Nonnull String c
   /**
    * (asynchronously) Retrieves the status of selected clusters.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public CompletableFuture<StatusResponse> getClusterStatusAsync(@Nonnull String clusters) throws AlgoliaRuntimeException {
@@ -592,7 +592,7 @@ public CompletableFuture<IncidentsResponse> getIncidentsAsync() throws AlgoliaRu
   /**
    * Retrieves average times for indexing operations for selected clusters.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
@@ -604,7 +604,7 @@ public IndexingTimeResponse getIndexingTime(@Nonnull String clusters, RequestOpt
   /**
    * Retrieves average times for indexing operations for selected clusters.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public IndexingTimeResponse getIndexingTime(@Nonnull String clusters) throws AlgoliaRuntimeException {
@@ -614,7 +614,7 @@ public IndexingTimeResponse getIndexingTime(@Nonnull String clusters) throws Alg
   /**
    * (asynchronously) Retrieves average times for indexing operations for selected clusters.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
@@ -631,7 +631,7 @@ public CompletableFuture<IndexingTimeResponse> getIndexingTimeAsync(@Nonnull Str
   /**
    * (asynchronously) Retrieves average times for indexing operations for selected clusters.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public CompletableFuture<IndexingTimeResponse> getIndexingTimeAsync(@Nonnull String clusters) throws AlgoliaRuntimeException {
@@ -641,7 +641,7 @@ public CompletableFuture<IndexingTimeResponse> getIndexingTimeAsync(@Nonnull Str
   /**
    * Retrieves the average latency for search requests for selected clusters.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
@@ -653,7 +653,7 @@ public LatencyResponse getLatency(@Nonnull String clusters, RequestOptions reque
   /**
    * Retrieves the average latency for search requests for selected clusters.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public LatencyResponse getLatency(@Nonnull String clusters) throws AlgoliaRuntimeException {
@@ -663,7 +663,7 @@ public LatencyResponse getLatency(@Nonnull String clusters) throws AlgoliaRuntim
   /**
    * (asynchronously) Retrieves the average latency for search requests for selected clusters.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
@@ -680,7 +680,7 @@ public CompletableFuture<LatencyResponse> getLatencyAsync(@Nonnull String cluste
   /**
    * (asynchronously) Retrieves the average latency for search requests for selected clusters.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public CompletableFuture<LatencyResponse> getLatencyAsync(@Nonnull String clusters) throws AlgoliaRuntimeException {
@@ -784,7 +784,7 @@ public CompletableFuture<InfrastructureResponse> getMetricsAsync(@Nonnull Metric
   /**
    * Test whether clusters are reachable or not.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
@@ -797,7 +797,7 @@ public Map<String, Map<String, Boolean>> getReachability(@Nonnull String cluster
   /**
    * Test whether clusters are reachable or not.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public Map<String, Map<String, Boolean>> getReachability(@Nonnull String clusters) throws AlgoliaRuntimeException {
@@ -807,7 +807,7 @@ public Map<String, Map<String, Boolean>> getReachability(@Nonnull String cluster
   /**
    * (asynchronously) Test whether clusters are reachable or not.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
@@ -823,7 +823,7 @@ public CompletableFuture<Map<String, Map<String, Boolean>>> getReachabilityAsync
   /**
    * (asynchronously) Test whether clusters are reachable or not.
    *
-   * @param clusters Subset of clusters, separated by comma. (required)
+   * @param clusters Subset of clusters, separated by commas. (required)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public CompletableFuture<Map<String, Map<String, Boolean>>> getReachabilityAsync(@Nonnull String clusters)
diff --git a/algoliasearch/src/main/java/com/algolia/model/ingestion/Transformation.java b/algoliasearch/src/main/java/com/algolia/model/ingestion/Transformation.java
@@ -57,7 +57,7 @@ public Transformation addAuthenticationIDs(String authenticationIDsItem) {
     return this;
   }
 
-  /** The authentications associated for the current transformation. */
+  /** The authentications associated with the current transformation. */
   @javax.annotation.Nullable
   public List<String> getAuthenticationIDs() {
     return authenticationIDs;
diff --git a/algoliasearch/src/main/java/com/algolia/model/ingestion/TransformationCreate.java b/algoliasearch/src/main/java/com/algolia/model/ingestion/TransformationCreate.java
@@ -70,7 +70,7 @@ public TransformationCreate addAuthenticationIDs(String authenticationIDsItem) {
     return this;
   }
 
-  /** The authentications associated for the current transformation. */
+  /** The authentications associated with the current transformation. */
   @javax.annotation.Nullable
   public List<String> getAuthenticationIDs() {
     return authenticationIDs;

Original file line number	Diff line number	Diff line change
`@@ -1987,7 +1987,7 @@ public CompletableFuture<ListDestinationsResponse> listDestinationsAsync() throw`
`1987`	`1987`	`}`
`1988`	`1988`
`1989`	`1989`	`/**`
`1990`		`- * Retrieves a list of events for a task run, identified by it's ID.`
	`1990`	`+ * Retrieves a list of events for a task run, identified by its ID.`
`1991`	`1991`	`*`
`1992`	`1992`	`* @param runID Unique identifier of a task run. (required)`
`1993`	`1993`	`* @param itemsPerPage Number of items per page. (optional, default to 10)`
`@@ -2022,7 +2022,7 @@ public ListEventsResponse listEvents(`
`2022`	`2022`	`}`
`2023`	`2023`
`2024`	`2024`	`/**`
`2025`		`- * Retrieves a list of events for a task run, identified by it's ID.`
	`2025`	`+ * Retrieves a list of events for a task run, identified by its ID.`
`2026`	`2026`	`*`
`2027`	`2027`	`* @param runID Unique identifier of a task run. (required)`
`2028`	`2028`	`* @param itemsPerPage Number of items per page. (optional, default to 10)`
`@@ -2052,7 +2052,7 @@ public ListEventsResponse listEvents(`
`2052`	`2052`	`}`
`2053`	`2053`
`2054`	`2054`	`/**`
`2055`		`- * Retrieves a list of events for a task run, identified by it's ID.`
	`2055`	`+ * Retrieves a list of events for a task run, identified by its ID.`
`2056`	`2056`	`*`
`2057`	`2057`	`* @param runID Unique identifier of a task run. (required)`
`2058`	`2058`	`* @param requestOptions The requestOptions to send along with the query, they will be merged with`
`@@ -2064,7 +2064,7 @@ public ListEventsResponse listEvents(@Nonnull String runID, RequestOptions reque`
`2064`	`2064`	`}`
`2065`	`2065`
`2066`	`2066`	`/**`
`2067`		`- * Retrieves a list of events for a task run, identified by it's ID.`
	`2067`	`+ * Retrieves a list of events for a task run, identified by its ID.`
`2068`	`2068`	`*`
`2069`	`2069`	`* @param runID Unique identifier of a task run. (required)`
`2070`	`2070`	`* @throws AlgoliaRuntimeException If it fails to process the API call`
`@@ -2074,7 +2074,7 @@ public ListEventsResponse listEvents(@Nonnull String runID) throws AlgoliaRuntim`
`2074`	`2074`	`}`
`2075`	`2075`
`2076`	`2076`	`/**`
`2077`		`- * (asynchronously) Retrieves a list of events for a task run, identified by it's ID.`
	`2077`	`+ * (asynchronously) Retrieves a list of events for a task run, identified by its ID.`
`2078`	`2078`	`*`
`2079`	`2079`	`* @param runID Unique identifier of a task run. (required)`
`2080`	`2080`	`* @param itemsPerPage Number of items per page. (optional, default to 10)`
`@@ -2121,7 +2121,7 @@ public CompletableFuture<ListEventsResponse> listEventsAsync(`
`2121`	`2121`	`}`
`2122`	`2122`
`2123`	`2123`	`/**`
`2124`		`- * (asynchronously) Retrieves a list of events for a task run, identified by it's ID.`
	`2124`	`+ * (asynchronously) Retrieves a list of events for a task run, identified by its ID.`
`2125`	`2125`	`*`
`2126`	`2126`	`* @param runID Unique identifier of a task run. (required)`
`2127`	`2127`	`* @param itemsPerPage Number of items per page. (optional, default to 10)`
`@@ -2151,7 +2151,7 @@ public CompletableFuture<ListEventsResponse> listEventsAsync(`
`2151`	`2151`	`}`
`2152`	`2152`
`2153`	`2153`	`/**`
`2154`		`- * (asynchronously) Retrieves a list of events for a task run, identified by it's ID.`
	`2154`	`+ * (asynchronously) Retrieves a list of events for a task run, identified by its ID.`
`2155`	`2155`	`*`
`2156`	`2156`	`* @param runID Unique identifier of a task run. (required)`
`2157`	`2157`	`* @param requestOptions The requestOptions to send along with the query, they will be merged with`
`@@ -2164,7 +2164,7 @@ public CompletableFuture<ListEventsResponse> listEventsAsync(@Nonnull String run`
`2164`	`2164`	`}`
`2165`	`2165`
`2166`	`2166`	`/**`
`2167`		`- * (asynchronously) Retrieves a list of events for a task run, identified by it's ID.`
	`2167`	`+ * (asynchronously) Retrieves a list of events for a task run, identified by its ID.`
`2168`	`2168`	`*`
`2169`	`2169`	`* @param runID Unique identifier of a task run. (required)`
`2170`	`2170`	`* @throws AlgoliaRuntimeException If it fails to process the API call`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public Transformation addAuthenticationIDs(String authenticationIDsItem) {`
`57`	`57`	`return this;`
`58`	`58`	`}`
`59`	`59`
`60`		`- /** The authentications associated for the current transformation. */`
	`60`	`+ /** The authentications associated with the current transformation. */`
`61`	`61`	`@javax.annotation.Nullable`
`62`	`62`	`public List<String> getAuthenticationIDs() {`
`63`	`63`	`return authenticationIDs;`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ public TransformationCreate addAuthenticationIDs(String authenticationIDsItem) {`
`70`	`70`	`return this;`
`71`	`71`	`}`
`72`	`72`
`73`		`- /** The authentications associated for the current transformation. */`
	`73`	`+ /** The authentications associated with the current transformation. */`
`74`	`74`	`@javax.annotation.Nullable`
`75`	`75`	`public List<String> getAuthenticationIDs() {`
`76`	`76`	`return authenticationIDs;`