Update docs and generation script for aggregations.

pauliusmaciulis · Mar 18, 2014 · c9aede8 · c9aede8
1 parent 4c3270f
commit c9aede8
Show file tree

Hide file tree

Showing 11 changed files with 37 additions and 36 deletions.
diff --git a/dist/elastic.js b/dist/elastic.js
@@ -3013,8 +3013,8 @@
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.scriptValuesSorted as scriptValuesSorted
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that computes the average of numeric values that are extracted
@@ -3044,8 +3044,8 @@
     @borrows ejs.MetricsAggregationMixin.script as script
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that calculates an approximate count of distinct values.</p>
@@ -3623,8 +3623,8 @@
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.scriptValuesSorted as scriptValuesSorted
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that computes extra stats over numeric values extracted from
@@ -4433,8 +4433,8 @@
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.scriptValuesSorted as scriptValuesSorted
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that keeps track and returns the maximum value among the
@@ -4466,8 +4466,8 @@
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.scriptValuesSorted as scriptValuesSorted
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that keeps track and returns the minimum value among numeric
@@ -4595,8 +4595,8 @@
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.scriptValuesSorted as scriptValuesSorted
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that calculates one or more percentiles over numeric values
@@ -5078,8 +5078,8 @@
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.scriptValuesSorted as scriptValuesSorted
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that computes stats over numeric values extracted from the
@@ -5111,8 +5111,8 @@
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.scriptValuesSorted as scriptValuesSorted
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that sums up numeric values that are extracted from the
@@ -5454,8 +5454,8 @@
     @borrows ejs.MetricsAggregationMixin.script as script
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that counts the number of values that are extracted from the

diff --git a/docs/templates/elasticjs/publish.js b/docs/templates/elasticjs/publish.js
@@ -272,6 +272,7 @@
         navWithTag('request', 'Request');
         navWithTag('query', 'Queries');
         navWithTag('filter', 'Filters');
+        navWithTag('aggregation', 'Aggregations');
         navWithTag('facet', 'Facets');
         navWithTag('suggest', 'Suggesters');
         navWithTag('geo', 'Geo');

diff --git a/src/aggregations/AvgAggregation.js b/src/aggregations/AvgAggregation.js
@@ -12,8 +12,8 @@
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.scriptValuesSorted as scriptValuesSorted
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that computes the average of numeric values that are extracted

diff --git a/src/aggregations/CardinalityAggregation.js b/src/aggregations/CardinalityAggregation.js
@@ -10,8 +10,8 @@
     @borrows ejs.MetricsAggregationMixin.script as script
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that calculates an approximate count of distinct values.</p>

diff --git a/src/aggregations/ExtendedStatsAggregation.js b/src/aggregations/ExtendedStatsAggregation.js
@@ -16,8 +16,8 @@
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.scriptValuesSorted as scriptValuesSorted
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that computes extra stats over numeric values extracted from

diff --git a/src/aggregations/MaxAggregation.js b/src/aggregations/MaxAggregation.js
@@ -12,8 +12,8 @@
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.scriptValuesSorted as scriptValuesSorted
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that keeps track and returns the maximum value among the

diff --git a/src/aggregations/MinAggregation.js b/src/aggregations/MinAggregation.js
@@ -12,8 +12,8 @@
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.scriptValuesSorted as scriptValuesSorted
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that keeps track and returns the minimum value among numeric

diff --git a/src/aggregations/PercentilesAggregation.js b/src/aggregations/PercentilesAggregation.js
@@ -12,8 +12,8 @@
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.scriptValuesSorted as scriptValuesSorted
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that calculates one or more percentiles over numeric values

diff --git a/src/aggregations/StatsAggregation.js b/src/aggregations/StatsAggregation.js
@@ -14,8 +14,8 @@
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.scriptValuesSorted as scriptValuesSorted
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that computes stats over numeric values extracted from the

diff --git a/src/aggregations/SumAggregation.js b/src/aggregations/SumAggregation.js
@@ -12,8 +12,8 @@
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.scriptValuesSorted as scriptValuesSorted
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that sums up numeric values that are extracted from the

diff --git a/src/aggregations/ValueCountAggregation.js b/src/aggregations/ValueCountAggregation.js
@@ -12,8 +12,8 @@
     @borrows ejs.MetricsAggregationMixin.script as script
     @borrows ejs.MetricsAggregationMixin.lang as lang
     @borrows ejs.MetricsAggregationMixin.params as params
-    @borrows ejs.MetricsAggregationMixin._type as _type
-    @borrows ejs.MetricsAggregationMixin.toJSON as toJSON
+    @borrows ejs.AggregationMixin._type as _type
+    @borrows ejs.AggregationMixin.toJSON as toJSON
 
     @desc
     <p>Aggregation that counts the number of values that are extracted from the