Skip to content

Commit 6248c41

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

File tree

174 files changed

+352
-787
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

174 files changed

+352
-787
lines changed

src/main/scala/algoliasearch/api/IngestionClient.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -858,7 +858,7 @@ class IngestionClient(
858858
execute[ListDestinationsResponse](request, requestOptions)
859859
}
860860

861-
/** Retrieves a list of events for a task run, identified by it's ID.
861+
/** Retrieves a list of events for a task run, identified by its ID.
862862
*
863863
* Required API Key ACLs:
864864
* - addObject

src/main/scala/algoliasearch/api/MonitoringClient.scala

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ class MonitoringClient(
169169
/** Retrieves known incidents for the selected clusters.
170170
*
171171
* @param clusters
172-
* Subset of clusters, separated by comma.
172+
* Subset of clusters, separated by commas.
173173
*/
174174
def getClusterIncidents(clusters: String, requestOptions: Option[RequestOptions] = None)(implicit
175175
ec: ExecutionContext
@@ -187,7 +187,7 @@ class MonitoringClient(
187187
/** Retrieves the status of selected clusters.
188188
*
189189
* @param clusters
190-
* Subset of clusters, separated by comma.
190+
* Subset of clusters, separated by commas.
191191
*/
192192
def getClusterStatus(clusters: String, requestOptions: Option[RequestOptions] = None)(implicit
193193
ec: ExecutionContext
@@ -219,7 +219,7 @@ class MonitoringClient(
219219
/** Retrieves average times for indexing operations for selected clusters.
220220
*
221221
* @param clusters
222-
* Subset of clusters, separated by comma.
222+
* Subset of clusters, separated by commas.
223223
*/
224224
def getIndexingTime(clusters: String, requestOptions: Option[RequestOptions] = None)(implicit
225225
ec: ExecutionContext
@@ -237,7 +237,7 @@ class MonitoringClient(
237237
/** Retrieves the average latency for search requests for selected clusters.
238238
*
239239
* @param clusters
240-
* Subset of clusters, separated by comma.
240+
* Subset of clusters, separated by commas.
241241
*/
242242
def getLatency(clusters: String, requestOptions: Option[RequestOptions] = None)(implicit
243243
ec: ExecutionContext
@@ -282,7 +282,7 @@ class MonitoringClient(
282282
/** Test whether clusters are reachable or not.
283283
*
284284
* @param clusters
285-
* Subset of clusters, separated by comma.
285+
* Subset of clusters, separated by commas.
286286
*/
287287
def getReachability(clusters: String, requestOptions: Option[RequestOptions] = None)(implicit
288288
ec: ExecutionContext

src/main/scala/algoliasearch/ingestion/Action.scala

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
1111
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
1212
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
13+
* property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by
14+
* the `/1/` in each endpoint's URL.
1815
*
1916
* The version of the OpenAPI document: 1.0.0
2017
*

src/main/scala/algoliasearch/ingestion/ActionType.scala

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
1111
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
1212
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
13+
* property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by
14+
* the `/1/` in each endpoint's URL.
1815
*
1916
* The version of the OpenAPI document: 1.0.0
2017
*

src/main/scala/algoliasearch/ingestion/AuthAPIKey.scala

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
1111
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
1212
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
13+
* property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by
14+
* the `/1/` in each endpoint's URL.
1815
*
1916
* The version of the OpenAPI document: 1.0.0
2017
*

src/main/scala/algoliasearch/ingestion/AuthAPIKeyPartial.scala

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
1111
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
1212
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
13+
* property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by
14+
* the `/1/` in each endpoint's URL.
1815
*
1916
* The version of the OpenAPI document: 1.0.0
2017
*

src/main/scala/algoliasearch/ingestion/AuthAlgolia.scala

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
1111
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
1212
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
13+
* property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by
14+
* the `/1/` in each endpoint's URL.
1815
*
1916
* The version of the OpenAPI document: 1.0.0
2017
*

src/main/scala/algoliasearch/ingestion/AuthAlgoliaInsights.scala

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
1111
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
1212
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
13+
* property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by
14+
* the `/1/` in each endpoint's URL.
1815
*
1916
* The version of the OpenAPI document: 1.0.0
2017
*

src/main/scala/algoliasearch/ingestion/AuthAlgoliaInsightsPartial.scala

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
1111
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
1212
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
13+
* property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by
14+
* the `/1/` in each endpoint's URL.
1815
*
1916
* The version of the OpenAPI document: 1.0.0
2017
*

src/main/scala/algoliasearch/ingestion/AuthAlgoliaPartial.scala

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
1111
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
1212
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
13+
* property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by
14+
* the `/1/` in each endpoint's URL.
1815
*
1916
* The version of the OpenAPI document: 1.0.0
2017
*

src/main/scala/algoliasearch/ingestion/AuthBasic.scala

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
1111
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
1212
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
13+
* property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by
14+
* the `/1/` in each endpoint's URL.
1815
*
1916
* The version of the OpenAPI document: 1.0.0
2017
*

src/main/scala/algoliasearch/ingestion/AuthBasicPartial.scala

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
1111
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
1212
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
13+
* property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by
14+
* the `/1/` in each endpoint's URL.
1815
*
1916
* The version of the OpenAPI document: 1.0.0
2017
*

src/main/scala/algoliasearch/ingestion/AuthGoogleServiceAccount.scala

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
1111
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
1212
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
13+
* property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by
14+
* the `/1/` in each endpoint's URL.
1815
*
1916
* The version of the OpenAPI document: 1.0.0
2017
*

src/main/scala/algoliasearch/ingestion/AuthGoogleServiceAccountPartial.scala

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
1111
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
1212
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
13+
* property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by
14+
* the `/1/` in each endpoint's URL.
1815
*
1916
* The version of the OpenAPI document: 1.0.0
2017
*

src/main/scala/algoliasearch/ingestion/AuthInput.scala

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
1111
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
1212
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
13+
* property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by
14+
* the `/1/` in each endpoint's URL.
1815
*
1916
* The version of the OpenAPI document: 1.0.0
2017
*

src/main/scala/algoliasearch/ingestion/AuthInputPartial.scala

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
1111
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
1212
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
13+
* property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by
14+
* the `/1/` in each endpoint's URL.
1815
*
1916
* The version of the OpenAPI document: 1.0.0
2017
*

src/main/scala/algoliasearch/ingestion/AuthOAuth.scala

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
1111
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
1212
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
13+
* property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by
14+
* the `/1/` in each endpoint's URL.
1815
*
1916
* The version of the OpenAPI document: 1.0.0
2017
*

src/main/scala/algoliasearch/ingestion/AuthOAuthPartial.scala

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
* be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an
1111
* empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client
1212
* errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
13-
* property with more information. The Insights API doesn't validate if the event parameters such as `indexName`,
14-
* `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted
15-
* correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can
16-
* be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the
17-
* Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
13+
* property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by
14+
* the `/1/` in each endpoint's URL.
1815
*
1916
* The version of the OpenAPI document: 1.0.0
2017
*

0 commit comments

Comments
 (0)