Regenerate documentation

Author: russcam

docs/aggregations.asciidoc

@@ -62,6 +62,8 @@ The values are typically extracted from the fields of the document (using the fi
 
 * <<value-count-aggregation-usage,Value Count Aggregation Usage>>
 
+* <<weighted-average-aggregation-usage,Weighted Average Aggregation Usage>>
+
 See the Elasticsearch documentation on {ref_current}/search-aggregations-metrics.html[Metric aggregations] for more details.
 
 :includes-from-dirs: aggregations/metric
@@ -94,6 +96,8 @@ include::aggregations/metric/top-hits/top-hits-aggregation-usage.asciidoc[]
 
 include::aggregations/metric/value-count/value-count-aggregation-usage.asciidoc[]
 
+include::aggregations/metric/weighted-average/weighted-average-aggregation-usage.asciidoc[]
+
 [[bucket-aggregations]]
 == Bucket Aggregations
 
@@ -233,6 +237,8 @@ There are many different types of pipeline aggregation, each computing different
 
 * <<moving-average-simple-aggregation-usage,Moving Average Simple Aggregation Usage>>
 
+* <<moving-function-aggregation-usage,Moving Function Aggregation Usage>>
+
 * <<percentiles-bucket-aggregation-usage,Percentiles Bucket Aggregation Usage>>
 
 * <<serial-differencing-aggregation-usage,Serial Differencing Aggregation Usage>>
@@ -273,6 +279,8 @@ include::aggregations/pipeline/moving-average/moving-average-linear-aggregation-
 
 include::aggregations/pipeline/moving-average/moving-average-simple-aggregation-usage.asciidoc[]
 
+include::aggregations/pipeline/moving-function/moving-function-aggregation-usage.asciidoc[]
+
 include::aggregations/pipeline/percentiles-bucket/percentiles-bucket-aggregation-usage.asciidoc[]
 
 include::aggregations/pipeline/serial-differencing/serial-differencing-aggregation-usage.asciidoc[]

docs/aggregations/bucket/composite/composite-aggregation-usage.asciidoc

@@ -145,7 +145,7 @@ new CompositeAggregation("my_buckets")
 
 ==== Handling Responses
 
-Each Composite aggregation bucket key is an `CompositeKey`, a specialized
+Each Composite aggregation bucket key is a `CompositeKey` type, a specialized
 `IReadOnlyDictionary<string, object>` type with methods to convert values to supported types
 
 [source,csharp]
@@ -185,3 +185,133 @@ foreach (var item in composite.Buckets)
 }
 ----
 
+[float]
+=== Missing buckets
+
+By default documents without a value for a given source are ignored.
+It is possible to include them in the response by setting missing_bucket to `true` (defaults to `false`):
+
+NOTE: Only available in Elasticsearch 6.4.0+
+
+==== Fluent DSL example
+
+[source,csharp]
+----
+a => a
+.Composite("my_buckets", date => date
+    .Sources(s => s
+        .Terms("branches", t => t
+            .Field(f => f.Branches.Suffix("keyword"))
+            .MissingBucket()
+            .Order(SortOrder.Ascending)
+        )
+    )
+    .Aggregations(childAggs => childAggs
+        .Nested("project_tags", n => n
+            .Path(p => p.Tags)
+            .Aggregations(nestedAggs => nestedAggs
+                .Terms("tags", avg => avg.Field(p => p.Tags.First().Name))
+            )
+        )
+    )
+)
+----
+
+==== Object Initializer syntax example
+
+[source,csharp]
+----
+new CompositeAggregation("my_buckets")
+{
+    Sources = new List<ICompositeAggregationSource>
+    {
+        new TermsCompositeAggregationSource("branches")
+        {
+            Field = Infer.Field<Project>(f => f.Branches.Suffix("keyword")),
+            MissingBucket = true,
+            Order = SortOrder.Ascending
+        }
+    },
+    Aggregations = new NestedAggregation("project_tags")
+    {
+        Path = Field<Project>(p => p.Tags),
+        Aggregations = new TermsAggregation("tags")
+        {
+            Field = Field<Project>(p => p.Tags.First().Name)
+        }
+    }
+}
+----
+
+[source,javascript]
+.Example json output
+----
+{
+  "my_buckets": {
+    "composite": {
+      "sources": [
+        {
+          "branches": {
+            "terms": {
+              "field": "branches.keyword",
+              "order": "asc",
+              "missing_bucket": true
+            }
+          }
+        }
+      ]
+    },
+    "aggs": {
+      "project_tags": {
+        "nested": {
+          "path": "tags"
+        },
+        "aggs": {
+          "tags": {
+            "terms": {
+              "field": "tags.name"
+            }
+          }
+        }
+      }
+    }
+  }
+}
+----
+
+==== Handling Responses
+
+Each Composite aggregation bucket key is an `CompositeKey`, a specialized
+`IReadOnlyDictionary<string, object>` type with methods to convert values to supported types
+
+[source,csharp]
+----
+response.ShouldBeValid();
+
+var composite = response.Aggregations.Composite("my_buckets");
+composite.Should().NotBeNull();
+composite.Buckets.Should().NotBeNullOrEmpty();
+composite.AfterKey.Should().NotBeNull();
+
+if (TestConfiguration.Instance.InRange(">=6.3.0"))
+    composite.AfterKey.Should().HaveCount(1).And.ContainKeys("branches");
+
+var i = 0;
+foreach (var item in composite.Buckets)
+{
+    var key = item.Key;
+    key.Should().NotBeNull();
+
+    key.TryGetValue("branches", out string branches).Should().BeTrue("expected to find 'branches' in composite bucket");
+    if (i == 0) branches.Should().BeNull("First key should be null as we expect to have some projects with no branches");
+    else branches.Should().NotBeNullOrEmpty();
+
+    var nested = item.Nested("project_tags");
+    nested.Should().NotBeNull();
+
+    var nestedTerms = nested.Terms("tags");
+    nestedTerms.Buckets.Count.Should().BeGreaterThan(0);
+    i++;
+}
+----
+

docs/aggregations/bucket/date-histogram/date-histogram-aggregation-usage.asciidoc

@@ -114,14 +114,12 @@ new DateHistogramAggregation("projects_started_per_month")
 }
 ----
 
-=== Handling responses
+==== Handling responses
 
 The `AggregateDictionary found on `.Aggregations` on `ISearchResponse<T>` has several helper methods
 so we can fetch our aggregation results easily in the correct type.
 <<handling-aggregate-response, Be sure to read more about these helper methods>>
 
-==== Handling Responses
-
 [source,csharp]
 ----
 response.ShouldBeValid();

docs/aggregations/bucket/date-range/date-range-aggregation-usage.asciidoc

@@ -93,14 +93,12 @@ new DateRangeAggregation("projects_date_ranges")
 }
 ----
 
-=== Handling Responses
+==== Handling Responses
 
 The `AggregateDictionary found on `.Aggregations` on `ISearchResponse<T>` has several helper methods
 so we can fetch our aggregation results easily in the correct type.
 <<handling-aggregate-response, Be sure to read more about these helper methods>>
 
-==== Handling Responses
-
 [source,csharp]
 ----
 response.ShouldBeValid();

docs/aggregations/bucket/filter/filter-aggregation-usage.asciidoc

@@ -68,14 +68,12 @@ new FilterAggregation("bethels_projects")
 }
 ----
 
-=== Handling Responses
+==== Handling Responses
 
 The `AggregateDictionary found on `.Aggregations` on `ISearchResponse<T>` has several helper methods
 so we can fetch our aggregation results easily in the correct type.
 <<handling-aggregate-response, Be sure to read more about these helper methods>>
 
-==== Handling Responses
-
 [source,csharp]
 ----
 response.ShouldBeValid();
@@ -89,7 +87,7 @@ tags.Buckets.Should().NotBeEmpty();
 ----
 
 [float]
-== Empty Filter
+=== Empty Filter
 
 When the collection of filters is empty or all are conditionless, NEST will serialize them
 to an empty object.
@@ -138,54 +136,3 @@ new FilterAggregation("empty_filter")
 response.ShouldNotBeValid();
 ----
 
-==== Fluent DSL example
-
-[source,csharp]
-----
-a => a
-.Filter(_aggName, date => date
-    .Filter(f => f
-        .Script(b => b
-            .Source(_ctxNumberofCommits)
-        )
-    )
-)
-----
-
-==== Object Initializer syntax example
-
-[source,csharp]
-----
-new FilterAggregation(_aggName)
-{
-    Filter = new ScriptQuery
-    {
-        Source = _ctxNumberofCommits
-    }
-}
-----
-
-[source,javascript]
-.Example json output
-----
-{
-  "script_filter": {
-    "filter": {
-      "script": {
-        "script": {
-          "source": "_source.numberOfCommits > 0"
-        }
-      }
-    }
-  }
-}
-----
-
-==== Handling Responses
-
-[source,csharp]
-----
-response.ShouldBeValid();
-response.Aggregations.Filter(_aggName).DocCount.Should().BeGreaterThan(0);
-----
-

docs/aggregations/bucket/ip-range/ip-range-aggregation-usage.asciidoc

@@ -74,6 +74,11 @@ ipRanges.Should().NotBeNull();
 ipRanges.Buckets.Should().NotBeNull();
 ipRanges.Buckets.Count.Should().BeGreaterThan(0);
 foreach (var range in ipRanges.Buckets)
+{
+    if (TestConfiguration.Instance.InRange("6.4.0"))
+        range.Key.Should().NotBeNullOrEmpty();
+
     range.DocCount.Should().BeGreaterThan(0);
+}
 ----
 

docs/aggregations/metric/weighted-average/weighted-average-aggregation-usage.asciidoc

@@ -0,0 +1,83 @@
+:ref_current: https://www.elastic.co/guide/en/elasticsearch/reference/6.3
+
+:github: https://github.com/elastic/elasticsearch-net
+
+:nuget: https://www.nuget.org/packages
+
+////
+IMPORTANT NOTE
+==============
+This file has been generated from https://github.com/elastic/elasticsearch-net/tree/6.x/src/Tests/Aggregations/Metric/WeightedAverage/WeightedAverageAggregationUsageTests.cs. 
+If you wish to submit a PR for any spelling mistakes, typos or grammatical errors for this file,
+please modify the original csharp file found at the link and submit the PR with that change. Thanks!
+////
+
+[[weighted-average-aggregation-usage]]
+=== Weighted Average Aggregation Usage
+
+A single-value metrics aggregation that computes the weighted average of numeric values that are extracted
+from the aggregated documents. These values can be extracted either from specific numeric fields in the documents.
+When calculating a regular average, each datapoint has an equal "weight" i.e. it contributes equally to the final
+value. Weighted averages, on the other hand, weight each datapoint differently. The amount that each
+datapoint contributes to the final value is extracted from the document, or provided by a script.
+
+Be sure to read the Elasticsearch documentation on {ref_current}/search-aggregations-metrics-weight-avg-aggregation.html[Weighted Avg Aggregation]
+
+==== Fluent DSL example
+
+[source,csharp]
+----
+a => a
+.WeightedAverage("weighted_avg_commits", avg => avg
+    .Value(v => v.Field(p => p.NumberOfCommits).Missing(0))
+    .Weight(w => w.Script("doc.numberOfContributors.value + 1"))
+    .ValueType(ValueType.Long)
+)
+----
+
+==== Object Initializer syntax example
+
+[source,csharp]
+----
+new WeightedAverageAggregation("weighted_avg_commits")
+{
+    Value = new WeightedAverageValue(Field<Project>(p => p.NumberOfCommits))
+    {
+        Missing = 0
+    },
+    Weight = new WeightedAverageValue(new InlineScript("doc.numberOfContributors.value + 1")),
+    ValueType = ValueType.Long
+}
+----
+
+[source,javascript]
+.Example json output
+----
+{
+  "weighted_avg_commits": {
+    "weighted_avg": {
+      "value": {
+        "field": "numberOfCommits",
+        "missing": 0.0
+      },
+      "weight": {
+        "script": {
+          "source": "doc.numberOfContributors.value + 1"
+        }
+      },
+      "value_type": "long"
+    }
+  }
+}
+----
+
+==== Handling Responses
+
+[source,csharp]
+----
+response.ShouldBeValid();
+var commitsAvg = response.Aggregations.WeightedAverage("weighted_avg_commits");
+commitsAvg.Should().NotBeNull();
+commitsAvg.Value.Should().BeGreaterThan(0);
+----
+

docs/aggregations/pipeline/moving-average/moving-average-simple-aggregation-usage.asciidoc

@@ -98,7 +98,7 @@ projectsPerMonth.Should().NotBeNull();
 projectsPerMonth.Buckets.Should().NotBeNull();
 projectsPerMonth.Buckets.Count.Should().BeGreaterThan(0);
 
-// average not calculated for the first bucket
+// average not calculated for the first bucket so movingAvg.Value is expected to be null there
 foreach(var item in projectsPerMonth.Buckets.Skip(1))
 {
     var movingAvg = item.Sum("commits_moving_avg");