Skip to content

Commit 50d5c89

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

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -687,7 +687,7 @@ public class IngestionClient(
687687
}
688688

689689
/**
690-
* Retrieves a list of events for a task run, identified by it's ID.
690+
* Retrieves a list of events for a task run, identified by its ID.
691691
*
692692
* Required API Key ACLs:
693693
* - addObject

client/src/commonMain/kotlin/com/algolia/client/api/MonitoringClient.kt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ public class MonitoringClient(
116116

117117
/**
118118
* Retrieves known incidents for the selected clusters.
119-
* @param clusters Subset of clusters, separated by comma.
119+
* @param clusters Subset of clusters, separated by commas.
120120
* @param requestOptions additional request configuration.
121121
*/
122122
public suspend fun getClusterIncidents(clusters: String, requestOptions: RequestOptions? = null): IncidentsResponse {
@@ -133,7 +133,7 @@ public class MonitoringClient(
133133

134134
/**
135135
* Retrieves the status of selected clusters.
136-
* @param clusters Subset of clusters, separated by comma.
136+
* @param clusters Subset of clusters, separated by commas.
137137
* @param requestOptions additional request configuration.
138138
*/
139139
public suspend fun getClusterStatus(clusters: String, requestOptions: RequestOptions? = null): StatusResponse {
@@ -165,7 +165,7 @@ public class MonitoringClient(
165165

166166
/**
167167
* Retrieves average times for indexing operations for selected clusters.
168-
* @param clusters Subset of clusters, separated by comma.
168+
* @param clusters Subset of clusters, separated by commas.
169169
* @param requestOptions additional request configuration.
170170
*/
171171
public suspend fun getIndexingTime(clusters: String, requestOptions: RequestOptions? = null): IndexingTimeResponse {
@@ -182,7 +182,7 @@ public class MonitoringClient(
182182

183183
/**
184184
* Retrieves the average latency for search requests for selected clusters.
185-
* @param clusters Subset of clusters, separated by comma.
185+
* @param clusters Subset of clusters, separated by commas.
186186
* @param requestOptions additional request configuration.
187187
*/
188188
public suspend fun getLatency(clusters: String, requestOptions: RequestOptions? = null): LatencyResponse {
@@ -216,7 +216,7 @@ public class MonitoringClient(
216216

217217
/**
218218
* Test whether clusters are reachable or not.
219-
* @param clusters Subset of clusters, separated by comma.
219+
* @param clusters Subset of clusters, separated by commas.
220220
* @param requestOptions additional request configuration.
221221
*/
222222
public suspend fun getReachability(clusters: String, requestOptions: RequestOptions? = null): Map<kotlin.String, Map<kotlin.String, Boolean>> {

client/src/commonMain/kotlin/com/algolia/client/model/ingestion/Transformation.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
1111
* @param code The source code of the transformation.
1212
* @param name The uniquely identified name of your transformation.
1313
* @param createdAt Date of creation in RFC 3339 format.
14-
* @param authenticationIDs The authentications associated for the current transformation.
14+
* @param authenticationIDs The authentications associated with the current transformation.
1515
* @param description A descriptive name for your transformation of what it does.
1616
* @param updatedAt Date of last update in RFC 3339 format.
1717
*/
@@ -30,7 +30,7 @@ public data class Transformation(
3030
/** Date of creation in RFC 3339 format. */
3131
@SerialName(value = "createdAt") val createdAt: String,
3232

33-
/** The authentications associated for the current transformation. */
33+
/** The authentications associated with the current transformation. */
3434
@SerialName(value = "authenticationIDs") val authenticationIDs: List<String>? = null,
3535

3636
/** A descriptive name for your transformation of what it does. */

client/src/commonMain/kotlin/com/algolia/client/model/ingestion/TransformationCreate.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import kotlinx.serialization.json.*
1010
* @param code The source code of the transformation.
1111
* @param name The uniquely identified name of your transformation.
1212
* @param description A descriptive name for your transformation of what it does.
13-
* @param authenticationIDs The authentications associated for the current transformation.
13+
* @param authenticationIDs The authentications associated with the current transformation.
1414
*/
1515
@Serializable
1616
public data class TransformationCreate(
@@ -24,6 +24,6 @@ public data class TransformationCreate(
2424
/** A descriptive name for your transformation of what it does. */
2525
@SerialName(value = "description") val description: String? = null,
2626

27-
/** The authentications associated for the current transformation. */
27+
/** The authentications associated with the current transformation. */
2828
@SerialName(value = "authenticationIDs") val authenticationIDs: List<String>? = null,
2929
)

0 commit comments

Comments
 (0)