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 ac12238 commit 6098891
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion Sources/Ingestion/IngestionClient.swift
Original file line number Diff line number Diff line change
Expand Up @@ -1853,7 +1853,7 @@ open class IngestionClient {
return body
}

// 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
// - deleteIndex
Expand Down
2 changes: 1 addition & 1 deletion Sources/Ingestion/Models/Transformation.swift
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import Foundation
public struct Transformation: Codable, JSONEncodable {
/// Universally unique identifier (UUID) of a transformation.
public var transformationID: String
/// The authentications associated for the current transformation.
/// The authentications associated with the current transformation.
public var authenticationIDs: [String]?
/// The source code of the transformation.
public var code: String
Expand Down
2 changes: 1 addition & 1 deletion Sources/Ingestion/Models/TransformationCreate.swift
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public struct TransformationCreate: Codable, JSONEncodable {
public var name: String
/// A descriptive name for your transformation of what it does.
public var description: String?
/// The authentications associated for the current transformation.
/// The authentications associated with the current transformation.
public var authenticationIDs: [String]?

public init(code: String, name: String, description: String? = nil, authenticationIDs: [String]? = nil) {
Expand Down
20 changes: 10 additions & 10 deletions Sources/Monitoring/MonitoringClient.swift
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ open class MonitoringClient {
)
}

/// - parameter clusters: (path) Subset of clusters, separated by comma.
/// - parameter clusters: (path) Subset of clusters, separated by commas.
/// - returns: IncidentsResponse
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open func getClusterIncidents(
Expand All @@ -314,7 +314,7 @@ open class MonitoringClient {
// Retrieves known incidents for the selected clusters.
//
//
// - parameter clusters: (path) Subset of clusters, separated by comma.
// - parameter clusters: (path) Subset of clusters, separated by commas.
// - returns: RequestBuilder<IncidentsResponse>

open func getClusterIncidentsWithHTTPInfo(
Expand Down Expand Up @@ -350,7 +350,7 @@ open class MonitoringClient {
)
}

/// - parameter clusters: (path) Subset of clusters, separated by comma.
/// - parameter clusters: (path) Subset of clusters, separated by commas.
/// - returns: StatusResponse
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open func getClusterStatus(clusters: String, requestOptions: RequestOptions? = nil) async throws -> StatusResponse {
Expand All @@ -369,7 +369,7 @@ open class MonitoringClient {
// Retrieves the status of selected clusters.
//
//
// - parameter clusters: (path) Subset of clusters, separated by comma.
// - parameter clusters: (path) Subset of clusters, separated by commas.
// - returns: RequestBuilder<StatusResponse>

open func getClusterStatusWithHTTPInfo(
Expand Down Expand Up @@ -439,7 +439,7 @@ open class MonitoringClient {
)
}

/// - parameter clusters: (path) Subset of clusters, separated by comma.
/// - parameter clusters: (path) Subset of clusters, separated by commas.
/// - returns: IndexingTimeResponse
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open func getIndexingTime(
Expand All @@ -461,7 +461,7 @@ open class MonitoringClient {
// Retrieves average times for indexing operations for selected clusters.
//
//
// - parameter clusters: (path) Subset of clusters, separated by comma.
// - parameter clusters: (path) Subset of clusters, separated by commas.
// - returns: RequestBuilder<IndexingTimeResponse>

open func getIndexingTimeWithHTTPInfo(
Expand Down Expand Up @@ -497,7 +497,7 @@ open class MonitoringClient {
)
}

/// - parameter clusters: (path) Subset of clusters, separated by comma.
/// - parameter clusters: (path) Subset of clusters, separated by commas.
/// - returns: LatencyResponse
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open func getLatency(clusters: String, requestOptions: RequestOptions? = nil) async throws -> LatencyResponse {
Expand All @@ -516,7 +516,7 @@ open class MonitoringClient {
// Retrieves the average latency for search requests for selected clusters.
//
//
// - parameter clusters: (path) Subset of clusters, separated by comma.
// - parameter clusters: (path) Subset of clusters, separated by commas.
// - returns: RequestBuilder<LatencyResponse>

open func getLatencyWithHTTPInfo(
Expand Down Expand Up @@ -634,7 +634,7 @@ open class MonitoringClient {
)
}

/// - parameter clusters: (path) Subset of clusters, separated by comma.
/// - parameter clusters: (path) Subset of clusters, separated by commas.
/// - returns: [String: [String: Bool]]
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
open func getReachability(
Expand All @@ -656,7 +656,7 @@ open class MonitoringClient {
// Test whether clusters are reachable or not.
//
//
// - parameter clusters: (path) Subset of clusters, separated by comma.
// - parameter clusters: (path) Subset of clusters, separated by commas.
// - returns: RequestBuilder<[String: [String: Bool]]>

open func getReachabilityWithHTTPInfo(
Expand Down

0 comments on commit 6098891

Please sign in to comment.