Addition of [Obsolete(...)] attributes to 5.x (#3023)

Mark code as Obsolete as warning for 5.x users who are considering upgrade to 6.x

Author: Stuart Cam

src/Nest/Aggregations/Bucket/Histogram/HistogramAggregation.cs

@@ -47,7 +47,11 @@ public class HistogramAggregation : BucketAggregationBase, IHistogramAggregation
 		public int? MinimumDocumentCount { get; set; }
 		public HistogramOrder Order { get; set; }
 		public ExtendedBounds<double> ExtendedBounds { get; set; }
+
+		[Obsolete("Removed in Elasticsearch 2.0. Will be removed in the next major version of NEST")]
 		public long? PreOffset { get; set; }
+
+		[Obsolete("Removed in Elasticsearch 2.0. Will be removed in the next major version of NEST")]
 		public long? PostOffset { get; set; }
 		public double? Offset { get; set; }
 		public double? Missing { get; set; }
@@ -75,10 +79,12 @@ public class HistogramAggregationDescriptor<T>
 
 		ExtendedBounds<double> IHistogramAggregation.ExtendedBounds { get; set; }
 
+		[Obsolete("Removed in Elasticsearch 2.0. Will be removed in the next major version of NEST")]
 		long? IHistogramAggregation.PreOffset { get; set; }
-		
+
+		[Obsolete("Removed in Elasticsearch 2.0. Will be removed in the next major version of NEST")]
 		long? IHistogramAggregation.PostOffset { get; set; }
-		
+
 		double? IHistogramAggregation.Offset { get; set; }
 
 		double? IHistogramAggregation.Missing { get; set; }
@@ -113,7 +119,7 @@ public HistogramAggregationDescriptor<T> ExtendedBounds(double min, double max)
 
 		[Obsolete("Removed in Elasticsearch 2.0. Will be removed in the next major version of NEST")]
 		public HistogramAggregationDescriptor<T> PostOffset(long postOffset) => this;
-		
+
 		public HistogramAggregationDescriptor<T> Offset(double offset) => Assign(a => a.Offset = offset);
 
 		public HistogramAggregationDescriptor<T> Missing(double missing) => Assign(a => a.Missing = missing);

src/Nest/Aggregations/Bucket/SignificantTerms/SignificantTermsAggregation.cs

@@ -201,12 +201,12 @@ public class SignificantTermsAggregationDescriptor<T>
 
 		TermsAggregationExecutionHint? ISignificantTermsAggregation.ExecutionHint { get; set; }
 
-		[Obsolete("Deprecated and will be fixed in 6.0. Use IncludeTerms")]
+		[Obsolete("Deprecated, will be fixed in 6.0. Use IncludeTerms")]
 		IDictionary<string, string> ISignificantTermsAggregation.Include { get; set; }
 
 		SignificantTermsIncludeExclude ISignificantTermsAggregation.IncludeTerms { get; set; }
 
-		[Obsolete("Deprecated and will be fixed in 6.0. Use ExcludeTerms")]
+		[Obsolete("Deprecated, will be fixed in 6.0. Use ExcludeTerms")]
 		IDictionary<string, string> ISignificantTermsAggregation.Exclude { get; set; }
 
 		SignificantTermsIncludeExclude ISignificantTermsAggregation.ExcludeTerms { get; set; }

src/Nest/Aggregations/Bucket/Terms/TermsAggregation.cs

@@ -124,12 +124,14 @@ public TermsAggregationDescriptor<T> Order(TermsOrder order) => Assign(a =>
 			a.Order.Add(order);
 		});
 
+		[Obsolete("Removed in NEST 6.x, use Order()")]
 		public TermsAggregationDescriptor<T> OrderAscending(string key) => Assign(a =>
 		{
 			a.Order = a.Order ?? new List<TermsOrder>();
 			a.Order.Add(new TermsOrder { Key = key, Order = SortOrder.Ascending });
 		});
 
+		[Obsolete("Removed in NEST 6.x, use Order()")]
 		public TermsAggregationDescriptor<T> OrderDescending(string key) => Assign(a =>
 		{
 			a.Order = a.Order ?? new List<TermsOrder>();

src/Nest/Aggregations/Metric/TopHits/TopHitsAggregation.cs

@@ -30,6 +30,7 @@ public interface ITopHitsAggregation : IMetricAggregation
 		[JsonConverter(typeof(ReadAsTypeJsonConverter<ScriptFields>))]
 		IScriptFields ScriptFields { get; set; }
 
+		[Obsolete("Removed in NEST 6.x")]
 		[JsonProperty("fielddata_fields")]
 		Fields FielddataFields { get; set; }
 
@@ -52,6 +53,8 @@ public class TopHitsAggregation : MetricAggregationBase, ITopHitsAggregation
 		public IHighlight Highlight { get; set; }
 		public bool? Explain { get; set; }
 		public IScriptFields ScriptFields { get; set; }
+
+		[Obsolete("Removed in NEST 6.x")]
 		public Fields FielddataFields { get; set; }
 		public Fields StoredFields { get; set; }
 		public bool? Version { get; set; }
@@ -83,6 +86,7 @@ public class TopHitsAggregationDescriptor<T>
 
 		IScriptFields ITopHitsAggregation.ScriptFields { get; set; }
 
+		[Obsolete("Removed in NEST 6.x")]
 		Fields ITopHitsAggregation.FielddataFields { get; set; }
 
 		Fields ITopHitsAggregation.StoredFields { get; set; }

src/Nest/Analysis/TokenFilters/HunspellTokenFilter.cs

@@ -1,9 +1,10 @@
-using Newtonsoft.Json;
+using System;
+using Newtonsoft.Json;
 
 namespace Nest
 {
 	/// <summary>
-	/// Basic support for hunspell stemming. 
+	/// Basic support for hunspell stemming.
 	///<para> Hunspell dictionaries will be picked up from a dedicated hunspell directory on the filesystem.</para>
 	/// </summary>
 	public interface IHunspellTokenFilter : ITokenFilter
@@ -12,6 +13,7 @@ public interface IHunspellTokenFilter : ITokenFilter
 		/// If true, dictionary matching will be case insensitive.
 		/// </summary>
 		[JsonProperty("ignore_case")]
+		[Obsolete("Scheduled to be removed in 6.x - consider using a lowercase token filter before a hunspell token filter.")]
 		bool? IgnoreCase { get; set; }
 
 		/// <summary>
@@ -21,7 +23,7 @@ public interface IHunspellTokenFilter : ITokenFilter
 		string Locale { get; set; }
 
 		/// <summary>
-		/// The name of a dictionary.The path to your hunspell dictionaries should be configured via 
+		/// The name of a dictionary.The path to your hunspell dictionaries should be configured via
 		/// `indices.analysis.hunspell.dictionary.location` before.
 		/// </summary>
 		[JsonProperty("dictionary")]
@@ -44,9 +46,10 @@ public interface IHunspellTokenFilter : ITokenFilter
 	/// <inheritdoc/>
 	public class HunspellTokenFilter : TokenFilterBase, IHunspellTokenFilter
 	{
-		public HunspellTokenFilter() : base("hunspell") { } 
+		public HunspellTokenFilter() : base("hunspell") { }
 
 		/// <inheritdoc/>
+		[Obsolete("Scheduled to be removed in 6.x - consider using a lowercase token filter before a hunspell token filter.")]
 		public bool? IgnoreCase { get; set; }
 
 		/// <inheritdoc/>
@@ -65,13 +68,15 @@ public HunspellTokenFilter() : base("hunspell") { }
 	}
 
 	///<inheritdoc/>
-	public class HunspellTokenFilterDescriptor 
+	public class HunspellTokenFilterDescriptor
 		: TokenFilterDescriptorBase<HunspellTokenFilterDescriptor, IHunspellTokenFilter>, IHunspellTokenFilter
 	{
 		protected override string Type => "hunspell";
 
 		bool? IHunspellTokenFilter.LongestOnly { get; set; }
 		bool? IHunspellTokenFilter.Dedup { get; set; }
+
+		[Obsolete("Scheduled to be removed in 6.x - consider using a lowercase token filter before a hunspell token filter.")]
 		bool? IHunspellTokenFilter.IgnoreCase { get; set; }
 		string IHunspellTokenFilter.Locale { get; set; }
 		string IHunspellTokenFilter.Dictionary { get; set; }
@@ -83,6 +88,7 @@ public class HunspellTokenFilterDescriptor
 		public HunspellTokenFilterDescriptor Dedup(bool? dedup = true) => Assign(a => a.Dedup = dedup);
 
 		///<inheritdoc/>
+		[Obsolete("Scheduled to be removed in 6.x - consider using a lowercase token filter before a hunspell token filter.")]
 		public HunspellTokenFilterDescriptor IgnoreCase(bool? ignoreCase = true) => Assign(a => a.IgnoreCase = ignoreCase);
 
 		///<inheritdoc/>
@@ -93,4 +99,4 @@ public class HunspellTokenFilterDescriptor
 
 	}
 
-}
+}

src/Nest/Cluster/NodesStats/NodeStats.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using Newtonsoft.Json;
 
 namespace Nest
@@ -391,6 +392,7 @@ public class DataPathStats
 			[JsonProperty("type")]
 			public string Type { get; internal set; }
 			[JsonProperty("spins")]
+			[Obsolete("Scheduled to be removed in 6.0")]
 			public bool? Spins { get; internal set; }
 			[JsonProperty("total")]
 			public string Total { get; internal set; }

src/Nest/CommonAbstractions/ConnectionSettings/ClrTypeMapping.cs

@@ -7,10 +7,10 @@ namespace Nest
 {
 	public interface IClrTypeMapping<T> where T : class
 	{
-		Type Type { get; } 
+		Type Type { get; }
 
 		/// <summary>
-		/// When specified dictates the default Elasticsearch index name for <typeparamref name="T"/> 
+		/// When specified dictates the default Elasticsearch index name for <typeparamref name="T"/>
 		/// </summary>
 		string IndexName { get; set; }
 
@@ -20,10 +20,10 @@ public interface IClrTypeMapping<T> where T : class
 		string TypeName { get; set; }
 
 		/// <summary>
-		/// Allows you to set a default Id property on <typeparamref name="T" /> that NEST will evaluate 
+		/// Allows you to set a default Id property on <typeparamref name="T" /> that NEST will evaluate
 		/// </summary>
 		Expression<Func<T, object>> IdProperty { get; set; }
-		
+
 		/// <summary>
 		/// When specified allows you to ignore or rename certain properties of clr type <typeparamref name="T" />
 		/// </summary>
@@ -35,7 +35,7 @@ public class ClrTypeMapping<T> : IClrTypeMapping<T> where T : class
 		public Type Type { get; } = typeof (T);
 
 		/// <summary>
-		/// When specified dictates the default Elasticsearch index name for <typeparamref name="T"/> 
+		/// When specified dictates the default Elasticsearch index name for <typeparamref name="T"/>
 		/// </summary>
 		public string IndexName { get; set; }
 
@@ -45,7 +45,7 @@ public class ClrTypeMapping<T> : IClrTypeMapping<T> where T : class
 		public string TypeName { get; set; }
 
 		/// <summary>
-		/// Allows you to set a default Id property on <typeparamref name="T" /> that NEST will evaluate 
+		/// Allows you to set a default Id property on <typeparamref name="T" /> that NEST will evaluate
 		/// </summary>
 		public Expression<Func<T, object>> IdProperty { get; set; }
 
@@ -62,7 +62,7 @@ public class ClrTypeMappingDescriptor<T> : DescriptorBase<ClrTypeMappingDescript
 		IList<IClrTypePropertyMapping<T>> IClrTypeMapping<T>.Properties { get; set; } = new List<IClrTypePropertyMapping<T>>();
 
 		/// <summary>
-		/// When specified dictates the default Elasticsearch index name for <typeparamref name="T"/> 
+		/// When specified dictates the default Elasticsearch index name for <typeparamref name="T"/>
 		/// </summary>
 		public ClrTypeMappingDescriptor<T> IndexName(string indexName) => Assign(a => a.IndexName = indexName);
 
@@ -72,20 +72,20 @@ public class ClrTypeMappingDescriptor<T> : DescriptorBase<ClrTypeMappingDescript
 		public ClrTypeMappingDescriptor<T> TypeName(string typeName) => Assign(a => a.TypeName = typeName);
 
 		/// <summary>
-		/// Allows you to set a default Id property on <typeparamref name="T" /> that NEST will evaluate 
+		/// Allows you to set a default Id property on <typeparamref name="T" /> that NEST will evaluate
 		/// </summary>
 		public ClrTypeMappingDescriptor<T> IdProperty(Expression<Func<T, object>> property) => Assign(a => a.IdProperty = property);
 
 		/// <summary>
 		/// When specified allows you to ignore <param name="property"></param> on clr type <typeparamref name="T" />
 		/// </summary>
-		public ClrTypeMappingDescriptor<T> Ignore(Expression<Func<T, object>> property) => 
+		public ClrTypeMappingDescriptor<T> Ignore(Expression<Func<T, object>> property) =>
 			Assign(a => a.Properties.Add(new IgnorePropertyMapping<T>(property)));
 
 		/// <summary>
 		/// When specified allows you to rename <param name="property"></param> on clr type <typeparamref name="T" />
 		/// </summary>
-		public ClrTypeMappingDescriptor<T> Rename(Expression<Func<T, object>> property, string newName) => 
+		public ClrTypeMappingDescriptor<T> Rename(Expression<Func<T, object>> property, string newName) =>
 			Assign(a => a.Properties.Add(new RenamePropertyMapping<T>(property, newName)));
 
 	}

src/Nest/CommonAbstractions/ConnectionSettings/ConnectionSettingsBase.cs

@@ -116,7 +116,7 @@ IElasticsearchSerializer IConnectionSettingsValues.StatefulSerializer(JsonConver
 		/// <summary>
 		/// Pluralize type names when inferring from POCO type names.
 		/// <para></para>
-		/// This calls <see cref="DefaultTypeNameInferrer"/> with an implementation that will pluralize type names. 
+		/// This calls <see cref="DefaultTypeNameInferrer"/> with an implementation that will pluralize type names.
 		/// This used to be the default prior to Nest 0.90
 		/// </summary>
 		public TConnectionSettings PluralizeTypeNames()
@@ -146,7 +146,7 @@ private string LowerCaseAndPluralizeTypeNameInferrer(Type type)
 		/// <summary>
 		/// Specify how field names are inferred from POCO property names.
 		/// <para></para>
-		/// By default, NEST camel cases property names 
+		/// By default, NEST camel cases property names
 		/// e.g. EmailAddress POCO property => "emailAddress" Elasticsearch document field name
 		/// </summary>
 		public TConnectionSettings DefaultFieldNameInferrer(Func<string, string> fieldNameInferrer)
@@ -156,7 +156,7 @@ public TConnectionSettings DefaultFieldNameInferrer(Func<string, string> fieldNa
 		}
 
 		/// <summary>
-		/// Specify how type names are inferred from POCO types. 
+		/// Specify how type names are inferred from POCO types.
 		/// By default, type names are inferred by calling <see cref="string.ToLowerInvariant"/>
 		///  on the type's name.
 		/// </summary>
@@ -168,9 +168,10 @@ public TConnectionSettings DefaultTypeNameInferrer(Func<Type, string> typeNameIn
 		}
 
         /// <summary>
-        /// Specify the default index names for a given POCO type. 
+        /// Specify the default index names for a given POCO type.
         /// Takes precedence over the global <see cref="DefaultIndex"/>
         /// </summary>
+        /// <remarks>Removed in 6.x.</remarks>
         public TConnectionSettings MapDefaultTypeIndices(Action<FluentDictionary<Type, string>> mappingSelector)
 		{
 			mappingSelector.ThrowIfNull(nameof(mappingSelector));
@@ -179,9 +180,10 @@ public TConnectionSettings MapDefaultTypeIndices(Action<FluentDictionary<Type, s
 		}
 
 		/// <summary>
-		/// Specify the default type names for a given POCO type. 
+		/// Specify the default type names for a given POCO type.
 		/// Takes precedence over the global <see cref="DefaultTypeNameInferrer"/>
 		/// </summary>
+		/// <remarks>Removed in 6.x.</remarks>
 		public TConnectionSettings MapDefaultTypeNames(Action<FluentDictionary<Type, string>> mappingSelector)
 		{
 			mappingSelector.ThrowIfNull(nameof(mappingSelector));
@@ -190,12 +192,13 @@ public TConnectionSettings MapDefaultTypeNames(Action<FluentDictionary<Type, str
 		}
 
         /// <summary>
-        /// Specify which property on a given POCO should be used to infer the id of the document when 
+        /// Specify which property on a given POCO should be used to infer the id of the document when
         /// indexed in Elasticsearch.
         /// </summary>
         /// <typeparam name="TDocument">The type of the document.</typeparam>
         /// <param name="objectPath">The object path.</param>
         /// <returns></returns>
+        /// <remarks>Removed in 6.x.</remarks>
         public TConnectionSettings MapIdPropertyFor<TDocument>(Expression<Func<TDocument, object>> objectPath)
 		{
 			objectPath.ThrowIfNull(nameof(objectPath));
@@ -222,6 +225,7 @@ public TConnectionSettings MapIdPropertyFor<TDocument>(Expression<Func<TDocument
         /// <typeparam name="TDocument">The type of the document.</typeparam>
         /// <param name="propertiesSelector">The properties selector.</param>
         /// <returns></returns>
+        /// <remarks>Removed in 6.x.</remarks>
         public TConnectionSettings MapPropertiesFor<TDocument>(Action<PropertyMappingDescriptor<TDocument>> propertiesSelector)
 			where TDocument : class
 		{
@@ -264,7 +268,7 @@ private void ApplyPropertyMappings<TDocument>(IList<IClrTypePropertyMapping<TDoc
 		}
 
         /// <summary>
-        /// Specify how the mapping is inferred for a given POCO type. 
+        /// Specify how the mapping is inferred for a given POCO type.
         /// Can be used to infer the index, type, id property and properties for the POCO.
         /// </summary>
         /// <typeparam name="TDocument">The type of the document.</typeparam>

src/Nest/CommonOptions/Scripting/FileScript.cs

@@ -1,14 +1,17 @@
-using Newtonsoft.Json;
+using System;
+using Newtonsoft.Json;
 
 namespace Nest
 {
+	/// <remarks>Removed in 6.x</remarks>
 	[JsonObject(MemberSerialization = MemberSerialization.OptIn)]
 	public interface IFileScript : IScript
 	{
 		[JsonProperty("file")]
 		string File { get; set; }
 	}
 
+	/// <remarks>Removed in 6.x</remarks>
 	public class FileScript : ScriptBase, IFileScript
 	{
 		public FileScript(string file)
@@ -19,6 +22,7 @@ public FileScript(string file)
 		public string File { get; set; }
 	}
 
+	/// <remarks>Removed in 6.x</remarks>
 	public class FileScriptDescriptor
 		: ScriptDescriptorBase<FileScriptDescriptor, IFileScript>, IFileScript
 	{

src/Nest/CommonOptions/Scripting/ScriptBase.cs

@@ -42,6 +42,7 @@ public TDescriptor Params(Func<FluentDictionary<string, object>, FluentDictionar
 
 	public class ScriptDescriptor : DescriptorBase<ScriptDescriptor, IDescriptor>
 	{
+		[Obsolete("Removed in NEST 6.x.")]
 		public FileScriptDescriptor File(string file) => new FileScriptDescriptor(file);
 
 		public IndexedScriptDescriptor Indexed(string id) => new IndexedScriptDescriptor(id);