elastic-enterprise-search 8.0.0.pre → 8.2.0

data/lib/elastic/app-search/api/create_crawler_entry_point.rb

@@ -42,7 +42,6 @@ module Elastic
 
           domain_id = arguments.delete(:domain_id)
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :post,

data/lib/elastic/app-search/api/create_crawler_process_crawl.rb

@@ -37,7 +37,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :post,

data/lib/elastic/app-search/api/create_crawler_sitemap.rb

@@ -42,7 +42,6 @@ module Elastic
 
           domain_id = arguments.delete(:domain_id)
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :post,

data/lib/elastic/app-search/api/create_curation.rb

@@ -31,7 +31,7 @@ module Elastic
         # @option body [Array<string>] :queries List of affected search queries
         # @option body [Array<string>] :promoted List of promoted document IDs
         # @option body [Array<string>] :hidden List of hidden document IDs
-        # @option body [Hash] :suggestion
+        # @option body :suggestion
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/curations.html#curations-create
@@ -41,7 +41,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'body (queries)' missing" unless arguments[:body]
 
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :post,

data/lib/elastic/app-search/api/create_engine.rb

@@ -40,7 +40,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'body (name)' missing" unless arguments[:body]
 
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :post,

data/lib/elastic/app-search/api/create_synonym_set.rb

@@ -38,7 +38,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'body (synonyms)' missing" unless arguments[:body]
 
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :post,

data/lib/elastic/app-search/api/curation.rb

@@ -36,7 +36,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'curation_id' missing" unless arguments[:curation_id]
 
           curation_id = arguments.delete(:curation_id)
-
           headers = arguments.delete(:headers) || {}
           request(
             :get,

data/lib/elastic/app-search/api/delete_api_key.rb

@@ -34,7 +34,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'api_key_name' missing" unless arguments[:api_key_name]
 
           api_key_name = arguments.delete(:api_key_name)
-
           headers = arguments.delete(:headers) || {}
           request(
             :delete,

data/lib/elastic/app-search/api/delete_crawler_crawl_rule.rb

@@ -39,7 +39,6 @@ module Elastic
 
           domain_id = arguments.delete(:domain_id)
           crawl_rule_id = arguments.delete(:crawl_rule_id)
-
           headers = arguments.delete(:headers) || {}
           request(
             :delete,

data/lib/elastic/app-search/api/delete_crawler_domain.rb

@@ -36,7 +36,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'domain_id' missing" unless arguments[:domain_id]
 
           domain_id = arguments.delete(:domain_id)
-
           headers = arguments.delete(:headers) || {}
           request(
             :delete,

data/lib/elastic/app-search/api/delete_crawler_entry_point.rb

@@ -39,7 +39,6 @@ module Elastic
 
           domain_id = arguments.delete(:domain_id)
           entry_point_id = arguments.delete(:entry_point_id)
-
           headers = arguments.delete(:headers) || {}
           request(
             :delete,

data/lib/elastic/app-search/api/delete_crawler_sitemap.rb

@@ -39,7 +39,6 @@ module Elastic
 
           domain_id = arguments.delete(:domain_id)
           sitemap_id = arguments.delete(:sitemap_id)
-
           headers = arguments.delete(:headers) || {}
           request(
             :delete,

data/lib/elastic/app-search/api/delete_curation.rb

@@ -36,7 +36,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'curation_id' missing" unless arguments[:curation_id]
 
           curation_id = arguments.delete(:curation_id)
-
           headers = arguments.delete(:headers) || {}
           request(
             :delete,

data/lib/elastic/app-search/api/delete_documents.rb

@@ -35,7 +35,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           document_ids = arguments.delete(:document_ids) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :delete,

data/lib/elastic/app-search/api/delete_meta_engine_source.rb

@@ -35,7 +35,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           source_engines = arguments.delete(:source_engines) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :delete,

data/lib/elastic/app-search/api/delete_synonym_set.rb

@@ -36,7 +36,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'synonym_set_id' missing" unless arguments[:synonym_set_id]
 
           synonym_set_id = arguments.delete(:synonym_set_id)
-
           headers = arguments.delete(:headers) || {}
           request(
             :delete,

data/lib/elastic/app-search/api/documents.rb

@@ -36,7 +36,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           document_ids = arguments.delete(:document_ids) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :get,

data/lib/elastic/app-search/api/index_documents.rb

@@ -35,7 +35,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           documents = arguments.delete(:documents) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :post,

data/lib/elastic/app-search/api/list_adaptive_relevance_suggestions.rb

@@ -28,7 +28,7 @@ module Elastic
         # @param [Hash] arguments endpoint arguments
         # @option arguments [Hash] :body
         # @option body :page
-        # @option body [string] :filters
+        # @option body [Hash] :filters
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-get-engine-adaptive-relevance-suggestions
@@ -37,7 +37,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :post,

data/lib/elastic/app-search/api/log_clickthrough.rb

@@ -40,7 +40,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'body (query,document_id)' missing" unless arguments[:body]
 
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :post,

data/lib/elastic/app-search/api/put_adaptive_relevance_settings.rb

@@ -27,7 +27,7 @@ module Elastic
         # @param [String] engine_name Name of the engine (*Required*)
         # @param [Hash] arguments endpoint arguments
         # @option arguments [Hash] :body (Required: curation)
-        # @option body [Hash] :curation (Required: )
+        # @option body [Hash] :curation
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-put-engine-adaptive-relevance-settings
@@ -37,7 +37,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'body (curation)' missing" unless arguments[:body]
 
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :put,

data/lib/elastic/app-search/api/put_adaptive_relevance_suggestions.rb

@@ -35,7 +35,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :put,

data/lib/elastic/app-search/api/put_api_key.rb

@@ -44,7 +44,6 @@ module Elastic
 
           api_key_name = arguments.delete(:api_key_name)
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :put,

data/lib/elastic/app-search/api/put_crawler_crawl_rule.rb

@@ -48,7 +48,6 @@ module Elastic
           domain_id = arguments.delete(:domain_id)
           crawl_rule_id = arguments.delete(:crawl_rule_id)
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :put,

data/lib/elastic/app-search/api/put_crawler_crawl_schedule.rb

@@ -38,7 +38,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'body (frequency,unit)' missing" unless arguments[:body]
 
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :put,

data/lib/elastic/app-search/api/put_crawler_domain.rb

@@ -42,7 +42,6 @@ module Elastic
 
           domain_id = arguments.delete(:domain_id)
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :put,

data/lib/elastic/app-search/api/put_crawler_entry_point.rb

@@ -45,7 +45,6 @@ module Elastic
           domain_id = arguments.delete(:domain_id)
           entry_point_id = arguments.delete(:entry_point_id)
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :put,

data/lib/elastic/app-search/api/put_crawler_sitemap.rb

@@ -45,7 +45,6 @@ module Elastic
           domain_id = arguments.delete(:domain_id)
           sitemap_id = arguments.delete(:sitemap_id)
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :put,

data/lib/elastic/app-search/api/put_curation.rb

@@ -32,7 +32,7 @@ module Elastic
         # @option body [Array<string>] :queries List of affected search queries
         # @option body [Array<string>] :promoted List of promoted document IDs
         # @option body [Array<string>] :hidden List of hidden document IDs
-        # @option body [Hash] :suggestion
+        # @option body :suggestion
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/curations.html#curations-update
@@ -44,7 +44,6 @@ module Elastic
 
           curation_id = arguments.delete(:curation_id)
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :put,

data/lib/elastic/app-search/api/put_documents.rb

@@ -35,7 +35,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           documents = arguments.delete(:documents) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :patch,

data/lib/elastic/app-search/api/put_schema.rb

@@ -35,7 +35,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           schema = arguments.delete(:schema) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :post,

data/lib/elastic/app-search/api/put_search_settings.rb

@@ -39,7 +39,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :put,

data/lib/elastic/app-search/api/put_synonym_set.rb

@@ -41,7 +41,6 @@ module Elastic
 
           synonym_set_id = arguments.delete(:synonym_set_id)
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :put,

data/lib/elastic/app-search/api/query_suggestion.rb

@@ -38,7 +38,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :post,

data/lib/elastic/app-search/api/refresh_adaptive_relevance_update_process.rb

@@ -40,7 +40,6 @@ module Elastic
           end
 
           adaptive_relevance_suggestion_type = arguments.delete(:adaptive_relevance_suggestion_type)
-
           headers = arguments.delete(:headers) || {}
           request(
             :post,

data/lib/elastic/app-search/api/search.rb

@@ -46,7 +46,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'body (query)' missing" unless arguments[:body]
 
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :post,

data/lib/elastic/app-search/api/search_es_search.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # ElasticsearchSearch - Run a search
+        # Execute the provided Elasticsearch search query against an App Search Engine
+        #
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Hash] :body (Required: request)
+        # @option body :request
+        # @option body :analytics
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/elasticsearch-search-api-reference.html
+        #
+        def search_es_search(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'body (request)' missing" unless arguments[:body]
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+          request(
+            :post,
+            "api/as/v0/engines/#{engine_name}/elasticsearch/_search/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/search_explain.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # SearchExplain - Retrieve the search query
+        # Submit a search and retrieve an Elasticsearch query
+        #
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Hash] :body (Required: query)
+        # @option body [string] :query
+        # @option body :analytics
+        # @option body :boost
+        # @option body :facets
+        # @option body :filters
+        # @option body :group
+        # @option body :page
+        # @option body :result_fields
+        # @option body :search_fields
+        # @option body :sort
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/search-explain.html
+        #
+        def search_explain(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'body (query)' missing" unless arguments[:body]
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+          request(
+            :post,
+            "api/as/v0/engines/#{engine_name}/search_explain/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/synonym_set.rb

@@ -36,7 +36,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'synonym_set_id' missing" unless arguments[:synonym_set_id]
 
           synonym_set_id = arguments.delete(:synonym_set_id)
-
           headers = arguments.delete(:headers) || {}
           request(
             :get,

data/lib/elastic/app-search/api/top_clicks_analytics.rb

@@ -38,7 +38,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :post,

data/lib/elastic/app-search/api/top_queries_analytics.rb

@@ -37,7 +37,6 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
-
           headers = arguments.delete(:headers) || {}
           request(
             :post,

data/lib/elastic/enterprise-search/api/put_read_only.rb

@@ -34,7 +34,6 @@ module Elastic
         raise ArgumentError, "Required parameter 'body (enabled)' missing" unless arguments[:body]
 
         body = arguments.delete(:body) || {}
-
         headers = arguments.delete(:headers) || {}
         request(
           :put,

data/lib/elastic/enterprise-search/api/version.rb

@@ -26,7 +26,7 @@ module Elastic
       # @param [Hash] arguments endpoint arguments
       # @option arguments [Hash] :headers optional HTTP headers to send with the request
       #
-      # @see https://www.elastic.co/guide/en/enterprise-search/current/management-apis.html
+      # @see https://www.elastic.co/guide/en/enterprise-search/current/monitoring-apis.html#monitoring-apis-version-api
       #
       def version(arguments = {})
         headers = arguments.delete(:headers) || {}

data/lib/elastic/enterprise-search/version.rb

@@ -19,6 +19,6 @@
 
 module Elastic
   module EnterpriseSearch
-    VERSION = '8.0.0.pre'
+    VERSION = '8.2.0'
   end
 end

data/spec/integration/app-search/elasticsearch_search_spec.rb

@@ -0,0 +1,63 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+require_relative "#{__dir__}/app_search_helper.rb"
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  context 'Elasticsearch Search' do
+    let(:engine_name) { 'elasticsearch-books' }
+    let(:documents) do
+      [
+        { title: 'Beasts Before Us', author: 'Elsa Panciroli' },
+        { title: 'The Rise and Fall of the Dinosaurs', author: 'Steve Brusatte' },
+        { title: 'Raptor Red', author: 'Robert T. Bakker' },
+        { title: 'The Earth: A biography of life', author: 'Dr. Elsa Panciroli' }
+      ]
+    end
+    let(:api_key_name) { 'my-api-key' }
+
+    before do
+      # Use API Key in client, save a backup to restore original auth:
+      @old_client = @client.dup
+      api_key_body = { name: api_key_name, type: 'private', read: true, write: true, access_all_engines: true }
+      response = client.create_api_key(body: api_key_body)
+      @client.http_auth = response.body['key']
+      create_engine(engine_name)
+      client.index_documents(engine_name, documents: documents)
+      sleep 1
+    end
+
+    after do
+      # Restore original client:
+      @client = @old_client
+      delete_engines
+      client.delete_api_key(api_key_name: api_key_name)
+    end
+
+    it 'performs an ES search' do
+      es_request = { body: { query: { bool: { must: { term: { author: 'panciroli' } } } } } }
+      response = client.search_es_search(engine_name, body: { request: es_request })
+      expect(response.status).to eq 200
+      expect(response.body['hits']['hits'].count).to eq 2
+      expect do
+        response.body['hits']['hits'].map { |a| a['_source']['author'] } == ['Elsa Panciroli', 'Dr. Elsa Panciroli']
+      end
+    end
+  end
+end