Merge pull request #25 from mansimas/patch_docs

Patch docs

docs/Aggregation/Avg.md

@@ -10,7 +10,7 @@ A single-value metrics aggregation that computes the average of numeric values t
 ```JSON
 {
     "aggregations": {
-        "agg_avg_grade": {
+        "avg_grade": {
             "avg": {
                 "field": "grade"
             }
@@ -31,4 +31,4 @@ $search->addAggregation($avgAggregation);
 $queryArray = $search->toArray();
 ```
 
-[1]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-avg-aggregation.html
+[1]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-avg-aggregation.html
\ No newline at end of file

docs/Aggregation/Cardinality.md

@@ -9,7 +9,7 @@ A single-value metrics aggregation that calculates an approximate count of disti
 ```JSON
 {
      "aggregations" : {
-         "agg_author_count" : {
+         "author_count" : {
              "cardinality" : {
                  "field" : "author"
              }
@@ -21,7 +21,8 @@ A single-value metrics aggregation that calculates an approximate count of disti
 And now the query via DSL:
 
 ```php
-$cardinalityAggregation = new CardinalityAggregation('author_count', 'author');
+$cardinalityAggregation = new CardinalityAggregation('author_count');
+$cardinalityAggregation->setField('author');
 
 $search = new Search();
 $search->addAggregation($cardinalityAggregation);

docs/Aggregation/Children.md

@@ -10,12 +10,12 @@ document types to buckets on child documents.
 ```JSON
 {
     "aggregations": {
-        "agg_author_count": {
+        "author_count": {
             "children": {
                 "type": "answer"
             },
             "aggregations": {
-                "agg_top_names": {
+                "top_names": {
                     "terms": {
                         "field": "owner.display_name"
                     }

docs/Aggregation/DateRange.md

@@ -9,13 +9,13 @@ A range aggregation that is dedicated for date values.
 ```JSON
 {
     "aggregations": {
-        "agg_range": {
+        "range": {
             "date_range": {
                 "field": "date",
                 "format": "MM-yyy",
                 "ranges": [
-                    { "to": "now-10M/M" }, 
-                    { "from": "now-10M/M" } 
+                    { "to": "now-10M/M" },
+                    { "from": "now-10M/M" }
                 ]
             }
         }
@@ -31,9 +31,14 @@ $dateRangeAggregation->setField('date');
 $dateRangeAggregation->setFormat('MM-yyy');
 $dateRangeAggregation->addRange(null, 'now-10M/M');
 $dateRangeAggregation->addRange('now-10M/M', null);
+
+$search = new Search();
+$search->addAggregation($dateRangeAggregation);
+
+$queryArray = $search->toArray();
 ```
 
-Or : 
+Or :
 
 ```php
 $dateRangeAggregation = new DateRangeAggregation(
@@ -48,6 +53,8 @@ $dateRangeAggregation = new DateRangeAggregation(
 
 $search = new Search();
 $search->addAggregation($dateRangeAggregation);
+
+$queryArray = $search->toArray();
 ```
 
 [1]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html

docs/Aggregation/ExtendedStats.md

@@ -9,7 +9,7 @@ A multi-value metrics aggregation that computes stats over numeric values extrac
 ```JSON
 {
     "aggregations" : {
-        "agg_grades_stats" : {
+        "grades_stats" : {
             "extended_stats" : { "field" : "grade" }
         }
     }

docs/Aggregation/Filter.md

@@ -11,10 +11,10 @@ context to a specific set of documents.
 ```JSON
 {
     "aggregations" : {
-        "agg_red_products" : {
+        "grades_stats" : {
             "filter" : { "term": { "color": "red" } },
-            "aggs" : {
-                "agg_avg_price" : { "avg" : { "field" : "price" } }
+            "aggregations" : {
+                "avg_price" : { "avg" : { "field" : "price" } }
             }
         }
     }

docs/Aggregation/Filters.md

@@ -14,15 +14,15 @@ in exception.
 ```JSON
 {
   "aggregations" : {
-    "agg_messages" : {
+    "grades_stats" : {
       "filters" : {
         "filters" : {
-          "errors" :   { "term" : { "body" : "error"   }},
-          "warnings" : { "term" : { "body" : "warning" }}
+          "error" :   { "term" : { "body" : "error"   }},
+          "warning" : { "term" : { "body" : "warning" }}
         }
       },
       "aggregations" : {
-        "agg_monthly" : {
+        "monthly" : {
           "histogram" : {
             "field" : "timestamp",
             "interval" : "1M"
@@ -60,6 +60,31 @@ $queryArray = $search->toArray();
 
 ## Anonymous example
 
+```JSON
+{
+  "aggregations" : {
+    "grades_stats" : {
+      "filters" : {
+        "filters" : [
+            { "term" : { "body" : "error"   }},
+            { "term" : { "body" : "warning" }}
+          ]
+        }
+      },
+      "aggregations" : {
+        "monthly" : {
+          "histogram" : {
+            "field" : "timestamp",
+            "interval" : "1M"
+          }
+        }
+      }
+    }
+  }
+}
+```
+And now the query via DSL:
+
 ```php
 $errorTermFilter = new TermFilter('body', 'error');
 $warningTermFilter = new TermFilter('body', 'warning');
@@ -83,4 +108,4 @@ $search->addAggregation($filterAggregation);
 $queryArray = $search->toArray();
 ```
 
-[1]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html
+[1]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html
\ No newline at end of file

docs/Aggregation/GeoBounds.md

@@ -9,7 +9,7 @@ A metric aggregation that computes the bounding box containing all geo_point val
 ```JSON
 {
     "aggregations" : {
-        "agg_viewport" : {
+        "viewport" : {
             "geo_bounds" : {
                 "field" : "location",
                 "wrap_longitude" : true

docs/Aggregation/GeoHashGrid.md

@@ -10,7 +10,7 @@ that represent cells in a grid.
 ```JSON
 {
     "aggregations" : {
-        "agg_GrainGeoHashGrid" : {
+        "GrainGeoHashGrid" : {
             "geohash_grid" : {
                 "field" : "location",
                 "precision" : 3

docs/Aggregation/Global.md

@@ -11,10 +11,10 @@ you’re searching on, but is **not influenced** by the search query itself.
 ```JSON
 {
     "aggregations": {
-        "agg_all_products": {
+        "all_products": {
             "global": {},
             "aggregations": {
-                "agg_avg_price": {
+                "avg_price": {
                     "avg": {
                         "field": "price"
                     }

docs/Aggregation/Histogram.md

@@ -10,7 +10,7 @@ the documents. It dynamically builds fixed size (a.k.a. interval) buckets over t
 ```JSON
 {
     "aggregations": {
-        "agg_prices": {
+        "prices": {
             "histogram": {
                 "field": "price",
                 "interval": 50

docs/Aggregation/Ipv4Range.md

@@ -10,7 +10,7 @@ range aggregation for IPv4 typed fields.
 ```JSON
 {
     "aggregations" : {
-        "agg_ip_range" : {
+        "ip_range" : {
             "ip_range" : {
                 "field" : "ip",
                 "ranges" : [

docs/Aggregation/Missing.md

@@ -10,7 +10,7 @@ in the current document set context that are missing a field value.
 ```JSON
 {
      "aggregations" : {
-         "agg_products_without_a_price" : {
+         "products_without_a_price" : {
              "missing" : { "field" : "price" }
          }
      }

docs/Aggregation/Nested.md

@@ -9,12 +9,12 @@ A special single bucket aggregation that enables aggregating nested documents.
 ```JSON
 {
     "aggregations" : {
-        "agg_resellers" : {
+        "resellers" : {
             "nested" : {
                 "path" : "resellers"
             },
             "aggregations" : {
-                "agg_min_price" : { "min" : { "field" : "resellers.price" } }
+                "min_price" : { "min" : { "field" : "resellers.price" } }
             }
         }
     }

docs/Aggregation/PercentileRanks.md

@@ -10,7 +10,7 @@ ranks over numeric values extracted from the aggregated documents.
 ```JSON
 {
     "aggregations" : {
-        "agg_load_time_outlier" : {
+        "load_time_outlier" : {
             "percentile_ranks" : {
                 "field" : "load_time",
                 "values" : [15, 30]

docs/Aggregation/Percentiles.md

@@ -10,7 +10,7 @@ numeric values extracted from the aggregated documents.
 ```JSON
 {
     "aggregations" : {
-        "agg_load_time_outlier" : {
+        "load_time_outlier" : {
             "percentiles" : {
                 "field" : "load_time"
             }

docs/Aggregation/Range.md

@@ -10,9 +10,10 @@ ranges - each representing a bucket.
 ```JSON
 {
     "aggs" : {
-        "agg_price_ranges" : {
+        "price_ranges" : {
             "range" : {
                 "field" : "price",
+                "keyed" : false,
                 "ranges" : [
                     { "to" : 50 },
                     { "from" : 50, "to" : 100 },

docs/Aggregation/ReverseNested.md

@@ -9,17 +9,17 @@ A special single bucket aggregation that enables aggregating on parent docs from
 ```JSON
 {
   "aggregations": {
-    "agg_comments": {
+    "comments": {
       "nested": {
         "path": "comments"
       },
       "aggregations": {
-        "agg_top_usernames": {
+        "top_usernames": {
           "terms": {
             "field": "comments.username"
           },
           "aggregations": {
-            "agg_comment_to_issue": {
+            "comment_to_issue": {
               "reverse_nested": {},
               "aggregations": {
                 "top_tags_per_comment": {

docs/Aggregation/Stats.md

@@ -10,7 +10,7 @@ values extracted from the aggregated documents.
 ```JSON
 {
     "aggregations" : {
-        "agg_grades_stats" : { "stats" : { "field" : "grade" } }
+        "grades_stats" : { "stats" : { "field" : "grade" } }
     }
 }
 ```

docs/Aggregation/Sum.md

@@ -9,7 +9,7 @@ A single-value metrics aggregation that sums up numeric values that are extracte
 ```JSON
 {
     "aggregations" : {
-        "agg_intraday_return" : { "sum" : { "field" : "change" } }
+        "intraday_return" : { "sum" : { "field" : "change" } }
     }
 }
 ```