Merge pull request #75 from Samoht70/aggregate-alias-support

Aggregate alias support

Author: GautierDele

content/2.endpoints/2.search.md

@@ -58,6 +58,7 @@ Here is a quick look at what you can do:
         "relation": "stars",
         "type": "max",
         "field": "rate",
+        "alias": "approved_max_stars",
         "filters": [
           {"field": "approved", "value": true}
         ]
@@ -104,6 +105,7 @@ Here is a quick look at what you can do:
 | `aggregates.relation` | `string` | X                                    |             | The relation you are querying                                                                                  |
 | `aggregates.type`     | `string` | X                                    |             | The type of the aggregates you want to use in: `min`, `max`, `avg`, `sum`, `count` and `exists`                |
 | `aggregates.field`    | `string` | when type is not `exists` or `count` | `*`         | The field you want to execute your aggregate on                                                                |
+| `aggregates.alias`    | `string` |                                      |             | The alias given for the aggregate                                                                              |
 | `aggregates.filters`  | `array`  |                                      |             | You can specify all the arguments for the `filters` section                                                    |
 | **Instructions**      |          |                                      |             |                                                                                                                |
 | `instructions.name`   | `string` | X                                    |             | The instruction `uriKey`                                                                                       |
@@ -416,6 +418,26 @@ The type could be one of these:
 For the `exists` and `count` operation you must not specify the field since these aggregates don't base themselves on a column.
 ::
 
+### Aliases
+
+You may optionally define an alias for your aggregate using the `alias` method. This allows you to customize the name of the aggregate column in the response, instead of relying on Laravel's default naming.
+
+```json
+// (POST) api/posts/search
+{
+  "search": {
+    "aggregates": [
+      {
+        "relation": "comments",
+        "type": "avg",
+        "field": "stars",
+        "alias": "average_stars"
+      }
+    ]
+  }
+}
+```
+
 #### Aggregates filtering
 
 For more complex aggregates, Laravel Rest Api allows you to specify filters. These filters are the same as [the basic ones](/endpoints/search#filters).