Skip to content

Commit c646b98

Browse files
committed
Update master branch docs
This commit updates the master docs to point to the master branch
1 parent ae09c53 commit c646b98

File tree

217 files changed

+2959
-685
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

217 files changed

+2959
-685
lines changed

docs/aggregations/aggregation-meta-usage.asciidoc

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
////
88
IMPORTANT NOTE
99
==============
10-
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/7.x/src/Tests/Tests/Aggregations/AggregationMetaUsageTests.cs.
10+
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/master/src/Tests/Tests/Aggregations/AggregationMetaUsageTests.cs.
1111
If you wish to submit a PR for any spelling mistakes, typos or grammatical errors for this file,
1212
please modify the original csharp file found at the link and submit the PR with that change. Thanks!
1313
////
@@ -47,6 +47,25 @@ new MinAggregation("min_last_activity", Infer.Field<Project>(p => p.LastActivity
4747
}
4848
----
4949

50+
[source,javascript]
51+
.Example json output
52+
----
53+
{
54+
"min_last_activity": {
55+
"min": {
56+
"field": "lastActivity"
57+
},
58+
"meta": {
59+
"meta_1": "value_1",
60+
"meta_2": 2,
61+
"meta_3": {
62+
"meta_3": "value_3"
63+
}
64+
}
65+
}
66+
}
67+
----
68+
5069
==== Handling Responses
5170

5271
[source,csharp]

docs/aggregations/bucket/adjacency-matrix/adjacency-matrix-usage.asciidoc

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
////
88
IMPORTANT NOTE
99
==============
10-
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/7.x/src/Tests/Tests/Aggregations/Bucket/AdjacencyMatrix/AdjacencyMatrixUsageTests.cs.
10+
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/master/src/Tests/Tests/Aggregations/Bucket/AdjacencyMatrix/AdjacencyMatrixUsageTests.cs.
1111
If you wish to submit a PR for any spelling mistakes, typos or grammatical errors for this file,
1212
please modify the original csharp file found at the link and submit the PR with that change. Thanks!
1313
////
@@ -44,6 +44,40 @@ new AdjacencyMatrixAggregation("interactions")
4444
}
4545
----
4646

47+
[source,javascript]
48+
.Example json output
49+
----
50+
{
51+
"interactions": {
52+
"adjacency_matrix": {
53+
"filters": {
54+
"grpA": {
55+
"term": {
56+
"state": {
57+
"value": "BellyUp"
58+
}
59+
}
60+
},
61+
"grpB": {
62+
"term": {
63+
"state": {
64+
"value": "Stable"
65+
}
66+
}
67+
},
68+
"grpC": {
69+
"term": {
70+
"state": {
71+
"value": "VeryActive"
72+
}
73+
}
74+
}
75+
}
76+
}
77+
}
78+
}
79+
----
80+
4781
==== Handling Responses
4882

4983
[source,csharp]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
////
88
IMPORTANT NOTE
99
==============
10-
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/7.x/src/Tests/Tests/Aggregations/Bucket/AutoDateHistogram/AutoDateHistogramAggregationUsageTests.cs.
10+
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/master/src/Tests/Tests/Aggregations/Bucket/AutoDateHistogram/AutoDateHistogramAggregationUsageTests.cs.
1111
If you wish to submit a PR for any spelling mistakes, typos or grammatical errors for this file,
1212
please modify the original csharp file found at the link and submit the PR with that change. Thanks!
1313
////

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

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
////
88
IMPORTANT NOTE
99
==============
10-
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/7.x/src/Tests/Tests/Aggregations/Bucket/Children/ChildrenAggregationUsageTests.cs.
10+
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/master/src/Tests/Tests/Aggregations/Bucket/Children/ChildrenAggregationUsageTests.cs.
1111
If you wish to submit a PR for any spelling mistakes, typos or grammatical errors for this file,
1212
please modify the original csharp file found at the link and submit the PR with that change. Thanks!
1313
////
@@ -47,3 +47,32 @@ new ChildrenAggregation("name_of_child_agg", typeof(CommitActivity))
4747
}
4848
----
4949

50+
[source,javascript]
51+
.Example json output
52+
----
53+
{
54+
"name_of_child_agg": {
55+
"children": {
56+
"type": "commits"
57+
},
58+
"aggs": {
59+
"average_per_child": {
60+
"avg": {
61+
"field": "confidenceFactor"
62+
}
63+
},
64+
"max_per_child": {
65+
"max": {
66+
"field": "confidenceFactor"
67+
}
68+
},
69+
"min_per_child": {
70+
"min": {
71+
"field": "confidenceFactor"
72+
}
73+
}
74+
}
75+
}
76+
}
77+
----
78+

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

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
////
88
IMPORTANT NOTE
99
==============
10-
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/7.x/src/Tests/Tests/Aggregations/Bucket/Composite/CompositeAggregationUsageTests.cs.
10+
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/master/src/Tests/Tests/Aggregations/Bucket/Composite/CompositeAggregationUsageTests.cs.
1111
If you wish to submit a PR for any spelling mistakes, typos or grammatical errors for this file,
1212
please modify the original csharp file found at the link and submit the PR with that change. Thanks!
1313
////
@@ -93,6 +93,56 @@ new CompositeAggregation("my_buckets")
9393
}
9494
----
9595

96+
[source,javascript]
97+
.Example json output
98+
----
99+
{
100+
"my_buckets": {
101+
"composite": {
102+
"sources": [
103+
{
104+
"branches": {
105+
"terms": {
106+
"field": "branches.keyword"
107+
}
108+
}
109+
},
110+
{
111+
"started": {
112+
"date_histogram": {
113+
"field": "startedOn",
114+
"interval": "month"
115+
}
116+
}
117+
},
118+
{
119+
"branch_count": {
120+
"histogram": {
121+
"field": "requiredBranches",
122+
"interval": 1.0
123+
}
124+
}
125+
}
126+
]
127+
},
128+
"aggs": {
129+
"project_tags": {
130+
"nested": {
131+
"path": "tags"
132+
},
133+
"aggs": {
134+
"tags": {
135+
"terms": {
136+
"field": "tags.name"
137+
}
138+
}
139+
}
140+
}
141+
}
142+
}
143+
}
144+
----
145+
96146
==== Handling Responses
97147

98148
Each Composite aggregation bucket key is a `CompositeKey` type, a specialized
@@ -195,6 +245,42 @@ new CompositeAggregation("my_buckets")
195245
}
196246
----
197247

248+
[source,javascript]
249+
.Example json output
250+
----
251+
{
252+
"my_buckets": {
253+
"composite": {
254+
"sources": [
255+
{
256+
"branches": {
257+
"terms": {
258+
"field": "branches.keyword",
259+
"order": "asc",
260+
"missing_bucket": true
261+
}
262+
}
263+
}
264+
]
265+
},
266+
"aggs": {
267+
"project_tags": {
268+
"nested": {
269+
"path": "tags"
270+
},
271+
"aggs": {
272+
"tags": {
273+
"terms": {
274+
"field": "tags.name"
275+
}
276+
}
277+
}
278+
}
279+
}
280+
}
281+
}
282+
----
283+
198284
==== Handling Responses
199285

200286
Each Composite aggregation bucket key is an `CompositeKey`, a specialized

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

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
////
88
IMPORTANT NOTE
99
==============
10-
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/7.x/src/Tests/Tests/Aggregations/Bucket/DateHistogram/DateHistogramAggregationUsageTests.cs.
10+
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/master/src/Tests/Tests/Aggregations/Bucket/DateHistogram/DateHistogramAggregationUsageTests.cs.
1111
If you wish to submit a PR for any spelling mistakes, typos or grammatical errors for this file,
1212
please modify the original csharp file found at the link and submit the PR with that change. Thanks!
1313
////
@@ -35,7 +35,6 @@ a => a
3535
.Interval(DateInterval.Month)
3636
.MinimumDocumentCount(2)
3737
.Format("yyyy-MM-dd'T'HH:mm:ss")
38-
//.Format("date_optional_time")
3938
.ExtendedBounds(FixedDate.AddYears(-1), FixedDate.AddYears(1))
4039
.Order(HistogramOrder.CountAscending)
4140
.Missing(FixedDate)
@@ -60,7 +59,6 @@ new DateHistogramAggregation("projects_started_per_month")
6059
Interval = DateInterval.Month,
6160
MinimumDocumentCount = 2,
6261
Format = "yyyy-MM-dd'T'HH:mm:ss",
63-
//Format = "date_optional_time",
6462
ExtendedBounds = new ExtendedBounds<DateMath>
6563
{
6664
Minimum = FixedDate.AddYears(-1),
@@ -79,6 +77,43 @@ new DateHistogramAggregation("projects_started_per_month")
7977
}
8078
----
8179

80+
[source,javascript]
81+
.Example json output
82+
----
83+
{
84+
"projects_started_per_month": {
85+
"date_histogram": {
86+
"field": "startedOn",
87+
"interval": "month",
88+
"min_doc_count": 2,
89+
"format": "yyyy-MM-dd'T'HH:mm:ss||date_optional_time",
90+
"order": {
91+
"_count": "asc"
92+
},
93+
"extended_bounds": {
94+
"min": "2014-06-06T12:01:02.123",
95+
"max": "2016-06-06T12:01:02.123"
96+
},
97+
"missing": "2015-06-06T12:01:02.123"
98+
},
99+
"aggs": {
100+
"project_tags": {
101+
"nested": {
102+
"path": "tags"
103+
},
104+
"aggs": {
105+
"tags": {
106+
"terms": {
107+
"field": "tags.name"
108+
}
109+
}
110+
}
111+
}
112+
}
113+
}
114+
}
115+
----
116+
82117
==== Handling responses
83118

84119
The `AggregateDictionary found on `.Aggregations` on `SearchResponse<T>` has several helper methods

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
////
88
IMPORTANT NOTE
99
==============
10-
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/7.x/src/Tests/Tests/Aggregations/Bucket/DateRange/DateRangeAggregationUsageTests.cs.
10+
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/master/src/Tests/Tests/Aggregations/Bucket/DateRange/DateRangeAggregationUsageTests.cs.
1111
If you wish to submit a PR for any spelling mistakes, typos or grammatical errors for this file,
1212
please modify the original csharp file found at the link and submit the PR with that change. Thanks!
1313
////

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
////
88
IMPORTANT NOTE
99
==============
10-
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/7.x/src/Tests/Tests/Aggregations/Bucket/Filter/FilterAggregationUsageTests.cs.
10+
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/master/src/Tests/Tests/Aggregations/Bucket/Filter/FilterAggregationUsageTests.cs.
1111
If you wish to submit a PR for any spelling mistakes, typos or grammatical errors for this file,
1212
please modify the original csharp file found at the link and submit the PR with that change. Thanks!
1313
////

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
////
88
IMPORTANT NOTE
99
==============
10-
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/7.x/src/Tests/Tests/Aggregations/Bucket/Filters/FiltersAggregationUsageTests.cs.
10+
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/master/src/Tests/Tests/Aggregations/Bucket/Filters/FiltersAggregationUsageTests.cs.
1111
If you wish to submit a PR for any spelling mistakes, typos or grammatical errors for this file,
1212
please modify the original csharp file found at the link and submit the PR with that change. Thanks!
1313
////

docs/aggregations/bucket/geo-distance/geo-distance-aggregation-usage.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
////
88
IMPORTANT NOTE
99
==============
10-
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/7.x/src/Tests/Tests/Aggregations/Bucket/GeoDistance/GeoDistanceAggregationUsageTests.cs.
10+
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/master/src/Tests/Tests/Aggregations/Bucket/GeoDistance/GeoDistanceAggregationUsageTests.cs.
1111
If you wish to submit a PR for any spelling mistakes, typos or grammatical errors for this file,
1212
please modify the original csharp file found at the link and submit the PR with that change. Thanks!
1313
////

0 commit comments

Comments
 (0)