Skip to content

Commit 4bf434d

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

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed

lib/algolia/api/ingestion_client.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1578,7 +1578,7 @@ def list_destinations(
15781578
)
15791579
end
15801580

1581-
# Retrieves a list of events for a task run, identified by it&#39;s ID.
1581+
# Retrieves a list of events for a task run, identified by its ID.
15821582
#
15831583
# Required API Key ACLs:
15841584
# - addObject
@@ -1660,7 +1660,7 @@ def list_events_with_http_info(
16601660
@api_client.call_api(:GET, path, new_options)
16611661
end
16621662

1663-
# Retrieves a list of events for a task run, identified by it's ID.
1663+
# Retrieves a list of events for a task run, identified by its ID.
16641664
#
16651665
# Required API Key ACLs:
16661666
# - addObject

lib/algolia/api/monitoring_client.rb

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ def custom_put(path, parameters = nil, body = nil, request_options = {})
210210

211211
# Retrieves known incidents for the selected clusters.
212212

213-
# @param clusters [String] Subset of clusters, separated by comma. (required)
213+
# @param clusters [String] Subset of clusters, separated by commas. (required)
214214
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
215215
# @return [Http::Response] the response
216216
def get_cluster_incidents_with_http_info(clusters, request_options = {})
@@ -240,7 +240,7 @@ def get_cluster_incidents_with_http_info(clusters, request_options = {})
240240

241241
# Retrieves known incidents for the selected clusters.
242242

243-
# @param clusters [String] Subset of clusters, separated by comma. (required)
243+
# @param clusters [String] Subset of clusters, separated by commas. (required)
244244
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
245245
# @return [IncidentsResponse]
246246
def get_cluster_incidents(clusters, request_options = {})
@@ -250,7 +250,7 @@ def get_cluster_incidents(clusters, request_options = {})
250250

251251
# Retrieves the status of selected clusters.
252252

253-
# @param clusters [String] Subset of clusters, separated by comma. (required)
253+
# @param clusters [String] Subset of clusters, separated by commas. (required)
254254
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
255255
# @return [Http::Response] the response
256256
def get_cluster_status_with_http_info(clusters, request_options = {})
@@ -280,7 +280,7 @@ def get_cluster_status_with_http_info(clusters, request_options = {})
280280

281281
# Retrieves the status of selected clusters.
282282

283-
# @param clusters [String] Subset of clusters, separated by comma. (required)
283+
# @param clusters [String] Subset of clusters, separated by commas. (required)
284284
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
285285
# @return [StatusResponse]
286286
def get_cluster_status(clusters, request_options = {})
@@ -323,7 +323,7 @@ def get_incidents(request_options = {})
323323

324324
# Retrieves average times for indexing operations for selected clusters.
325325

326-
# @param clusters [String] Subset of clusters, separated by comma. (required)
326+
# @param clusters [String] Subset of clusters, separated by commas. (required)
327327
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
328328
# @return [Http::Response] the response
329329
def get_indexing_time_with_http_info(clusters, request_options = {})
@@ -353,7 +353,7 @@ def get_indexing_time_with_http_info(clusters, request_options = {})
353353

354354
# Retrieves average times for indexing operations for selected clusters.
355355

356-
# @param clusters [String] Subset of clusters, separated by comma. (required)
356+
# @param clusters [String] Subset of clusters, separated by commas. (required)
357357
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
358358
# @return [IndexingTimeResponse]
359359
def get_indexing_time(clusters, request_options = {})
@@ -363,7 +363,7 @@ def get_indexing_time(clusters, request_options = {})
363363

364364
# Retrieves the average latency for search requests for selected clusters.
365365

366-
# @param clusters [String] Subset of clusters, separated by comma. (required)
366+
# @param clusters [String] Subset of clusters, separated by commas. (required)
367367
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
368368
# @return [Http::Response] the response
369369
def get_latency_with_http_info(clusters, request_options = {})
@@ -393,7 +393,7 @@ def get_latency_with_http_info(clusters, request_options = {})
393393

394394
# Retrieves the average latency for search requests for selected clusters.
395395

396-
# @param clusters [String] Subset of clusters, separated by comma. (required)
396+
# @param clusters [String] Subset of clusters, separated by commas. (required)
397397
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
398398
# @return [LatencyResponse]
399399
def get_latency(clusters, request_options = {})
@@ -454,7 +454,7 @@ def get_metrics(metric, period, request_options = {})
454454

455455
# Test whether clusters are reachable or not.
456456

457-
# @param clusters [String] Subset of clusters, separated by comma. (required)
457+
# @param clusters [String] Subset of clusters, separated by commas. (required)
458458
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
459459
# @return [Http::Response] the response
460460
def get_reachability_with_http_info(clusters, request_options = {})
@@ -484,7 +484,7 @@ def get_reachability_with_http_info(clusters, request_options = {})
484484

485485
# Test whether clusters are reachable or not.
486486

487-
# @param clusters [String] Subset of clusters, separated by comma. (required)
487+
# @param clusters [String] Subset of clusters, separated by commas. (required)
488488
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
489489
# @return [Hash<String, Hash>]
490490
def get_reachability(clusters, request_options = {})

lib/algolia/models/ingestion/transformation.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ class Transformation
99
# Universally unique identifier (UUID) of a transformation.
1010
attr_accessor :transformation_id
1111

12-
# The authentications associated for the current transformation.
12+
# The authentications associated with the current transformation.
1313
attr_accessor :authentication_ids
1414

1515
# The source code of the transformation.

lib/algolia/models/ingestion/transformation_create.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ class TransformationCreate
1616
# A descriptive name for your transformation of what it does.
1717
attr_accessor :description
1818

19-
# The authentications associated for the current transformation.
19+
# The authentications associated with the current transformation.
2020
attr_accessor :authentication_ids
2121

2222
# Attribute mapping from ruby-style variable name to JSON key.

0 commit comments

Comments
 (0)