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

…suggest through Search() (elastic#2562)
Artesian · Nov 6, 2017 · a96c249 · a96c249
1 parent ad8b6b7
commit a96c249
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/src/Nest/Search/Suggesters/Suggest/ElasticClient-Suggest.cs b/src/Nest/Search/Suggesters/Suggest/ElasticClient-Suggest.cs
@@ -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;
 
@@ -30,21 +34,25 @@ Task<ISuggestResponse<T>> SuggestAsync<T>(ISuggestRequest request, CancellationT
 	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>>(

diff --git a/src/Tests/Search/Suggesters/SuggestApiTests.cs b/src/Tests/Search/Suggesters/SuggestApiTests.cs
@@ -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;

diff --git a/src/Tests/Search/Suggesters/SuggestUrlTests.cs b/src/Tests/Search/Suggesters/SuggestUrlTests.cs
@@ -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>()))
@@ -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
 		}
 	}
 }