Added search_pipeline, verbose_pipeline, include_named_queries_score and derived to search_request_body (#981)

* Added `search_pipeline`, `verbose_pipeline`, `include_named_queries_score` and `derived` to search_request_body

Signed-off-by: xil <[email protected]>

Author: lucy66hw

CHANGELOG.md

@@ -307,6 +307,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added a spec style checker [#620](https://github.com/opensearch-project/opensearch-api-specification/pull/620).
 - Added `remote_store` to node `Stats` ([#643](https://github.com/opensearch-project/opensearch-api-specification/pull/643))
 - Added `x-protobuf-excluded` vendor extension ([#980](https://github.com/opensearch-project/opensearch-api-specification/pull/980))
+- Added `search_pipeline`, `verbose_pipeline`, `include_named_queries_score` and `derived` to search_request_body. `primary` to `ShardFailure`, `header` to `ErrorCause` and Replace InnerHits `fields` from type `Fields` to `FieldAndFormat`([#981](https://github.com/opensearch-project/opensearch-api-specification/pull/981))
 
 ### Changed
 

spec/namespaces/_core.yaml

@@ -2614,6 +2614,12 @@ components:
                   Set to `true` to return detailed timing information about the execution of individual components in a search request.
                   NOTE: This is a debugging tool and adds significant overhead to search execution.
                 type: boolean
+              search_pipeline:
+                description: Customizable sequence of processing stages applied to search queries.
+                type: string
+              verbose_pipeline:
+                description: Enables or disables verbose mode for the search pipeline.
+                type: boolean
               query:
                 $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer'
               rescore:
@@ -2673,6 +2679,9 @@ components:
               track_scores:
                 description: If `true`, calculate and return document scores, even if the scores are not used for sorting.
                 type: boolean
+              include_named_queries_score:
+                description: Whether to return scores with named queries. Default is false.
+                type: boolean
               version:
                 description: If `true`, returns document version as part of a hit.
                 type: boolean
@@ -2691,6 +2700,11 @@ components:
                 type: array
                 items:
                   type: string
+              derived:
+                type: object
+                x-version-added: '2.14'
+                additionalProperties:
+                  $ref: '../schemas/_common.yaml#/components/schemas/DerivedField'
             description: The search definition using the Query DSL
     search_template:
       content:

spec/schemas/_common.query_dsl.yaml

@@ -844,8 +844,6 @@ components:
             format:
               description: Format in which the values are returned.
               type: string
-            include_unmapped:
-              type: boolean
           required:
             - field
     ChildScoreMode:
@@ -1131,7 +1129,7 @@ components:
                   description: If `true`, match phrase queries are automatically created for multi-term synonyms.
                   type: boolean
                 cutoff_frequency:
-                  deprecated: true
+                  x-version-deprecated: '2.0'
                   type: number
                   format: float
                 fuzziness:

spec/schemas/_common.yaml

@@ -332,6 +332,8 @@ components:
           type: integer
         status:
           type: string
+        primary:
+          type: boolean
       required:
         - reason
         - shard
@@ -357,6 +359,12 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/ErrorCause'
+        header:
+          oneOf:
+            - type: string
+            - type: array
+              items:
+                type: string
       required:
         - type
       additionalProperties:
@@ -560,6 +568,27 @@ components:
           description: Whether to ignore failures during script execution.
       required:
         - script
+    DerivedField:
+      type: object
+      properties:
+        name:
+          type: string
+        type:
+          type: string
+        script:
+          $ref: '#/components/schemas/Script'
+        prefilter_field:
+          type: string
+        properties:
+          type: object
+        ignore_malformed:
+          type: boolean
+        format:
+          type: string
+      required:
+        - name
+        - script
+        - type
     Sort:
       oneOf:
         - $ref: '#/components/schemas/SortCombinations'
@@ -670,6 +699,7 @@ components:
         validation_method:
           $ref: '_common.query_dsl.yaml#/components/schemas/GeoValidationMethod'
       additionalProperties:
+        title: location
         type: array
         description: The geo points to use for distance calculation.
         items:

spec/schemas/_core.search.yaml

@@ -769,7 +769,9 @@ components:
         seq_no_primary_term:
           type: boolean
         fields:
-          $ref: '_common.yaml#/components/schemas/Fields'
+          type: array
+          items:
+            $ref: '_common.query_dsl.yaml#/components/schemas/FieldAndFormat'
         sort:
           $ref: '_common.yaml#/components/schemas/Sort'
         _source:
@@ -822,8 +824,6 @@ components:
           properties:
             matched_fields:
               $ref: '_common.yaml#/components/schemas/Fields'
-            analyzer:
-              $ref: '_common.analysis.yaml#/components/schemas/Analyzer'
     HighlightBase:
       type: object
       properties: