Skip to content

Commit

Permalink
fix(specs): Typos in API descriptions (generated)
Browse files Browse the repository at this point in the history
  • Loading branch information
algolia-bot committed Oct 9, 2024
1 parent f4265b8 commit 50d5c89
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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 {
Expand Down Expand Up @@ -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 {
Expand All @@ -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 {
Expand Down Expand Up @@ -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<kotlin.String, Map<kotlin.String, Boolean>> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand All @@ -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<String>? = null,

/** A descriptive name for your transformation of what it does. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand All @@ -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<String>? = null,
)

0 comments on commit 50d5c89

Please sign in to comment.