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 · 2d2081a · 2d2081a
1 parent ed57f10
commit 2d2081a
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 30 deletions.
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;