Skip to content

Commit

Permalink
fix(specs): proper title with linter (generated)
Browse files Browse the repository at this point in the history 
algolia/api-clients-automation#3444

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
  • Loading branch information
@algolia-bot @millotp
algolia-bot and millotp committed Jul 30, 2024
1 parent 959176d commit d02392d
Show file tree
Hide file tree
Showing 44 changed files with 597 additions and 214 deletions.
36 changes: 18 additions & 18 deletions algoliasearch/Clients/QuerySuggestionsClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -232,8 +232,8 @@ public interface IQuerySuggestionsClient
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
/// <returns>Task of GetConfigStatus200Response</returns>
Task<GetConfigStatus200Response> GetConfigStatusAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
/// <returns>Task of ConfigStatus</returns>
Task<ConfigStatus> GetConfigStatusAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);

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

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

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

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

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

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

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


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


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

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

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

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


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


Expand Down
36 changes: 18 additions & 18 deletions algoliasearch/Clients/UsageClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,8 @@ public interface IUsageClient
/// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
/// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
/// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
/// <returns>Task of GetUsage200Response</returns>
Task<GetUsage200Response> GetIndexUsageAsync(Statistic statistic, string indexName, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default);
/// <returns>Task of IndexUsage</returns>
Task<IndexUsage> GetIndexUsageAsync(Statistic statistic, string indexName, string startDate, string endDate, Granularity? granularity = default, RequestOptions options = null, CancellationToken cancellationToken = default);

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

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

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

}

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


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


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


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


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


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

}
Expand Down
10 changes: 5 additions & 5 deletions ...els/Abtesting/FilterEffectsEmptySearch.cs → ...rch/Models/Abtesting/EmptySearchFilter.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ namespace Algolia.Search.Models.Abtesting;
/// <summary>
/// Empty searches removed from the A/B test as a result of configuration settings.
/// </summary>
public partial class FilterEffectsEmptySearch
public partial class EmptySearchFilter
{
/// <summary>
/// Initializes a new instance of the FilterEffectsEmptySearch class.
/// Initializes a new instance of the EmptySearchFilter class.
/// </summary>
public FilterEffectsEmptySearch()
public EmptySearchFilter()
{
}

Expand All @@ -44,7 +44,7 @@ public FilterEffectsEmptySearch()
public override string ToString()
{
StringBuilder sb = new StringBuilder();
sb.Append("class FilterEffectsEmptySearch {\n");
sb.Append("class EmptySearchFilter {\n");
sb.Append(" UsersCount: ").Append(UsersCount).Append("\n");
sb.Append(" TrackedSearchesCount: ").Append(TrackedSearchesCount).Append("\n");
sb.Append("}\n");
Expand All @@ -67,7 +67,7 @@ public virtual string ToJson()
/// <returns>Boolean</returns>
public override bool Equals(object obj)
{
if (obj is not FilterEffectsEmptySearch input)
if (obj is not EmptySearchFilter input)
{
return false;
}
Expand Down
4 changes: 2 additions & 2 deletions algoliasearch/Models/Abtesting/FilterEffects.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ public FilterEffects()
/// Gets or Sets Outliers
/// </summary>
[JsonPropertyName("outliers")]
public FilterEffectsOutliers Outliers { get; set; }
public OutliersFilter Outliers { get; set; }

/// <summary>
/// Gets or Sets EmptySearch
/// </summary>
[JsonPropertyName("emptySearch")]
public FilterEffectsEmptySearch EmptySearch { get; set; }
public EmptySearchFilter EmptySearch { get; set; }

/// <summary>
/// Returns the string presentation of the object
Expand Down
Loading

0 comments on commit d02392d

Please sign in to comment.