Skip to content

as per elastic/elasticsearch#20305 deprecate Suggest() in favor over … #2562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 6, 2017
Merged

as per elastic/elasticsearch#20305 deprecate Suggest() in favor over … #2562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/Nest/Search/Suggesters/Suggest/ElasticClient-Suggest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,19 @@ public partial interface IElasticClient
/// </summary>
/// <typeparam name="T">The type used to strongly type parts of the suggest operation</typeparam>
/// <param name="selector">The suggesters to use this operation (can be multiple)</param>
[Obsolete("Deprecated in 5.2.0. Use suggest through Search() instead this API is sheduled for removal")]
ISuggestResponse<T> Suggest<T>(Func<SuggestDescriptor<T>, ISuggestRequest> selector) where T : class;

/// <inheritdoc/>
[Obsolete("Deprecated in 5.2.0. Use suggest through Search() instead this API is sheduled for removal")]
ISuggestResponse<T> Suggest<T>(ISuggestRequest request) where T : class;

/// <inheritdoc/>
[Obsolete("Deprecated in 5.2.0. Use suggest through Search() instead this API is sheduled for removal")]
Task<ISuggestResponse<T>> SuggestAsync<T>(Func<SuggestDescriptor<T>, ISuggestRequest> selector, CancellationToken cancellationToken = default(CancellationToken)) where T : class;

/// <inheritdoc/>
[Obsolete("Deprecated in 5.2.0. Use suggest through Search() instead this API is sheduled for removal")]
Task<ISuggestResponse<T>> SuggestAsync<T>(ISuggestRequest request, CancellationToken cancellationToken = default(CancellationToken))
where T : class;

Expand All @@ -30,21 +34,25 @@ public partial interface IElasticClient
public partial class ElasticClient
{
/// <inheritdoc/>
[Obsolete("Deprecated in 5.2.0. Use suggest through Search() instead this API is sheduled for removal")]
public ISuggestResponse<T> Suggest<T>(Func<SuggestDescriptor<T>, ISuggestRequest> selector) where T : class =>
this.Suggest<T>(selector?.Invoke(new SuggestDescriptor<T>()));

/// <inheritdoc/>
[Obsolete("Deprecated in 5.2.0. Use suggest through Search() instead this API is sheduled for removal")]
public ISuggestResponse<T> Suggest<T>(ISuggestRequest request) where T : class =>
this.Dispatcher.Dispatch<ISuggestRequest, SuggestRequestParameters, SuggestResponse<T>>(
request,
this.LowLevelDispatch.SuggestDispatch<SuggestResponse<T>>
);

/// <inheritdoc/>
[Obsolete("Deprecated in 5.2.0. Use suggest through Search() instead this API is sheduled for removal")]
public Task<ISuggestResponse<T>> SuggestAsync<T>(Func<SuggestDescriptor<T>, ISuggestRequest> selector, CancellationToken cancellationToken = default(CancellationToken)) where T : class =>
this.SuggestAsync<T>(selector?.Invoke(new SuggestDescriptor<T>()), cancellationToken);

/// <inheritdoc/>
[Obsolete("Deprecated in 5.2.0. Use suggest through Search() instead this API is sheduled for removal")]
public Task<ISuggestResponse<T>> SuggestAsync<T>(ISuggestRequest request, CancellationToken cancellationToken = default(CancellationToken))
where T : class =>
this.Dispatcher.DispatchAsync<ISuggestRequest, SuggestRequestParameters, SuggestResponse<T>, ISuggestResponse<T>>(
Expand Down
2 changes: 2 additions & 0 deletions src/Tests/Search/Suggesters/SuggestApiTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@ public SuggestApiTests(ReadOnlyCluster cluster, EndpointUsage usage) : base(clus
}

protected override LazyResponses ClientUsage() => Calls(
#pragma warning disable 618
fluent: (c, f) => c.Suggest<Project>(f),
fluentAsync: (c, f) => c.SuggestAsync<Project>(f),
request: (c, r) => c.Suggest<Project>(r),
requestAsync: (c, r) => c.SuggestAsync<Project>(r)
#pragma warning restore 618
);

protected override int ExpectStatusCode => 200;
Expand Down
2 changes: 2 additions & 0 deletions src/Tests/Search/Suggesters/SuggestUrlTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ public class SuggestUrlTests
[U]
public async Task Urls()
{
#pragma warning disable 618
await POST("/project/_suggest")
.Fluent(c => c.Suggest<Project>(s => s))
.Request(c => c.Suggest<Project>(new SuggestRequest<Project>()))
Expand All @@ -30,6 +31,7 @@ await POST("/_suggest")
.Request(c => c.Suggest<Project>(new SuggestRequest()))
.RequestAsync(c => c.SuggestAsync<Project>(new SuggestRequest()))
;
#pragma warning restore 618
}
}
}