Msearch template API tests

CHANGELOG.md

@@ -33,6 +33,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added response schema for `PUT` and `DELETE /_plugins/_transform/{id}` ([#722](https://github.com/opensearch-project/opensearch-api-specification/pull/716))
 - Added response schema for `GET /_plugins/_knn/warmup/{index}` ([#717](https://github.com/opensearch-project/opensearch-api-specification/pull/717))
 - Added support for multiple test verbs ([#724](https://github.com/opensearch-project/opensearch-api-specification/pull/724))
+- Added string type in additionalProperties to `msearch template` ([#735](https://github.com/opensearch-project/opensearch-api-specification/pull/735))
 
 ### Removed
 - Removed unsupported `_common.mapping:SourceField`'s `mode` field and associated `_common.mapping:SourceFieldMode` enum ([#652](https://github.com/opensearch-project/opensearch-api-specification/pull/652))

spec/schemas/_core.msearch_template.yaml

@@ -25,7 +25,9 @@ components:
             The value is the variable value.
           type: object
           additionalProperties:
-            type: object
+            oneOf:
+              - type: string
+              - type: object
         profile:
           description: When `true`, provides a profile for the query execution.
           type: boolean

tests/default/_core/msearch_template.yaml

@@ -0,0 +1,47 @@
+$schema: ../../../json_schemas/test_story.schema.yaml
+
+description: Test _termvectors and _msearch/template APIs.
+prologues:  
+  - path: /_bulk
+    method: POST
+    parameters:
+      refresh: true
+    request:
+      content_type: application/x-ndjson
+      payload:
+        - {create: {_index: books, _id: book1}}
+        - {author: Harper Lee, title: To Kill a Mockingbird, year: 1960}
+        - {create: {_index: books, _id: book2}}
+        - {author: Elizabeth Rudnick, title: Beauty and the Beast, year: 1991}
+        - {create: {_index: books, _id: book3}}
+        - {author: George Orwell, title: '1984', year: 1949}
+epilogues:
+  - path: /books
+    method: DELETE
+    status: [200, 404]
+
+chapters:
+  - synopsis: Perform a multi-search template query using a GET request.
+    path: /_msearch/template
+    method: GET
+    request:
+      content_type: application/x-ndjson
+      payload:
+        - {index: books}
+        - {source: '{"query": {"match": {"title": "{{title}}"}}}', params: {title: Mockingbird}}
+        - {index: books}
+        - {source: '{"query": {"match": {"title": "{{title}}"}}}', params: {title: Beast}}
+    response:
+      status: 200
+  - synopsis: Perform a multi-search template query using a POST request.
+    path: /_msearch/template
+    method: POST
+    request:
+      content_type: application/x-ndjson
+      payload:
+        - {index: books}
+        - {source: '{"query": {"match": {"title": "{{title}}"}}}', params: {title: '1984'}}
+        - {index: books}
+        - {source: '{"query": {"match": {"author": "{{author}}"}}}', params: {author: Harper Lee}}
+    response:
+      status: 200

tests/default/indices/msearch.yaml

@@ -21,6 +21,20 @@ epilogues:
     status: [200, 404]
 chapters:
   - synopsis: Perform a `_msearch` request to execute multiple search queries in a single call.
+    path: /{index}/_msearch
+    method: GET
+    parameters:
+      index: books
+    request:
+      content_type: application/x-ndjson
+      payload:
+        - {index: books}
+        - {query: {match: {title: To Kill a Mockingbird}}}
+        - {index: books}
+        - {query: {match: {title: The Cruise}}}
+    response:
+      status: 200
+  - synopsis: Perform a `_msearch` request to execute multiple search queries in a single call (POST).
     path: /{index}/_msearch
     method: POST
     parameters:

tests/default/indices/msearch_template.yaml

@@ -0,0 +1,51 @@
+$schema: ../../../json_schemas/test_story.schema.yaml
+
+description: Test _termvectors and _msearch/template APIs.
+prologues:  
+  - path: /_bulk
+    method: POST
+    parameters:
+      refresh: true
+    request:
+      content_type: application/x-ndjson
+      payload:
+        - {create: {_index: books, _id: book1}}
+        - {author: Harper Lee, title: To Kill a Mockingbird, year: 1960}
+        - {create: {_index: books, _id: book2}}
+        - {author: Elizabeth Rudnick, title: Beauty and the Beast, year: 1991}
+        - {create: {_index: books, _id: book3}}
+        - {author: George Orwell, title: '1984', year: 1949}
+epilogues:
+  - path: /books
+    method: DELETE
+    status: [200, 404]
+
+chapters:
+  - synopsis: Perform a multi-search template query using a GET request.
+    path: /{index}/_msearch/template
+    parameters:
+      index: books
+    method: GET
+    request:
+      content_type: application/x-ndjson
+      payload:
+        - {index: books}
+        - {source: '{"query": {"match": {"title": "{{title}}"}}}', params: {title: Mockingbird}}
+        - {index: books}
+        - {source: '{"query": {"match": {"title": "{{title}}"}}}', params: {title: Beast}}
+    response:
+      status: 200
+  - synopsis: Perform a multi-search template query using a POST request.
+    path: /{index}/_msearch/template
+    parameters:
+      index: books
+    method: POST
+    request:
+      content_type: application/x-ndjson
+      payload:
+        - {index: books}
+        - {source: '{"query": {"match": {"title": "{{title}}"}}}', params: {title: '1984'}}
+        - {index: books}
+        - {source: '{"query": {"match": {"author": "{{author}}"}}}', params: {author: Harper Lee}}
+    response:
+      status: 200