Add adjust_pure_negative for bool queries (#641)

* allow additional properties for source field Signed-off-by: Chenyang Ji <[email protected]> * add adjust_pure_negative api spec Signed-off-by: Chenyang Ji <[email protected]> --------- Signed-off-by: Chenyang Ji <[email protected]>
opensearch-project · Oct 24, 2024 · 54f0af9 · 54f0af9
1 parent abc7163
commit 54f0af9
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -104,6 +104,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added `config_id` and `config_id_list` to `/_plugins/_notifications/configs` query parameters ([#594](https://github.com/opensearch-project/opensearch-api-specification/pull/594))
 - Added a release workflow triggered on a tag ([#635](https://github.com/opensearch-project/opensearch-api-specification/pull/635))
 - Added API spec for query insights plugin ([#625](https://github.com/opensearch-project/opensearch-api-specification/pull/625))
+- Added API spec for `adjust_pure_negative` for bool queries ([#641](https://github.com/opensearch-project/opensearch-api-specification/pull/641))
 
 ### Changed
 

diff --git a/spec/schemas/_common.query_dsl.yaml b/spec/schemas/_common.query_dsl.yaml
@@ -270,6 +270,13 @@ components:
                 - type: array
                   items:
                     $ref: '#/components/schemas/QueryContainer'
+            adjust_pure_negative:
+              description: |-
+                Ensures correct behavior when a query contains only must_not clauses.
+                By default set to true, OpenSearch adds a match-all clause to ensure results are returned from Lucene, with the must_not conditions applied as filters.
+                If set to false, the query may return no results, as Lucene typically requires at least one positive condition.
+              type: boolean
+              default: true
     QueryBase:
       type: object
       properties:

diff --git a/tests/plugins/query_insights/insights/top_queries.yaml b/tests/plugins/query_insights/insights/top_queries.yaml
@@ -41,6 +41,19 @@ prologues:
             terms:
               field: director.raw
 
+  - path: /{index}/_search
+    parameters:
+      index: movies
+    method: GET
+    request:
+      payload:
+        query:
+          bool:
+            adjust_pure_negative: true
+            must:
+              match:
+                title: Drive
+
 chapters:
   - synopsis: Retrieve default top queries.
     path: /_insights/top_queries