Merge pull request #250 from flotiq/feature/search-query-add-ref-to-es

Add reference to ElasticSearch in search docs
flotiq · May 21, 2024 · f0b86e0 · f0b86e0
2 parents ee7082e + c4c8943
commit f0b86e0
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/docs/API/search.md b/docs/API/search.md
@@ -16,13 +16,13 @@ You can use the search engine via the `GET /api/v1/search` endpoint to search th
     | content_type[]         | array  | Restrict search to content types set  The expected format: `content_type[]=type1&content_type[]=type2`                                                                                                                                                                                                                                              |
     | aggregate_by[]         | array  | Fields to aggregate results. The expected format: `aggregate_by[]=name&aggregate_by[]=slug`                                                                                                                                                                                                                                                         |
     | aggregate_by_numeric[] | array  | Fields to aggregate results by numeric values. The expected format: `aggregate_by_numeric[]=price&aggregate_by_numeric[]=count`                                                                                                                                                                                                                     |
-    | filters[]              | array  | Filter by object properties. The expected format: `filters[propertyName]=value1&filters[propertyName2]=value2`                                                                                                                                                                                                                                      |
-    | geo_filters            | array  | Filter by object geolocation properties. Example value: `geo_distance,1.50km,40.1,-19.2` which means: `filter name`, `distance`, `latitude`, `longitude`. For more information see [ElasticSearch docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-query.html). Only `geo_distance` query is supported. |
+    | filters[]              | array  | Filter by object properties. The expected format: `filters[propertyName]=value1&filters[propertyName2]=value2`. Follows the rules of the [ElasticSearch Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html).                                                                     |
+    | geo_filters            | array  | Filter by object geolocation properties. Example value: `geo_distance,1.50km,40.1,-19.2` which means: `filter name`, `distance`, `latitude`, `longitude`. For more information see [ElasticSearch docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-query.html). Only `geo_distance` query is supported.                                                                                               |
     | post_filters           | array  | Filter by object properties. Use it when you want aggregated counts without filters applied. Expected format: `filters[propertyName]=value1&filters[propertyName2]=value2`                                                                                                                                                                          |
     | fields[]               | array  | List of content fields to be searched. The expected format: `fields[]=field1&fields[]=field2`                                                                                                                                                                                                                                                       |
     | order_by               | string | Name of the field to sort results by (they are always primarily sorted by `_score`)                                                                                                                                                                                                                                                                 |
     | order_direction        | string | Direction of sorting (`asc` for ascending or `desc` for descending, default `asc`)                                                                                                                                                                                                                                                                  |
-    | random_seed        | number | Seed for random sorting order (overrides `order_by`)                                                                                                                                                                                                                                                                  |
+    | random_seed            | number | Seed for random sorting order (overrides `order_by`)                                                                                                                                                                                                                                                                                                |
 
 ## Example: Search for "Flotiq" in posts