Update documentation on master (#4397)

* update docs on master

* add IntervalsFuzzy as known replace

Author: Mpdreamz

docs/code-standards/serialization/formatters.asciidoc

@@ -28,5 +28,59 @@ foreach (var formatter in formatters)
         visible.Add(formatter.Name);
 }
 visible.Should().BeEmpty();
+
+Type GetFormatterTargetType(Type t)
+{
+    var attribute = t.GetCustomAttribute<JsonFormatterAttribute>();
+
+    if (attribute == null)
+        return null;
+
+    var formatterType = attribute.FormatterType;
+
+    if (formatterType.IsGenericType && !formatterType.IsConstructedGenericType)
+        return null;
+
+    return formatterType.GetInterfaces()
+        .Where(i => i.IsGenericType && i.GetGenericTypeDefinition() == typeof(IJsonFormatter<>))
+        .Select(i => i.GetGenericArguments()[0])
+        .Single();
+}
+
+var typesAndProperties =
+    from t in typeof(IElasticClient).Assembly.GetTypes().Concat(typeof(IElasticLowLevelClient).Assembly.GetTypes())
+    let p = t.GetProperties()
+    let typeHasFormatter = t.GetCustomAttribute<JsonFormatterAttribute>(false) != null
+    let propertiesHaveFormatter = p.Any(pp => pp.GetCustomAttribute<JsonFormatterAttribute>(false) != null)
+    where typeHasFormatter || propertiesHaveFormatter
+    select new { Type = t, TypeHasFormatter = typeHasFormatter, Properties = p, PropertiesHaveFormatter = propertiesHaveFormatter };
+
+var invalid = new List<string>();
+
+foreach (var typeAndProperties in typesAndProperties)
+{
+    if (typeAndProperties.TypeHasFormatter)
+    {
+        var t = typeAndProperties.Type;
+        var f = GetFormatterTargetType(t);
+
+        if (f != null && t != f)
+            invalid.Add($"{t.FullName} has IJsonFormatter<{f.FullName}>");
+    }
+
+    if (typeAndProperties.PropertiesHaveFormatter)
+    {
+        foreach (var property in typeAndProperties.Properties)
+        {
+            var t = property.PropertyType;
+            var f = GetFormatterTargetType(t);
+
+            if (f != null && t != f)
+                invalid.Add($"property {property.Name} on {typeAndProperties.Type.FullName} has IJsonFormatter<{f.FullName}>");
+        }
+    }
+}
+
+invalid.Should().BeEmpty();
 ----
 

docs/query-dsl.asciidoc

@@ -49,13 +49,13 @@ NEST exposes all of the full text queries available in Elasticsearch
 
 * <<intervals-usage,Intervals Usage>>
 
-* <<match-usage,Match Usage>>
-
 * <<match-bool-prefix-usage,Match Bool Prefix Usage>>
 
+* <<match-phrase-prefix-usage,Match Phrase Prefix Usage>>
+
 * <<match-phrase-usage,Match Phrase Usage>>
 
-* <<match-phrase-prefix-usage,Match Phrase Prefix Usage>>
+* <<match-usage,Match Usage>>
 
 * <<multi-match-usage,Multi Match Usage>>
 
@@ -71,13 +71,13 @@ include::query-dsl/full-text/common-terms/common-terms-usage.asciidoc[]
 
 include::query-dsl/full-text/intervals/intervals-usage.asciidoc[]
 
-include::query-dsl/full-text/match/match-usage.asciidoc[]
-
 include::query-dsl/full-text/match-bool-prefix/match-bool-prefix-usage.asciidoc[]
 
+include::query-dsl/full-text/match-phrase-prefix/match-phrase-prefix-usage.asciidoc[]
+
 include::query-dsl/full-text/match-phrase/match-phrase-usage.asciidoc[]
 
-include::query-dsl/full-text/match-phrase-prefix/match-phrase-prefix-usage.asciidoc[]
+include::query-dsl/full-text/match/match-usage.asciidoc[]
 
 include::query-dsl/full-text/multi-match/multi-match-usage.asciidoc[]
 
@@ -122,14 +122,14 @@ NEST exposes all of the term queries available in Elasticsearch
 
 * <<term-query-usage,Term Query Usage>>
 
+* <<terms-set-query-usage,Terms Set Query Usage>>
+
 * <<terms-list-query-usage,Terms List Query Usage>>
 
 * <<terms-lookup-query-usage,Terms Lookup Query Usage>>
 
 * <<terms-query-usage,Terms Query Usage>>
 
-* <<terms-set-query-usage,Terms Set Query Usage>>
-
 * <<wildcard-query-usage,Wildcard Query Usage>>
 
 See the Elasticsearch documentation on {ref_current}/term-level-queries.html[Term level queries] for more details.
@@ -160,14 +160,14 @@ include::query-dsl/term-level/regexp/regexp-query-usage.asciidoc[]
 
 include::query-dsl/term-level/term/term-query-usage.asciidoc[]
 
+include::query-dsl/term-level/terms-set/terms-set-query-usage.asciidoc[]
+
 include::query-dsl/term-level/terms/terms-list-query-usage.asciidoc[]
 
 include::query-dsl/term-level/terms/terms-lookup-query-usage.asciidoc[]
 
 include::query-dsl/term-level/terms/terms-query-usage.asciidoc[]
 
-include::query-dsl/term-level/terms-set/terms-set-query-usage.asciidoc[]
-
 include::query-dsl/term-level/wildcard/wildcard-query-usage.asciidoc[]
 
 [[compound-queries]]
@@ -283,10 +283,10 @@ Specialized types of queries that do not fit into other groups
 
 * <<rank-feature-query-usage,Rank Feature Query Usage>>
 
-* <<script-query-usage,Script Query Usage>>
-
 * <<script-score-query-usage,Script Score Query Usage>>
 
+* <<script-query-usage,Script Query Usage>>
+
 * <<shape-query-usage,Shape Query Usage>>
 
 See the Elasticsearch documentation on {ref_current}/specialized-queries.html[Specialized queries] for more details.
@@ -305,10 +305,10 @@ include::query-dsl/specialized/pinned/pinned-query-usage.asciidoc[]
 
 include::query-dsl/specialized/rank-feature/rank-feature-query-usage.asciidoc[]
 
-include::query-dsl/specialized/script/script-query-usage.asciidoc[]
-
 include::query-dsl/specialized/script-score/script-score-query-usage.asciidoc[]
 
+include::query-dsl/specialized/script/script-query-usage.asciidoc[]
+
 include::query-dsl/specialized/shape/shape-query-usage.asciidoc[]
 
 [[span-queries]]

docs/query-dsl/full-text/intervals/intervals-usage.asciidoc

@@ -249,3 +249,61 @@ new IntervalsQuery
 }
 ----
 
+[float]
+=== Fuzzy rules
+
+Fuzzy rules can be used to match terms that are similar to the provided term, within an edit distance defined by Fuzziness.
+If the fuzzy expansion matches more than 128 terms, Elasticsearch returns an error.
+
+NOTE: Only available in Elasticsearch 7.6.0+
+
+==== Fluent DSL example
+
+[source,csharp]
+----
+q
+.Intervals(c => c
+    .Field(p => p.Description)
+    .Name("named_query")
+    .Boost(1.1)
+    .Fuzzy(m => m
+        .Term(IntervalsFuzzy)
+        .Fuzziness(Fuzziness.Auto)
+    )
+)
+----
+
+==== Object Initializer syntax example
+
+[source,csharp]
+----
+new IntervalsQuery
+{
+    Field = Field<Project>(p => p.Description),
+    Name = "named_query",
+    Boost = 1.1,
+    Fuzzy = new IntervalsFuzzy
+    {
+        Term = IntervalsFuzzy,
+        Fuzziness = Fuzziness.Auto
+    }
+}
+----
+
+[source,javascript]
+.Example json output
+----
+{
+  "intervals": {
+    "description": {
+      "_name": "named_query",
+      "boost": 1.1,
+      "fuzzy": {
+        "term": "lorem",
+        "fuzziness": "AUTO"
+      }
+    }
+  }
+}
+----
+

src/DocGenerator/StringExtensions.cs

@@ -39,6 +39,7 @@ public static class StringExtensions
 			{ "Project.First.Name", "\"Lesch Group\"" },
 			{ "Project.First.NumberOfCommits", "775" },
 			{ "IntervalsPrefix", "\"lorem\"" },
+			{ "IntervalsFuzzy", "\"lorem\"" },
 			{ "LastNameSearch", "\"Stokes\"" },
 			{ "_first.Language", "\"painless\"" },
 			{ "_first.Init", "\"state.map = [:]\"" },