elasticsearch-api 8.17.2 → 8.19.0

data/spec/elasticsearch/api/actions/inference/put_watsonx_spec.rb

@@ -0,0 +1,36 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'client#inference.put_watsonx' do
+  let(:expected_args) do
+    [
+      'PUT',
+      '_inference/foo/bar',
+      {},
+      nil,
+      {},
+      { defined_params: { watsonx_inference_id: 'bar', task_type: 'foo' },
+        endpoint: 'inference.put_watsonx' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.inference.put_watsonx(task_type: 'foo', watsonx_inference_id: 'bar')).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/inference/rerank_spec.rb

@@ -0,0 +1,35 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'client#inference.rerank' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_inference/rerank/foo',
+      {},
+      nil,
+      {},
+      { defined_params: { inference_id: 'foo' }, endpoint: 'inference.rerank' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.inference.rerank(inference_id: 'foo')).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/inference/{stream_inference_spec.rb → sparse_embedding_spec.rb}

@@ -17,19 +17,19 @@
 
 require 'spec_helper'
 
-describe 'client#inference.stream_inference' do
+describe 'client#inference.sparse_embedding' do
   let(:expected_args) do
     [
       'POST',
-      '_inference/foo/_stream',
+      '_inference/sparse_embedding/foo',
       {},
       nil,
       {},
-      { defined_params: { inference_id: 'foo' }, endpoint: 'inference.stream_inference' }
+      { defined_params: { inference_id: 'foo' }, endpoint: 'inference.sparse_embedding' }
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.inference.stream_inference(inference_id: 'foo')).to be_a Elasticsearch::API::Response
+    expect(client_double.inference.sparse_embedding(inference_id: 'foo')).to be_a Elasticsearch::API::Response
   end
 end

data/spec/elasticsearch/api/actions/inference/stream_completion_spec.rb

@@ -0,0 +1,35 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'client#inference.stream_completion' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_inference/completion/foo/_stream',
+      {},
+      nil,
+      {},
+      { defined_params: { inference_id: 'foo' }, endpoint: 'inference.stream_completion' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.inference.stream_completion(inference_id: 'foo')).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/inference/text_embedding_spec.rb

@@ -0,0 +1,35 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'client#inference.text_embedding' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_inference/text_embedding/foo',
+      {},
+      nil,
+      {},
+      { defined_params: { inference_id: 'foo' }, endpoint: 'inference.text_embedding' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.inference.text_embedding(inference_id: 'foo')).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/inference/update_spec.rb

@@ -20,7 +20,7 @@ require 'spec_helper'
 describe 'client#inference.update' do
   let(:expected_args) do
     [
-      'POST',
+      'PUT',
       '_inference/foo/bar/_update',
       {},
       nil,

data/spec/rest_api/skipped_tests_free.yml

@@ -228,3 +228,33 @@
 -
   :file: 'cluster.stats/40_source_modes.yml'
   :description: 'test source modes'
+-
+  :file: 'search/520_fetch_fields.yml'
+  :description: 'fetch _seq_no via fields'
+-
+  :file: 'indices.recovery/20_synthetic_source.yml'
+  :description: 'test recovery empty index with use_synthetic_source'
+-
+  :file: 'indices.create/10_basic.yml'
+  :description: 'Create lookup index'
+-
+  :file: 'indices.create/10_basic.yml'
+  :description: 'Create lookup index with one shard'
+-
+  :file: 'nodes.stats/11_indices_metrics.yml'
+  :description: 'indices mappings exact count test for indices level'
+-
+  :file: 'tsdb/160_nested_fields.yml'
+  :description: '*'
+-
+  :file: 'data_stream/10_basic.yml'
+  :description: '*'
+-
+  :file: 'data_stream/150_tsdb.yml'
+  :description: '*'
+-
+  :file: 'data_stream/190_failure_store_redirection.yml'
+  :description: '*'
+-
+  :file: 'data_stream/240_data_stream_settings.yml'
+  :description: '*'

data/spec/rest_api/skipped_tests_platinum.yml

@@ -226,3 +226,193 @@
 -
   :file: 'esql/150_lookup.yml'
   :description: '*'
+# TODO: once migrate is available in spec
+-
+  :file: 'migrate/10_reindex.yml'
+  :description: '*'
+-
+  :file: 'migrate/20_reindex_status.yml'
+  :description: '*'
+-
+  :file: 'migrate/30_create_from.yml'
+  :description: '*'
+-
+  :file: 'esql/60_usage.yml'
+  :description: 'Basic ESQL usage output (telemetry) snapshot version'
+# TODO: 8.19 - 19 June 2025
+-
+  :file: 'ml/datafeeds_crud.yml'
+  :description: '*'
+-
+  :file: 'ml/delete_job_force.yml'
+  :description: '*'
+-
+  :file: 'ml/filter_crud.yml'
+  :description: '*'
+-
+  :file: 'ml/get_datafeed_stats.yml'
+  :description: '*'
+-
+  :file: 'ml/get_datafeeds.yml'
+  :description: '*'
+-
+  :file: 'ml/get_trained_model_stats.yml'
+  :description: '*'
+-
+  :file: 'ml/inference_crud.yml'
+  :description: '*'
+-
+  :file: 'ml/job_groups.yml'
+  :description: '*'
+-
+  :file: 'ml/jobs_crud.yml'
+  :description: '*'
+-
+  :file: 'ml/jobs_get.yml'
+  :description: '*'
+-
+  :file: 'ml/jobs_get_stats.yml'
+  :description: '*'
+-
+  :file: 'ml/preview_data_frame_analytics.yml'
+  :description: '*'
+-
+  :file: 'ml/preview_datafeed.yml'
+  :description: '*'
+-
+  :file: 'ml/search_knn_query_vector_builder.yml'
+  :description: '*'
+-
+  :file: 'ml/set_upgrade_mode.yml'
+  :description: '*'
+-
+  :file: 'ml/sparse_vector_search.yml'
+  :description: '*'
+-
+  :file: 'ml/start_data_frame_analytics.yml'
+  :description: '*'
+-
+  :file: 'ml/start_stop_datafeed.yml'
+  :description: '*'
+-
+  :file: 'ml/stop_data_frame_analytics.yml'
+  :description: '*'
+-
+  :file: 'ml/text_embedding_search.yml'
+  :description: '*'
+-
+  :file: 'ml/text_expansion_search.yml'
+  :description: '*'
+-
+  :file: 'ml/text_expansion_search_rank_features.yml'
+  :description: '*'
+-
+  :file: 'ml/text_expansion_search_sparse_vector.yml'
+  :description: '*'
+-
+  :file: 'ml/trained_model_cat_apis.yml'
+  :description: '*'
+-
+  :file: 'transform/transforms_crud.yml'
+  :description: '*'
+-
+  :file: 'transform/transforms_start_stop.yml'
+  :description: '*'
+-
+  :file: 'transform/transforms_stats.yml'
+  :description: '*'
+-
+  :file: 'transform/transforms_update.yml'
+  :description: '*'
+-
+  :file: 'transform/transforms_upgrade.yml'
+  :description: '*'
+# ENDS TODO: 8.19 - 19 June 2025
+
+# TODO: 8.19 - 30 June 2025
+-
+  :file: 'inference/10_semantic_text_field_mapping.yml'
+  :description: '*'
+-
+  :file: 'inference/10_semantic_text_field_mapping_bwc.yml'
+  :description: '*'
+-
+  :file: 'inference/25_semantic_text_field_mapping_chunking.yml'
+  :description: '*'
+-
+  :file: 'inference/25_semantic_text_field_mapping_chunking_bwc.yml'
+  :description: '*'
+-
+  :file: 'inference/30_semantic_text_inference.yml'
+  :description: '*'
+-
+  :file: 'inference/30_semantic_text_inference_bwc.yml'
+  :description: '*'
+-
+  :file: 'inference/40_semantic_text_query.yml'
+  :description: '*'
+-
+  :file: 'inference/45_semantic_text_match.yml'
+  :description: '*'
+-
+  :file: 'inference/46_semantic_text_sparse_vector.yml'
+  :description: '*'
+-
+  :file: 'inference/47_semantic_text_knn.yml'
+  :description: '*'
+-
+  :file: 'inference/50_semantic_text_query_inference_endpoint_changes.yml'
+  :description: '*'
+-
+  :file: 'inference/60_semantic_text_inference_update.yml'
+  :description: '*'
+-
+  :file: 'inference/60_semantic_text_inference_update_bwc.yml'
+  :description: '*'
+-
+  :file: 'inference/70_semantic_text_exists_query.yml'
+  :description: '*'
+-
+  :file: 'inference/70_text_similarity_rank_retriever.yml'
+  :description: '*'
+-
+  :file: 'inference/80_random_rerank_retriever.yml'
+  :description: '*'
+-
+  :file: 'inference/90_semantic_text_highlighter.yml'
+  :description: '*'
+-
+  :file: 'inference/90_semantic_text_highlighter_bwc.yml'
+  :description: '*'
+# ENDS TODO: 8.19 - 30 June 2025
+# Issue with regexp parsing on test runner:
+-
+  :file: 'esql/60_enrich.yml'
+  :description: 'Enrich with brackets in policy name'
+-
+  :file: 'mustache/10_webhook.yml'
+  :description: '*'
+-
+  :file: 'mustache/50_webhook_url_escaping.yml'
+  :description: '*'
+-
+  :file: 'watcher/execute_watch/10_basic.yml'
+  :description: '*'
+-
+  :file: 'watcher/execute_watch/60_http_input.yml'
+  :description: '*'
+-
+  :file: 'watcher/settings_endpoints/10_watcher_settings.yml'
+  :description: '*'
+-
+  :file: 'watcher/execute_watch/30_throttled.yml'
+  :description: '*'
+-
+  :file: 'watcher/execute_watch/40_ignore_condition.yml'
+  :description: '*'
+-
+  :file: 'watcher/execute_watch/50_action_mode.yml'
+  :description: '*'
+-
+  :file: 'watcher/put_watch/90_auto_create_index.yml'
+  :description: '*'

data/spec/unit/actions/async_search/delete_spec.rb

@@ -0,0 +1,35 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'async_search.delete' do
+  let(:expected_args) do
+    [
+      'DELETE',
+      '_async_search/foo',
+      {},
+      nil,
+      {},
+      { endpoint: 'count' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.async_search.delete(id: 'foo')).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/unit/actions/async_search/get_spec.rb

@@ -0,0 +1,35 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'async_search.delete' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_async_search/foo',
+      {},
+      nil,
+      {},
+      { endpoint: 'count' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.async_search.get(id: 'foo')).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/unit/actions/async_search/status_spec.rb

@@ -0,0 +1,34 @@
+# 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.
+require 'spec_helper'
+
+describe 'async_search.delete' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_async_search/status/foo',
+      {},
+      nil,
+      {},
+      { endpoint: 'async_search.status' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.async_search.status(id: 'foo')).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/unit/actions/async_search/submit_spec.rb

@@ -0,0 +1,87 @@
+# 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.
+require 'spec_helper'
+
+describe 'async_search.submit' do
+  context 'with no parameters' do
+    let(:expected_args) do
+      [
+        'POST',
+        '_async_search',
+        {},
+        nil,
+        {},
+        { endpoint: 'async_search.submit' }
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.async_search.submit).to be_a Elasticsearch::API::Response
+    end
+  end
+
+  context 'with index' do
+    let(:expected_args) do
+      [
+        'DELETE',
+        '_async_search/foo',
+        {},
+        nil,
+        {},
+        { endpoint: 'count' }
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.async_search.submit).to be_a Elasticsearch::API::Response
+    end
+  end
+end
+
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class XPackAsyncSearchSubmit < Minitest::Test
+      subject { FakeClient.new }
+
+      context 'XPack: Async Search Submit' do
+        should 'perform correct request' do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal('POST', method)
+            assert_equal('_async_search', url)
+            assert_equal({}, params)
+            assert_nil(body)
+          end.returns(FakeResponse.new)
+
+          subject.async_search.submit
+        end
+
+        should 'perform correct request with index' do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal('POST', method)
+            assert_equal('foo/_async_search', url)
+            assert_equal({}, params)
+            assert_nil(body)
+          end.returns(FakeResponse.new)
+
+          subject.async_search.submit(index: 'foo')
+        end
+      end
+    end
+  end
+end

data/spec/yaml-test-runner/run.rb

@@ -64,4 +64,7 @@ logger.level = Logger::WARN unless ENV['DEBUG']
 current_branch = `git rev-parse --abbrev-ref HEAD`.strip
 branch = current_branch.match(/[0-9]\.[0-9]+/)&.[](0) || ENV['ES_YAML_TESTS_BRANCH'] || nil
 Elasticsearch::Tests::Downloader::run(tests_path, branch)
-Elasticsearch::Tests::TestRunner.new(CLIENT, tests_path, logger).run
+
+runner = Elasticsearch::Tests::TestRunner.new(CLIENT, tests_path, logger)
+runner.add_tests_to_skip('inference/10_basic.yml') # TODO: Extract into file
+runner.run

data/utils/thor/generator/docs_helper.rb

@@ -23,7 +23,7 @@ module Elasticsearch
         info['type'] = 'String' if info['type'] == 'enum' # Rename 'enums' to 'strings'
         info['type'] = 'Integer' if info['type'] == 'int' # Rename 'int' to 'Integer'
         tipo = info['type'] ? info['type'].capitalize : 'String'
-        description = info['description'] ? info['description'].strip : '[TODO]'
+        description = info['description'] ? info['description'].strip.gsub("\n", ' ') : '[TODO]'
         options = info['options'] ? "(options: #{info['options'].join(', ').strip})" : nil
         required = info['required'] ? '(*Required*)' : ''
         deprecated = info['deprecated'] ? '*Deprecated*' : ''