Skip to content

Commit 63622bd

Browse files
committed
fix(specs): Typos in API descriptions (#3932) (generated) [skip ci]
Co-authored-by: gazconroy <[email protected]> Co-authored-by: Gary Conroy <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
1 parent f516d02 commit 63622bd

File tree

221 files changed

+552
-1013
lines changed

Some content is hidden

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

221 files changed

+552
-1013
lines changed

clients/algoliasearch-client-csharp/algoliasearch/Clients/IngestionClient.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -980,7 +980,7 @@ public interface IIngestionClient
980980
ListDestinationsResponse ListDestinations(int? itemsPerPage = default, int? page = default, List<DestinationType> type = default, List<string> authenticationID = default, string transformationID = default, DestinationSortKeys? sort = default, OrderKeys? order = default, RequestOptions options = null, CancellationToken cancellationToken = default);
981981

982982
/// <summary>
983-
/// Retrieves a list of events for a task run, identified by it's ID.
983+
/// Retrieves a list of events for a task run, identified by its ID.
984984
/// </summary>
985985
///
986986
/// Required API Key ACLs:
@@ -1005,7 +1005,7 @@ public interface IIngestionClient
10051005
Task<ListEventsResponse> ListEventsAsync(string runID, int? itemsPerPage = default, int? page = default, List<EventStatus> status = default, List<EventType> type = default, EventSortKeys? sort = default, OrderKeys? order = default, string startDate = default, string endDate = default, RequestOptions options = null, CancellationToken cancellationToken = default);
10061006

10071007
/// <summary>
1008-
/// Retrieves a list of events for a task run, identified by it's ID. (Synchronous version)
1008+
/// Retrieves a list of events for a task run, identified by its ID. (Synchronous version)
10091009
/// </summary>
10101010
///
10111011
/// Required API Key ACLs:

clients/algoliasearch-client-csharp/algoliasearch/Clients/IngestionConfiguration.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* Ingestion API
33
*
4-
* The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks to ingest your data. The Ingestion API powers the no-code [data connectors](https://dashboard.algolia.com/connectors). ## Base URLs The base URLs for requests to the Ingestion API are: - `https://data.us.algolia.com` - `https://data.eu.algolia.com` Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ## Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
4+
* The Ingestion API lets you connect third-party services and platforms with Algolia and schedule tasks to ingest your data. The Ingestion API powers the no-code [data connectors](https://dashboard.algolia.com/connectors). ## Base URLs The base URLs for requests to the Ingestion API are: - `https://data.us.algolia.com` - `https://data.eu.algolia.com` Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ## Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current version of the Ingestion API is version 1, as indicated by the `/1/` in each endpoint's URL.
55
*
66
* The version of the OpenAPI document: 1.0.0
77
* Generated by: https://github.com/openapitools/openapi-generator.git

clients/algoliasearch-client-csharp/algoliasearch/Clients/InsightsConfiguration.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* Insights API
33
*
4-
* The Insights API lets you collect events related to your search and discovery experience. Events represent user interactions with your app or website. They unlock powerful features, such as recommendations, personalization, smarter search results, and analytics that help you optimize your user experience. ## Client libraries Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the Insights API. See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io` - `https://insights.de.algolia.io` - `https//insights.algolia.io` (routes requests to the closest of the above servers, based on your geographical location) **All requests must use HTTPS.** ## Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or `userToken`, correspond to anything in the Search API. It justs checks if they're formatted correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
4+
* The Insights API lets you collect events related to your search and discovery experience. Events represent user interactions with your app or website. They unlock powerful features, such as recommendations, personalization, smarter search results, and analytics that help you optimize your user experience. ## Client libraries Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the Insights API. See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/). ## Base URLs The base URLs for making requests to the Insights API are: - `https://insights.us.algolia.io` - `https://insights.de.algolia.io` - `https//insights.algolia.io` (routes requests to the closest of the above servers, based on your geographical location) **All requests must use HTTPS.** ## Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects. ## Response status and errors Response bodies are JSON objects. Deleting a user token returns an empty response body with rate-limiting information as headers. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or `userToken`, correspond to anything in the Search API. It just checks if they're formatted correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia features such as Analytics, or Dynamic Re-Ranking. ## Version The current version of the Insights API is version 1, as indicated by the `/1/` in each endpoint's URL.
55
*
66
* The version of the OpenAPI document: 1.0.0
77
* Generated by: https://github.com/openapitools/openapi-generator.git

clients/algoliasearch-client-csharp/algoliasearch/Clients/MonitoringClient.cs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ public interface IMonitoringClient
132132
/// <summary>
133133
/// Retrieves known incidents for the selected clusters.
134134
/// </summary>
135-
/// <param name="clusters">Subset of clusters, separated by comma.</param>
135+
/// <param name="clusters">Subset of clusters, separated by commas.</param>
136136
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
137137
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
138138
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -144,7 +144,7 @@ public interface IMonitoringClient
144144
/// <summary>
145145
/// Retrieves known incidents for the selected clusters. (Synchronous version)
146146
/// </summary>
147-
/// <param name="clusters">Subset of clusters, separated by comma.</param>
147+
/// <param name="clusters">Subset of clusters, separated by commas.</param>
148148
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
149149
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
150150
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -156,7 +156,7 @@ public interface IMonitoringClient
156156
/// <summary>
157157
/// Retrieves the status of selected clusters.
158158
/// </summary>
159-
/// <param name="clusters">Subset of clusters, separated by comma.</param>
159+
/// <param name="clusters">Subset of clusters, separated by commas.</param>
160160
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
161161
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
162162
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -168,7 +168,7 @@ public interface IMonitoringClient
168168
/// <summary>
169169
/// Retrieves the status of selected clusters. (Synchronous version)
170170
/// </summary>
171-
/// <param name="clusters">Subset of clusters, separated by comma.</param>
171+
/// <param name="clusters">Subset of clusters, separated by commas.</param>
172172
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
173173
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
174174
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -202,7 +202,7 @@ public interface IMonitoringClient
202202
/// <summary>
203203
/// Retrieves average times for indexing operations for selected clusters.
204204
/// </summary>
205-
/// <param name="clusters">Subset of clusters, separated by comma.</param>
205+
/// <param name="clusters">Subset of clusters, separated by commas.</param>
206206
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
207207
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
208208
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -214,7 +214,7 @@ public interface IMonitoringClient
214214
/// <summary>
215215
/// Retrieves average times for indexing operations for selected clusters. (Synchronous version)
216216
/// </summary>
217-
/// <param name="clusters">Subset of clusters, separated by comma.</param>
217+
/// <param name="clusters">Subset of clusters, separated by commas.</param>
218218
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
219219
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
220220
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -226,7 +226,7 @@ public interface IMonitoringClient
226226
/// <summary>
227227
/// Retrieves the average latency for search requests for selected clusters.
228228
/// </summary>
229-
/// <param name="clusters">Subset of clusters, separated by comma.</param>
229+
/// <param name="clusters">Subset of clusters, separated by commas.</param>
230230
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
231231
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
232232
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -238,7 +238,7 @@ public interface IMonitoringClient
238238
/// <summary>
239239
/// Retrieves the average latency for search requests for selected clusters. (Synchronous version)
240240
/// </summary>
241-
/// <param name="clusters">Subset of clusters, separated by comma.</param>
241+
/// <param name="clusters">Subset of clusters, separated by commas.</param>
242242
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
243243
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
244244
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -276,7 +276,7 @@ public interface IMonitoringClient
276276
/// <summary>
277277
/// Test whether clusters are reachable or not.
278278
/// </summary>
279-
/// <param name="clusters">Subset of clusters, separated by comma.</param>
279+
/// <param name="clusters">Subset of clusters, separated by commas.</param>
280280
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
281281
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
282282
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -288,7 +288,7 @@ public interface IMonitoringClient
288288
/// <summary>
289289
/// Test whether clusters are reachable or not. (Synchronous version)
290290
/// </summary>
291-
/// <param name="clusters">Subset of clusters, separated by comma.</param>
291+
/// <param name="clusters">Subset of clusters, separated by commas.</param>
292292
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
293293
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
294294
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>

clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/Transformation.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ public Transformation(string transformationID, string code, string name, string
4444
public string TransformationID { get; set; }
4545

4646
/// <summary>
47-
/// The authentications associated for the current transformation.
47+
/// The authentications associated with the current transformation.
4848
/// </summary>
49-
/// <value>The authentications associated for the current transformation.</value>
49+
/// <value>The authentications associated with the current transformation.</value>
5050
[JsonPropertyName("authenticationIDs")]
5151
public List<string> AuthenticationIDs { get; set; }
5252

clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/TransformationCreate.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ public TransformationCreate(string code, string name)
5454
public string Description { get; set; }
5555

5656
/// <summary>
57-
/// The authentications associated for the current transformation.
57+
/// The authentications associated with the current transformation.
5858
/// </summary>
59-
/// <value>The authentications associated for the current transformation.</value>
59+
/// <value>The authentications associated with the current transformation.</value>
6060
[JsonPropertyName("authenticationIDs")]
6161
public List<string> AuthenticationIDs { get; set; }
6262

clients/algoliasearch-client-go/algolia/ingestion/api_ingestion.go

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

clients/algoliasearch-client-go/algolia/ingestion/model_transformation.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

clients/algoliasearch-client-go/algolia/ingestion/model_transformation_create.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)