Mark CONTROLLER-1849 bug in cluster suite

[integration/test.git] / csit / scripts / generate_searchSourceJSON.py

diff --git a/csit/scripts/generate_searchSourceJSON.py b/csit/scripts/generate_searchSourceJSON.py
index eadd6a87256ce98d6d06e08949b7d31d93679c06..c8a78d82a9ceabe2d313e6e9af4c8bb29883c929 100644 (file)
--- a/csit/scripts/generate_searchSourceJSON.py
+++ b/csit/scripts/generate_searchSourceJSON.py
@@ -1,8 +1,10 @@
 from copy import deepcopy as dc
 
+# Template for search source format
 SEARCH_SOURCE_FORMAT = {"index": None, "filter": [],
                         "query": {"language": "lucene", "query": ""}}
 
+# Template for filter format
 FILTER_FORMAT = {
     "query": {
         "match": {
@@ -19,6 +21,14 @@ def generate(dash_config, viz_config, index_pattern):
 
     search_source = dc(SEARCH_SOURCE_FORMAT)
 
+    # Search for 'match-with' and 'field' for each keys in 'filter' either
+    # in viz_config or dash_config
+    #
+    # ex:- filter:
+    #        1:
+    #           field: my_field
+    #           match-with: pattern
+
     try:
         filters = dash_config['filter']
         for _, value in filters.items():