elasticsearch-api 8.15.0 → 8.17.0

data/spec/elasticsearch/api/actions/ingest/put_ip_location_database_spec.rb

@@ -0,0 +1,45 @@
+# 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.ingest#put_ip_location_database' do
+  let(:expected_args) do
+    [
+      'PUT',
+      '_ingest/ip_location/database/foo',
+      {},
+      {},
+      {},
+      { defined_params: { id: 'foo' }, endpoint: 'ingest.put_ip_location_database' }
+    ]
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'requires the :id argument' do
+    expect {
+      client.ingest.put_ip_location_database
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'performs the request' do
+    expect(client_double.ingest.put_ip_location_database(id: 'foo', body: {})).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/query_rules/test_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.query_rules#test' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_query_rules/foo/_test',
+      {},
+      {},
+      {},
+      { defined_params: { ruleset_id: 'foo' }, endpoint: 'query_rules.test' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.query_rules.test(ruleset_id: 'foo', body: {})).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/perform_request_spec.rb

@@ -23,7 +23,7 @@ require_relative '../../../utils/thor/generator/files_helper'
 describe 'Perform request args' do
   Elasticsearch::API::FilesHelper.files.each do |filepath|
     spec = Elasticsearch::API::EndpointSpec.new(filepath)
-    next if spec.module_namespace.flatten.first == '_internal'
+    next if spec.module_namespace.flatten.first == '_internal' || spec.visibility != 'public'
 
     # These are the path parts defined by the user in the method argument
     defined_path_parts = spec.path_params.inject({}) do |params, part|

data/spec/rest_api/rest_api_yaml_spec.rb

@@ -37,7 +37,7 @@ describe 'Rest API YAML tests' do
 
   if REST_API_YAML_FILES.empty?
     LOGGER.error 'No test files found!'
-    LOGGER.info 'Use rake rake elasticsearch:download_artifacts in the root directory of the project to download the test artifacts.'
+    LOGGER.info 'Use rake rake es:download_artifacts in the root directory of the project to download the test artifacts.'
     exit 1
   end
 
@@ -82,6 +82,9 @@ describe 'Rest API YAML tests' do
             # ./run_task_groups.rb
             run_rspec_matchers_on_task_group(task_group, test)
           end
+        rescue StandardError => e
+          LOGGER.error e
+          raise e
         end
       end
     end

data/spec/rest_api/skipped_tests_free.yml

@@ -125,3 +125,106 @@
 -
   :file: 'logsdb/10_settings.yml'
   :description: '*'
+-
+  :file: 'search.vectors/180_update_dense_vector_type.yml'
+  :description: 'Test create and update dense vector mapping to int4 with per-doc indexing and flush'
+-
+  :file: 'simulate.ingest/10_basic.yml'
+  :description: 'Test mapping validation'
+-
+  :file: 'nodes.stats/11_indices_metrics.yml'
+  :description: 'Lucene segment level fields stats'
+-
+  :file: 'search.suggest/20_phrase.yml'
+  :description: 'breaks ties by sorting terms'
+# Regexp issues with catching an error
+-
+  :file: 'analysis-common/40_token_filters.yml'
+  :description: 'stemmer_override file access'
+- # Migrated to YAML tests:
+  :file: 'ingest_geoip/30_geoip_stats.yml'
+  :description: '*'
+- # Testing server:
+  :file: 'ingest_geoip/20_geoip_processor.yml'
+  :description: '*'
+-
+  :file: 'simulate.ingest/10_basic.yml'
+  :description: 'Test mapping validation from templates'
+-
+  :file: 'indices.split/40_routing_partition_size.yml'
+  :description: '*'
+-
+  :file: 'ingest_geoip/40_geoip_databases.yml'
+  :description: 'Test adding, getting, and removing geoip databases'
+-
+  :file: 'ingest_geoip/50_ip_lookup_processor.yml'
+  :description: '*'
+-
+  :file: 'ingest_geoip/60_ip_location_databases.yml'
+  :description: '*'
+-
+  :file: 'index/91_metrics_no_subobjects.yml'
+  :description: 'Metrics object indexing with synthetic source'
+-
+  :file: 'indices.create/20_synthetic_source.yml'
+  :description: '*'
+-
+  :file: 'indices.create/21_synthetic_source_stored.yml'
+  :description: '*'
+-
+  :file: 'indices.put_mapping/10_basic.yml'
+  :description: 'disabling synthetic source fails'
+-
+  :file: 'logsdb/20_source_mapping.yml'
+  :description: 'synthetic _source is default'
+-
+  :file: 'index/92_metrics_auto_subobjects.yml'
+  :description: 'Metrics object indexing with synthetic source'
+-
+  :file: 'tsdb/20_mapping.yml'
+  :description: 'Synthetic source'
+-
+  :file: 'search.highlight/50_synthetic_source.yml'
+  :description: 'text multi fvh source order'
+-
+  :file: 'search.highlight/50_synthetic_source.yml'
+  :description: 'text multi fvh score order'
+-
+  :file: 'update/100_synthetic_source.yml'
+  :description: 'stored text'
+-
+  :file: 'get/100_synthetic_source.yml'
+  :description: 'fetch without refresh also produces synthetic source'
+-
+  :file: 'update/100_synthetic_source.yml'
+  :description: 'stored text'
+-
+  :file: 'update/100_synthetic_source.yml'
+  :description: 'keyword'
+-
+  :file: 'update/100_synthetic_source.yml'
+  :description: 'fetch without refresh also produces synthetic source'
+-
+  :file: 'get/100_synthetic_source.yml'
+  :description: 'flattened field'
+-
+  :file: 'get/100_synthetic_source.yml'
+  :description: 'flattened field with ignore_above and arrays'
+-
+  :file: 'range/20_synthetic_source.yml'
+  :description: '*'
+-
+  :file: 'logsdb/20_source_mapping.yml'
+  :description: 'disabled _source is not supported'
+-
+  :file: 'logsdb/20_source_mapping.yml'
+  :description: 'include/exclude is not supported with synthetic _source'
+-
+  :file: 'tsdb/20_mapping.yml'
+  :description: 'disabled source is not supported'
+-
+  :file: 'tsdb/20_mapping.yml'
+  :description: 'source include/exclude'
+-
+  :file: 'cluster.stats/40_source_modes.yml'
+  :description: 'test source modes'

data/spec/rest_api/skipped_tests_platinum.yml

@@ -49,7 +49,9 @@
 -
   :file: 'snapshot/10_basic.yml'
   :description: 'Create a source only snapshot and then restore it'
-
+-
+  :file: 'snapshot/10_basic.yml'
+  :description: 'Failed to snapshot indices with synthetic source'
 -
   :file: 'token/10_basic.yml'
   :description: "Test invalidate user's tokens"
@@ -205,3 +207,22 @@
 -
   :file: 'entsearch/20_usage.yml'
   :description: '*'
+# TODO: Update test runnner. Error is ok but Regexp shenanigans
+-
+  :file: 'eql/60_no_exact.yml'
+  :description: 'Case insensitive match on text field'
+-
+  :file: 'esql/180_match_operator.yml'
+  :description: '*'
+-
+  :file: 'esql/60_usage.yml'
+  :description: 'Basic ESQL usage output (telemetry) non-snapshot version'
+-
+  :file: 'wildcard/30_ignore_above_synthetic_source.yml'
+  :description: 'wildcard field type ignore_above'
+-
+  :file: 'wildcard/20_ignore_above_stored_source.yml'
+  :description: 'wildcard field type ignore_above'
+-
+  :file: 'esql/150_lookup.yml'
+  :description: '*'

data/spec/spec_helper.rb

@@ -59,6 +59,7 @@ end
 RSpec.configure do |config|
   config.include(HelperModule)
   config.add_formatter('documentation')
+  config.filter_run_excluding skip: true
   if defined?(JRUBY_VERSION)
     config.add_formatter('RSpec::Core::Formatters::HtmlFormatter', "tmp/elasticsearch-#{ENV['TEST_SUITE']}-jruby-#{JRUBY_VERSION}.html")
   else

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

@@ -49,17 +49,19 @@ elsif uri.is_a?(URI::HTTP)
   transport_options = {}
 end
 
-if ENV['ES_API_KEY']
-  CLIENT = Elasticsearch::Client.new(host: host, api_key: ENV['ES_API_KEY'], transport_options: transport_options)
-else
-  CLIENT = Elasticsearch::Client.new(host: host, transport_options: transport_options)
-end
-
+CLIENT = if ENV['ES_API_KEY']
+           Elasticsearch::Client.new(host: host, api_key: ENV['ES_API_KEY'], transport_options: transport_options)
+         else
+           Elasticsearch::Client.new(host: host, transport_options: transport_options)
+         end
 
 tests_path = File.expand_path('./tmp', __dir__)
 
 logger = Logger.new($stdout)
 logger.level = Logger::WARN unless ENV['DEBUG']
 
-Elasticsearch::Tests::Downloader::run(tests_path)
+# If we're running in a release branch, download the corresponding branch for tests
+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

data/utils/README.md

@@ -8,7 +8,7 @@ This directory hosts The Generator, a tool that generates the classes for each A
 
 To generate the code, you need to have the Elasticsearch REST API spec files in `tmp/rest-api-spec` in the root of the project. You can run a rake task from the root of the project to download the specs corresponding to the current running cluster:
 ```bash
-$ rake elasticsearch:download_artifacts
+$ rake es:download_artifacts
 ```
 
 Once the JSON files have been downloaded, you need to run (from this folder):
@@ -24,7 +24,7 @@ $ thor code:generate
 $ IGNORE_VERSION=true thor code:generate
 ```
 
-- You can use the environment variable `BUILD_HASH` to update the build hash for the generated code from the `tmp/rest-api-spec/build_hash` file. This file is updated every time you use the `elasticsearch:download_artifacts` Rake task is used in the root of the project to download the latest Elasticsearch specs and tests:
+- You can use the environment variable `BUILD_HASH` to update the build hash for the generated code from the `tmp/rest-api-spec/build_hash` file. This file is updated every time you use the `es:download_artifacts` Rake task is used in the root of the project to download the latest Elasticsearch specs and tests:
 ```bash
 $ BUILD_HASH=true thor code:generate
 ```

data/utils/thor/endpoint_spec.rb

@@ -24,6 +24,23 @@ module Elasticsearch
     class EndpointSpec
       include EndpointSpecifics
 
+      # These APIs are private, but were added in 8.x since the generator didn't consider
+      # visibility. They will be removed in 9.x since we're using a different generator that
+      # considers visibility. But new private APIs code won't be generated for the client.
+      EXCLUDED_8X = [
+        'autoscaling.delete_autoscaling_policy', 'autoscaling.get_autoscaling_capacity',
+        'autoscaling.get_autoscaling_policy', 'autoscaling.put_autoscaling_policy', 'capabilities',
+        'connector.secret_delete', 'connector.secret_get', 'connector.secret_post',
+        'connector.secret_put', 'fleet.delete_secret', 'fleet.get_secret', 'fleet.post_secret',
+        'ml.validate', 'ml.validate_detector', 'monitoring.bulk', 'profiling.flamegraph',
+        'profiling.stacktraces', 'profiling.status', 'profiling.topn_functions',
+        'security.activate_user_profile', 'security.disable_user_profile',
+        'security.enable_user_profile', 'security.get_user_profile',
+        'security.has_privileges_user_profile', 'security.suggest_user_profiles',
+        'security.update_user_profile_data', 'shutdown.delete_node', 'shutdown.get_node',
+        'shutdown.put_node'
+      ].freeze
+
       def initialize(filepath)
         @path = Pathname(filepath)
         json = MultiJson.load(File.read(@path))
@@ -31,14 +48,14 @@ module Elasticsearch
         @endpoint_name = json.keys.first
 
         full_namespace = parse_full_namespace
-        @namespace_depth = full_namespace.size > 0 ? full_namespace.size - 1 : 0
+        @namespace_depth = full_namespace.size.positive? ? full_namespace.size - 1 : 0
         @module_namespace = full_namespace[0, @namespace_depth]
         @method_name = full_namespace.last
 
         @path_parts = parse_endpoint_parts(@spec)
         @params = @spec['params'] || {}
         @paths = @spec['url']['paths'].map { |b| b['path'] } if @spec['url']
-        @path_params   = path_variables.flatten.uniq.collect(&:to_sym)
+        @path_params = path_variables.flatten.uniq.collect(&:to_sym)
         @http_method = parse_http_method(@spec)
         @deprecation_note = @spec['url']['paths'].last&.[]('deprecated')
         @http_path        = parse_http_path(@paths)
@@ -71,6 +88,16 @@ module Elasticsearch
         @spec['stability']
       end
 
+      def visibility
+        @spec['visibility']
+      end
+
+      def skippable?
+        return true if module_namespace.flatten.first == '_internal'
+
+        visibility != 'public' && !EXCLUDED_8X.include?(endpoint_name)
+      end
+
       # Function that adds the listified h param code
       def specific_params
         super(@module_namespace.first, @method_name)

data/utils/thor/endpoint_specifics.rb

@@ -39,6 +39,7 @@ module Elasticsearch
         indices.delete
         indices.delete_template
         indices.flush_synced
+        query_rules.delete_ruleset
         security.get_role
         security.get_user
         snapshot.delete
@@ -99,16 +100,14 @@ module Elasticsearch
         <<~SRC
           case
           when body.is_a?(Array) && body.any? { |d| d.has_key? :search }
-            payload = body.
-              inject([]) do |sum, item|
+            payload = body.inject([]) do |sum, item|
                 meta = item
                 data = meta.delete(:search)
 
                 sum << meta
                 sum << data
                 sum
-              end.
-              map { |item| Elasticsearch::API.serializer.dump(item) }
+              end.map { |item| Elasticsearch::API.serializer.dump(item) }
             payload << "" unless payload.empty?
             payload = payload.join("\\n")
           when body.is_a?(Array)

data/utils/thor/generate_source.rb

@@ -68,7 +68,7 @@ module Elasticsearch
           @spec = EndpointSpec.new(filepath)
           say_status 'json', @spec.path, :yellow
           # Don't generate code for internal APIs:
-          next if @spec.module_namespace.flatten.first == '_internal'
+          next if @spec.skippable?
 
           path_to_file = output.join(@spec.module_namespace.join('/')).join("#{@spec.method_name}.rb")
           dir = output.join(@spec.module_namespace.join('/'))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 8.15.0
+  version: 8.17.0
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-13 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -562,14 +562,18 @@ files:
 - lib/elasticsearch/api/actions/inference/get.rb
 - lib/elasticsearch/api/actions/inference/inference.rb
 - lib/elasticsearch/api/actions/inference/put.rb
+- lib/elasticsearch/api/actions/inference/stream_inference.rb
 - lib/elasticsearch/api/actions/info.rb
 - lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb
+- lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb
 - lib/elasticsearch/api/actions/ingest/delete_pipeline.rb
 - lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb
 - lib/elasticsearch/api/actions/ingest/get_geoip_database.rb
+- lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb
 - lib/elasticsearch/api/actions/ingest/get_pipeline.rb
 - lib/elasticsearch/api/actions/ingest/processor_grok.rb
 - lib/elasticsearch/api/actions/ingest/put_geoip_database.rb
+- lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb
 - lib/elasticsearch/api/actions/ingest/put_pipeline.rb
 - lib/elasticsearch/api/actions/ingest/simulate.rb
 - lib/elasticsearch/api/actions/knn_search.rb
@@ -685,6 +689,7 @@ files:
 - lib/elasticsearch/api/actions/query_rules/list_rulesets.rb
 - lib/elasticsearch/api/actions/query_rules/put_rule.rb
 - lib/elasticsearch/api/actions/query_rules/put_ruleset.rb
+- lib/elasticsearch/api/actions/query_rules/test.rb
 - lib/elasticsearch/api/actions/rank_eval.rb
 - lib/elasticsearch/api/actions/reindex.rb
 - lib/elasticsearch/api/actions/reindex_rethrottle.rb
@@ -1049,13 +1054,17 @@ files:
 - spec/elasticsearch/api/actions/inference/get_spec.rb
 - spec/elasticsearch/api/actions/inference/inference_spec.rb
 - spec/elasticsearch/api/actions/inference/put_spec.rb
+- spec/elasticsearch/api/actions/inference/stream_inference_spec.rb
 - spec/elasticsearch/api/actions/info_spec.rb
 - spec/elasticsearch/api/actions/ingest/delete_geoip_database_spec.rb
+- spec/elasticsearch/api/actions/ingest/delete_ip_location_database_spec.rb
 - spec/elasticsearch/api/actions/ingest/delete_pipeline_spec.rb
 - spec/elasticsearch/api/actions/ingest/geo_ip_stats_spec.rb
 - spec/elasticsearch/api/actions/ingest/get_geoip_database_spec.rb
+- spec/elasticsearch/api/actions/ingest/get_ip_location_database_spec.rb
 - spec/elasticsearch/api/actions/ingest/get_pipeline_spec.rb
 - spec/elasticsearch/api/actions/ingest/put_geoip_database_spec.rb
+- spec/elasticsearch/api/actions/ingest/put_ip_location_database_spec.rb
 - spec/elasticsearch/api/actions/ingest/put_pipeline_spec.rb
 - spec/elasticsearch/api/actions/ingest/simulate_spec.rb
 - spec/elasticsearch/api/actions/json_builders_spec.rb
@@ -1094,6 +1103,7 @@ files:
 - spec/elasticsearch/api/actions/query_rules/get_spec.rb
 - spec/elasticsearch/api/actions/query_rules/put_ruleset_spec.rb
 - spec/elasticsearch/api/actions/query_rules/put_spec.rb
+- spec/elasticsearch/api/actions/query_rules/test_spec.rb
 - spec/elasticsearch/api/actions/rank_eval_spec.rb
 - spec/elasticsearch/api/actions/reindex_spec.rb
 - spec/elasticsearch/api/actions/render_search_template_spec.rb
@@ -1366,7 +1376,7 @@ metadata:
   changelog_uri: https://github.com/elastic/elasticsearch-ruby/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-api
   bug_tracker_uri: https://github.com/elastic/elasticsearch-ruby/issues
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -1382,8 +1392,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key: 
+rubygems_version: 3.5.20
+signing_key:
 specification_version: 4
 summary: Ruby API for Elasticsearch.
 test_files:
@@ -1530,13 +1540,17 @@ test_files:
 - spec/elasticsearch/api/actions/inference/get_spec.rb
 - spec/elasticsearch/api/actions/inference/inference_spec.rb
 - spec/elasticsearch/api/actions/inference/put_spec.rb
+- spec/elasticsearch/api/actions/inference/stream_inference_spec.rb
 - spec/elasticsearch/api/actions/info_spec.rb
 - spec/elasticsearch/api/actions/ingest/delete_geoip_database_spec.rb
+- spec/elasticsearch/api/actions/ingest/delete_ip_location_database_spec.rb
 - spec/elasticsearch/api/actions/ingest/delete_pipeline_spec.rb
 - spec/elasticsearch/api/actions/ingest/geo_ip_stats_spec.rb
 - spec/elasticsearch/api/actions/ingest/get_geoip_database_spec.rb
+- spec/elasticsearch/api/actions/ingest/get_ip_location_database_spec.rb
 - spec/elasticsearch/api/actions/ingest/get_pipeline_spec.rb
 - spec/elasticsearch/api/actions/ingest/put_geoip_database_spec.rb
+- spec/elasticsearch/api/actions/ingest/put_ip_location_database_spec.rb
 - spec/elasticsearch/api/actions/ingest/put_pipeline_spec.rb
 - spec/elasticsearch/api/actions/ingest/simulate_spec.rb
 - spec/elasticsearch/api/actions/json_builders_spec.rb
@@ -1575,6 +1589,7 @@ test_files:
 - spec/elasticsearch/api/actions/query_rules/get_spec.rb
 - spec/elasticsearch/api/actions/query_rules/put_ruleset_spec.rb
 - spec/elasticsearch/api/actions/query_rules/put_spec.rb
+- spec/elasticsearch/api/actions/query_rules/test_spec.rb
 - spec/elasticsearch/api/actions/rank_eval_spec.rb
 - spec/elasticsearch/api/actions/reindex_spec.rb
 - spec/elasticsearch/api/actions/render_search_template_spec.rb