Skip to content

Commit 56b0b8e

Browse files
algolia-botmillotp
andcommitted
fix(specs): proper title with linter (#3444) (generated) [skip ci]
Co-authored-by: Pierre Millot <[email protected]>
1 parent e179701 commit 56b0b8e

File tree

527 files changed

+6641
-2615
lines changed

Some content is hidden

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

527 files changed

+6641
-2615
lines changed

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

+18-18
Original file line numberDiff line numberDiff line change
@@ -232,8 +232,8 @@ public interface IQuerySuggestionsClient
232232
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
233233
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
234234
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
235-
/// <returns>Task of GetConfigStatus200Response</returns>
236-
Task<GetConfigStatus200Response> GetConfigStatusAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
235+
/// <returns>Task of ConfigStatus</returns>
236+
Task<ConfigStatus> GetConfigStatusAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
237237

238238
/// <summary>
239239
/// Reports the status of a Query Suggestions index. (Synchronous version)
@@ -244,8 +244,8 @@ public interface IQuerySuggestionsClient
244244
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
245245
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
246246
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
247-
/// <returns>GetConfigStatus200Response</returns>
248-
GetConfigStatus200Response GetConfigStatus(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
247+
/// <returns>ConfigStatus</returns>
248+
ConfigStatus GetConfigStatus(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
249249

250250
/// <summary>
251251
/// Retrieves the logs for a single Query Suggestions index.
@@ -256,8 +256,8 @@ public interface IQuerySuggestionsClient
256256
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
257257
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
258258
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
259-
/// <returns>Task of GetLogFile200Response</returns>
260-
Task<GetLogFile200Response> GetLogFileAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
259+
/// <returns>Task of LogFile</returns>
260+
Task<LogFile> GetLogFileAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
261261

262262
/// <summary>
263263
/// Retrieves the logs for a single Query Suggestions index. (Synchronous version)
@@ -268,8 +268,8 @@ public interface IQuerySuggestionsClient
268268
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
269269
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
270270
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
271-
/// <returns>GetLogFile200Response</returns>
272-
GetLogFile200Response GetLogFile(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
271+
/// <returns>LogFile</returns>
272+
LogFile GetLogFile(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
273273

274274
/// <summary>
275275
/// Updates a QuerySuggestions configuration.
@@ -712,8 +712,8 @@ public ConfigurationResponse GetConfig(string indexName, RequestOptions options
712712
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
713713
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
714714
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
715-
/// <returns>Task of GetConfigStatus200Response</returns>
716-
public async Task<GetConfigStatus200Response> GetConfigStatusAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default)
715+
/// <returns>Task of ConfigStatus</returns>
716+
public async Task<ConfigStatus> GetConfigStatusAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default)
717717
{
718718

719719
if (indexName == null)
@@ -723,7 +723,7 @@ public async Task<GetConfigStatus200Response> GetConfigStatusAsync(string indexN
723723

724724
requestOptions.PathParameters.Add("indexName", QueryStringHelper.ParameterToString(indexName));
725725

726-
return await _transport.ExecuteRequestAsync<GetConfigStatus200Response>(new HttpMethod("GET"), "/1/configs/{indexName}/status", requestOptions, cancellationToken).ConfigureAwait(false);
726+
return await _transport.ExecuteRequestAsync<ConfigStatus>(new HttpMethod("GET"), "/1/configs/{indexName}/status", requestOptions, cancellationToken).ConfigureAwait(false);
727727
}
728728

729729

@@ -739,8 +739,8 @@ public async Task<GetConfigStatus200Response> GetConfigStatusAsync(string indexN
739739
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
740740
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
741741
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
742-
/// <returns>GetConfigStatus200Response</returns>
743-
public GetConfigStatus200Response GetConfigStatus(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default) =>
742+
/// <returns>ConfigStatus</returns>
743+
public ConfigStatus GetConfigStatus(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default) =>
744744
AsyncHelper.RunSync(() => GetConfigStatusAsync(indexName, options, cancellationToken));
745745

746746

@@ -756,8 +756,8 @@ public GetConfigStatus200Response GetConfigStatus(string indexName, RequestOptio
756756
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
757757
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
758758
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
759-
/// <returns>Task of GetLogFile200Response</returns>
760-
public async Task<GetLogFile200Response> GetLogFileAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default)
759+
/// <returns>Task of LogFile</returns>
760+
public async Task<LogFile> GetLogFileAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default)
761761
{
762762

763763
if (indexName == null)
@@ -767,7 +767,7 @@ public async Task<GetLogFile200Response> GetLogFileAsync(string indexName, Reque
767767

768768
requestOptions.PathParameters.Add("indexName", QueryStringHelper.ParameterToString(indexName));
769769

770-
return await _transport.ExecuteRequestAsync<GetLogFile200Response>(new HttpMethod("GET"), "/1/logs/{indexName}", requestOptions, cancellationToken).ConfigureAwait(false);
770+
return await _transport.ExecuteRequestAsync<LogFile>(new HttpMethod("GET"), "/1/logs/{indexName}", requestOptions, cancellationToken).ConfigureAwait(false);
771771
}
772772

773773

@@ -783,8 +783,8 @@ public async Task<GetLogFile200Response> GetLogFileAsync(string indexName, Reque
783783
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
784784
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
785785
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
786-
/// <returns>GetLogFile200Response</returns>
787-
public GetLogFile200Response GetLogFile(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default) =>
786+
/// <returns>LogFile</returns>
787+
public LogFile GetLogFile(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default) =>
788788
AsyncHelper.RunSync(() => GetLogFileAsync(indexName, options, cancellationToken));
789789

790790

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

+18-18
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,8 @@ public interface IUsageClient
142142
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
143143
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
144144
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
145-
/// <returns>Task of GetUsage200Response</returns>
146-
Task<GetUsage200Response> GetIndexUsageAsync(Statistic statistic, string indexName, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default);
145+
/// <returns>Task of IndexUsage</returns>
146+
Task<IndexUsage> GetIndexUsageAsync(Statistic statistic, string indexName, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default);
147147

148148
/// <summary>
149149
/// Retrieves the selected usage statistics for one index. (Synchronous version)
@@ -158,8 +158,8 @@ public interface IUsageClient
158158
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
159159
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
160160
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
161-
/// <returns>GetUsage200Response</returns>
162-
GetUsage200Response GetIndexUsage(Statistic statistic, string indexName, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default);
161+
/// <returns>IndexUsage</returns>
162+
IndexUsage GetIndexUsage(Statistic statistic, string indexName, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default);
163163

164164
/// <summary>
165165
/// Retrieves usage statistics evaluated over a specified period.
@@ -173,8 +173,8 @@ public interface IUsageClient
173173
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
174174
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
175175
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
176-
/// <returns>Task of GetUsage200Response</returns>
177-
Task<GetUsage200Response> GetUsageAsync(Statistic statistic, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default);
176+
/// <returns>Task of IndexUsage</returns>
177+
Task<IndexUsage> GetUsageAsync(Statistic statistic, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default);
178178

179179
/// <summary>
180180
/// Retrieves usage statistics evaluated over a specified period. (Synchronous version)
@@ -188,8 +188,8 @@ public interface IUsageClient
188188
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
189189
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
190190
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
191-
/// <returns>GetUsage200Response</returns>
192-
GetUsage200Response GetUsage(Statistic statistic, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default);
191+
/// <returns>IndexUsage</returns>
192+
IndexUsage GetUsage(Statistic statistic, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default);
193193

194194
}
195195

@@ -438,8 +438,8 @@ public object CustomPut(string path, Dictionary<string, object> parameters = def
438438
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
439439
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
440440
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
441-
/// <returns>Task of GetUsage200Response</returns>
442-
public async Task<GetUsage200Response> GetIndexUsageAsync(Statistic statistic, string indexName, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default)
441+
/// <returns>Task of IndexUsage</returns>
442+
public async Task<IndexUsage> GetIndexUsageAsync(Statistic statistic, string indexName, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default)
443443
{
444444

445445

@@ -462,7 +462,7 @@ public async Task<GetUsage200Response> GetIndexUsageAsync(Statistic statistic, s
462462
requestOptions.AddQueryParameter("startDate", startDate);
463463
requestOptions.AddQueryParameter("endDate", endDate);
464464
requestOptions.AddQueryParameter("granularity", granularity);
465-
return await _transport.ExecuteRequestAsync<GetUsage200Response>(new HttpMethod("GET"), "/1/usage/{statistic}/{indexName}", requestOptions, cancellationToken).ConfigureAwait(false);
465+
return await _transport.ExecuteRequestAsync<IndexUsage>(new HttpMethod("GET"), "/1/usage/{statistic}/{indexName}", requestOptions, cancellationToken).ConfigureAwait(false);
466466
}
467467

468468

@@ -479,8 +479,8 @@ public async Task<GetUsage200Response> GetIndexUsageAsync(Statistic statistic, s
479479
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
480480
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
481481
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
482-
/// <returns>GetUsage200Response</returns>
483-
public GetUsage200Response GetIndexUsage(Statistic statistic, string indexName, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
482+
/// <returns>IndexUsage</returns>
483+
public IndexUsage GetIndexUsage(Statistic statistic, string indexName, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
484484
AsyncHelper.RunSync(() => GetIndexUsageAsync(statistic, indexName, startDate, endDate, granularity, options, cancellationToken));
485485

486486

@@ -496,8 +496,8 @@ public GetUsage200Response GetIndexUsage(Statistic statistic, string indexName,
496496
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
497497
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
498498
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
499-
/// <returns>Task of GetUsage200Response</returns>
500-
public async Task<GetUsage200Response> GetUsageAsync(Statistic statistic, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default)
499+
/// <returns>Task of IndexUsage</returns>
500+
public async Task<IndexUsage> GetUsageAsync(Statistic statistic, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default)
501501
{
502502

503503

@@ -515,7 +515,7 @@ public async Task<GetUsage200Response> GetUsageAsync(Statistic statistic, string
515515
requestOptions.AddQueryParameter("startDate", startDate);
516516
requestOptions.AddQueryParameter("endDate", endDate);
517517
requestOptions.AddQueryParameter("granularity", granularity);
518-
return await _transport.ExecuteRequestAsync<GetUsage200Response>(new HttpMethod("GET"), "/1/usage/{statistic}", requestOptions, cancellationToken).ConfigureAwait(false);
518+
return await _transport.ExecuteRequestAsync<IndexUsage>(new HttpMethod("GET"), "/1/usage/{statistic}", requestOptions, cancellationToken).ConfigureAwait(false);
519519
}
520520

521521

@@ -531,8 +531,8 @@ public async Task<GetUsage200Response> GetUsageAsync(Statistic statistic, string
531531
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
532532
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
533533
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
534-
/// <returns>GetUsage200Response</returns>
535-
public GetUsage200Response GetUsage(Statistic statistic, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
534+
/// <returns>IndexUsage</returns>
535+
public IndexUsage GetUsage(Statistic statistic, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
536536
AsyncHelper.RunSync(() => GetUsageAsync(statistic, startDate, endDate, granularity, options, cancellationToken));
537537

538538
}
+5-5
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ namespace Algolia.Search.Models.Abtesting;
1414
/// <summary>
1515
/// Empty searches removed from the A/B test as a result of configuration settings.
1616
/// </summary>
17-
public partial class FilterEffectsEmptySearch
17+
public partial class EmptySearchFilter
1818
{
1919
/// <summary>
20-
/// Initializes a new instance of the FilterEffectsEmptySearch class.
20+
/// Initializes a new instance of the EmptySearchFilter class.
2121
/// </summary>
22-
public FilterEffectsEmptySearch()
22+
public EmptySearchFilter()
2323
{
2424
}
2525

@@ -44,7 +44,7 @@ public FilterEffectsEmptySearch()
4444
public override string ToString()
4545
{
4646
StringBuilder sb = new StringBuilder();
47-
sb.Append("class FilterEffectsEmptySearch {\n");
47+
sb.Append("class EmptySearchFilter {\n");
4848
sb.Append(" UsersCount: ").Append(UsersCount).Append("\n");
4949
sb.Append(" TrackedSearchesCount: ").Append(TrackedSearchesCount).Append("\n");
5050
sb.Append("}\n");
@@ -67,7 +67,7 @@ public virtual string ToJson()
6767
/// <returns>Boolean</returns>
6868
public override bool Equals(object obj)
6969
{
70-
if (obj is not FilterEffectsEmptySearch input)
70+
if (obj is not EmptySearchFilter input)
7171
{
7272
return false;
7373
}

clients/algoliasearch-client-csharp/algoliasearch/Models/Abtesting/FilterEffects.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ public FilterEffects()
2727
/// Gets or Sets Outliers
2828
/// </summary>
2929
[JsonPropertyName("outliers")]
30-
public FilterEffectsOutliers Outliers { get; set; }
30+
public OutliersFilter Outliers { get; set; }
3131

3232
/// <summary>
3333
/// Gets or Sets EmptySearch
3434
/// </summary>
3535
[JsonPropertyName("emptySearch")]
36-
public FilterEffectsEmptySearch EmptySearch { get; set; }
36+
public EmptySearchFilter EmptySearch { get; set; }
3737

3838
/// <summary>
3939
/// Returns the string presentation of the object

0 commit comments

Comments
 (0)