More

Author: lcawl

docs/overlays/elasticsearch-shared-overlays.yaml

@@ -1360,3 +1360,23 @@ actions:
           examples:
             searchApplicationsListResponseExample1:
               $ref: "../../specification/search_application/list/SearchApplicationsListResponseExample1.yaml"
+## Examples for search applications
+  - target: "$.paths['/_application/search_application/{name}']['get']"
+    description: "Add examples for get search application details operation"
+    update: 
+      responses:
+        200: 
+          content: 
+            application/json: 
+              examples: 
+                getSearchApplicationRequestExample1: 
+                  $ref: "../../specification/search_application/get/SearchApplicationGetResponseExample1.yaml"
+  - target: "$.paths['/_application/search_application/{name}']['put']"
+    description: "Add examples for create search application operation"
+    update: 
+      requestBody: 
+        content: 
+          application/json: 
+            examples: 
+              putSearchApplicationRequestExample1: 
+                $ref: "../../specification/search_application/put/SearchApplicationPutRequestExample1.yaml"

specification/search_application/get/SearchApplicationGetResponseExample1.yaml

@@ -0,0 +1,13 @@
+# summary: search-application/apis/get-search-application.asciidoc:95
+description: A sucessful response from `GET _application/search_application/my-app/`.
+# type: response
+# response_code: ''
+value:
+  "{\n  \"name\": \"my-app\",\n  \"indices\": [ \"index1\", \"index2\" ],\n \
+  \ \"updated_at_millis\": 1682105622204,\n  \"template\": {\n    \"script\": {\n\
+  \      \"source\": {\n        \"query\": {\n          \"query_string\": {\n    \
+  \        \"query\": \"{{query_string}}\",\n            \"default_field\": \"{{default_field}}\"\
+  \n          }\n        }\n      },\n      \"lang\": \"mustache\",\n      \"options\"\
+  : {\n        \"content_type\": \"application/json;charset=utf-8\"\n      },\n  \
+  \    \"params\": {\n        \"query_string\": \"*\",\n        \"default_field\"\
+  : \"*\"\n      }\n    }\n  }\n}"

specification/search_application/list/SearchApplicationsListResponseExample2.yaml

@@ -0,0 +1,8 @@
+summary: search-application/apis/list-search-applications.asciidoc:108
+description: ''
+type: response
+response_code: ''
+value:
+  "{\n  \"count\": 2,\n  \"results\": [\n    {\n      \"name\": \"app-1\",\n\
+  \      \"updated_at_millis\": 1690981129366\n    },\n    {\n      \"name\": \"app-2\"\
+  ,\n      \"updated_at_millis\": 1691501823939\n    }\n  ]\n}"

specification/search_application/put/SearchApplicationPutRequestExample1.yaml

@@ -0,0 +1,17 @@
+# summary: search-application/apis/put-search-application.asciidoc:148
+# method_request: PUT _application/search_application/my-app
+description: >
+  Run `PUT _application/search_application/my-app` to create or update a search application called `my-app`. When the  dictionary parameter is specified, the search application search API will perform the following parameter validation: it accepts only the `query_string` and `default_field` parameters; it verifies that `query_string` and `default_field` are both strings; it accepts `default_field` only if it takes the values title or description. If the parameters are not valid, the search application search API will return an error.
+# type: request
+value:
+  "{\n  \"indices\": [ \"index1\", \"index2\" ],\n  \"template\": {\n    \"script\"\
+  : {\n      \"source\": {\n        \"query\": {\n          \"query_string\": {\n\
+  \            \"query\": \"{{query_string}}\",\n            \"default_field\": \"\
+  {{default_field}}\"\n          }\n        }\n      },\n      \"params\": {\n   \
+  \     \"query_string\": \"*\",\n        \"default_field\": \"*\"\n      }\n    },\n\
+  \    \"dictionary\": {\n      \"properties\": {\n        \"query_string\": {\n \
+  \         \"type\": \"string\"\n        },\n        \"default_field\": {\n     \
+  \     \"type\": \"string\",\n          \"enum\": [\n            \"title\",\n   \
+  \         \"description\"\n          ]\n        },\n        \"additionalProperties\"\
+  : false\n      },\n      \"required\": [\n        \"query_string\"\n      ]\n  \
+  \  }\n  }\n}"

specification/search_application/search/SearchApplicationsSearchRequestExample1.yaml

@@ -0,0 +1,8 @@
+summary: search-application/apis/search-application-search.asciidoc:125
+method_request: POST _application/search_application/my-app/_search
+description: ''
+type: request
+value:
+  "{\n  \"params\": {\n    \"query_string\": \"my first query\",\n    \"text_fields\"\
+  : [\n      {\"name\": \"title\", \"boost\": 5},\n      {\"name\": \"description\"\
+  , \"boost\": 1}\n    ]\n  }\n}"

specification/search_application/search/SearchApplicationsSearchResponseExample1.yaml

@@ -0,0 +1,8 @@
+summary: search-application/apis/search-application-search.asciidoc:141
+description: ''
+type: response
+response_code: ''
+value:
+  "{\n  \"from\": 0,\n  \"size\": 10,\n  \"query\": {\n    \"multi_match\": {\n\
+  \      \"query\": \"my first query\",\n      \"fields\": [\n        \"description^1.0\"\
+  ,\n        \"title^5.0\"\n      ]\n    }\n  },\n  \"explain\": false\n}"

specification/search_application/search/SearchApplicationsSearchResponseExample2.yaml

@@ -0,0 +1,9 @@
+summary: search-application/apis/search-application-search.asciidoc:166
+description: ''
+type: response
+response_code: ''
+value:
+  "{\n  \"took\": 5,\n  \"timed_out\": false,\n  \"_shards\": {\n    \"total\"\
+  : 1,\n    \"successful\": 1,\n    \"skipped\": 0,\n    \"failed\": 0\n  },\n  \"\
+  hits\": {\n    \"total\": {\n      \"value\": 1,\n      \"relation\": \"eq\"\n \
+  \   },\n    \"max_score\": 0.8630463,\n    \"hits\": ...\n  }\n}"