From 50d5c8994b8559ed619992849f8001f4401331ec Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Wed, 9 Oct 2024 16:39:55 +0000 Subject: [PATCH] fix(specs): Typos in API descriptions (generated) https://github.com/algolia/api-clients-automation/pull/3932 Co-authored-by: algolia-bot --- .../kotlin/com/algolia/client/api/IngestionClient.kt | 2 +- .../kotlin/com/algolia/client/api/MonitoringClient.kt | 10 +++++----- .../algolia/client/model/ingestion/Transformation.kt | 4 ++-- .../client/model/ingestion/TransformationCreate.kt | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt b/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt index a47ad2cc..09675e22 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt @@ -687,7 +687,7 @@ public class IngestionClient( } /** - * 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/client/src/commonMain/kotlin/com/algolia/client/api/MonitoringClient.kt b/client/src/commonMain/kotlin/com/algolia/client/api/MonitoringClient.kt index 0238890d..10cc6965 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/api/MonitoringClient.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/api/MonitoringClient.kt @@ -116,7 +116,7 @@ public class MonitoringClient( /** * Retrieves known incidents for the selected clusters. - * @param clusters Subset of clusters, separated by comma. + * @param clusters Subset of clusters, separated by commas. * @param requestOptions additional request configuration. */ public suspend fun getClusterIncidents(clusters: String, requestOptions: RequestOptions? = null): IncidentsResponse { @@ -133,7 +133,7 @@ public class MonitoringClient( /** * Retrieves the status of selected clusters. - * @param clusters Subset of clusters, separated by comma. + * @param clusters Subset of clusters, separated by commas. * @param requestOptions additional request configuration. */ public suspend fun getClusterStatus(clusters: String, requestOptions: RequestOptions? = null): StatusResponse { @@ -165,7 +165,7 @@ public class MonitoringClient( /** * Retrieves average times for indexing operations for selected clusters. - * @param clusters Subset of clusters, separated by comma. + * @param clusters Subset of clusters, separated by commas. * @param requestOptions additional request configuration. */ public suspend fun getIndexingTime(clusters: String, requestOptions: RequestOptions? = null): IndexingTimeResponse { @@ -182,7 +182,7 @@ public class MonitoringClient( /** * Retrieves the average latency for search requests for selected clusters. - * @param clusters Subset of clusters, separated by comma. + * @param clusters Subset of clusters, separated by commas. * @param requestOptions additional request configuration. */ public suspend fun getLatency(clusters: String, requestOptions: RequestOptions? = null): LatencyResponse { @@ -216,7 +216,7 @@ public class MonitoringClient( /** * Test whether clusters are reachable or not. - * @param clusters Subset of clusters, separated by comma. + * @param clusters Subset of clusters, separated by commas. * @param requestOptions additional request configuration. */ public suspend fun getReachability(clusters: String, requestOptions: RequestOptions? = null): Map> { diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/Transformation.kt b/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/Transformation.kt index eefda9c4..db70e055 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/Transformation.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/Transformation.kt @@ -11,7 +11,7 @@ import kotlinx.serialization.json.* * @param code The source code of the transformation. * @param name The uniquely identified name of your transformation. * @param createdAt Date of creation in RFC 3339 format. - * @param authenticationIDs The authentications associated for the current transformation. + * @param authenticationIDs The authentications associated with the current transformation. * @param description A descriptive name for your transformation of what it does. * @param updatedAt Date of last update in RFC 3339 format. */ @@ -30,7 +30,7 @@ public data class Transformation( /** Date of creation in RFC 3339 format. */ @SerialName(value = "createdAt") val createdAt: String, - /** The authentications associated for the current transformation. */ + /** The authentications associated with the current transformation. */ @SerialName(value = "authenticationIDs") val authenticationIDs: List? = null, /** A descriptive name for your transformation of what it does. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/TransformationCreate.kt b/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/TransformationCreate.kt index 540da30b..4b395086 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/TransformationCreate.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/TransformationCreate.kt @@ -10,7 +10,7 @@ import kotlinx.serialization.json.* * @param code The source code of the transformation. * @param name The uniquely identified name of your transformation. * @param description A descriptive name for your transformation of what it does. - * @param authenticationIDs The authentications associated for the current transformation. + * @param authenticationIDs The authentications associated with the current transformation. */ @Serializable public data class TransformationCreate( @@ -24,6 +24,6 @@ public data class TransformationCreate( /** A descriptive name for your transformation of what it does. */ @SerialName(value = "description") val description: String? = null, - /** The authentications associated for the current transformation. */ + /** The authentications associated with the current transformation. */ @SerialName(value = "authenticationIDs") val authenticationIDs: List? = null, )