elasticsearch-api 8.0.0.pre1 → 8.1.2

data/lib/elasticsearch/api/actions/watcher/put_watch.rb

@@ -29,17 +29,16 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The watch
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/watcher-api-put-watch.html
         #
         def put_watch(arguments = {})
           raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
           body = arguments.delete(:body)
 
-          arguments = arguments.clone
-
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_PUT

data/lib/elasticsearch/api/actions/watcher/query_watches.rb

@@ -24,14 +24,13 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body From, size, query, sort and search_after
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/watcher-api-query-watches.html
         #
         def query_watches(arguments = {})
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body = arguments.delete(:body)
-
-          arguments = arguments.clone
+          body   = arguments.delete(:body)
 
           method = if body
                      Elasticsearch::API::HTTP_POST

data/lib/elasticsearch/api/actions/watcher/start.rb

@@ -23,14 +23,13 @@ module Elasticsearch
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/watcher-api-start.html
         #
         def start(arguments = {})
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body = nil
-
-          arguments = arguments.clone
+          body   = nil
 
           method = Elasticsearch::API::HTTP_POST
           path   = "_watcher/_start"

data/lib/elasticsearch/api/actions/watcher/stats.rb

@@ -25,15 +25,14 @@ module Elasticsearch
         # @option arguments [Boolean] :emit_stacktraces Emits stack traces of currently running watches
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/watcher-api-stats.html
         #
         def stats(arguments = {})
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
           body = nil
 
-          arguments = arguments.clone
-
           _metric = arguments.delete(:metric)
 
           method = Elasticsearch::API::HTTP_GET

data/lib/elasticsearch/api/actions/watcher/stop.rb

@@ -23,14 +23,13 @@ module Elasticsearch
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/watcher-api-stop.html
         #
         def stop(arguments = {})
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body = nil
-
-          arguments = arguments.clone
+          body   = nil
 
           method = Elasticsearch::API::HTTP_POST
           path   = "_watcher/_stop"

data/lib/elasticsearch/api/actions/xpack/info.rb

@@ -25,14 +25,13 @@ module Elasticsearch
         # @option arguments [Boolean] :accept_enterprise If this param is used it must be set to true *Deprecated*
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/info-api.html
         #
         def info(arguments = {})
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body = nil
-
-          arguments = arguments.clone
+          body   = nil
 
           method = Elasticsearch::API::HTTP_GET
           path   = "_xpack"

data/lib/elasticsearch/api/actions/xpack/usage.rb

@@ -24,14 +24,13 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Specify timeout for watch write operation
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.1/usage-api.html
         #
         def usage(arguments = {})
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body = nil
-
-          arguments = arguments.clone
+          body   = nil
 
           method = Elasticsearch::API::HTTP_GET
           path   = "_xpack/usage"

data/lib/elasticsearch/api/utils.rb

@@ -14,14 +14,13 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+require 'erb'
 
 module Elasticsearch
   module API
-
     # Generic utility methods
     #
     module Utils
-
       # URL-escape a string
       #
       # @example
@@ -31,7 +30,7 @@ module Elasticsearch
       # @api private
       def __escape(string)
         return string if string == '*'
-        defined?(EscapeUtils) ? EscapeUtils.escape_url(string.to_s) : CGI.escape(string.to_s)
+        ERB::Util.url_encode(string.to_s)
       end
 
       # Create a "list" of values from arguments, ignoring nil values and encoding special characters.

data/lib/elasticsearch/api/version.rb

@@ -17,6 +17,6 @@
 
 module Elasticsearch
   module API
-    VERSION = '8.0.0.pre1'.freeze
+    VERSION = '8.1.2'.freeze
   end
 end

data/spec/elasticsearch/api/actions/bulk_spec.rb

@@ -18,7 +18,6 @@
 require 'spec_helper'
 
 describe 'client#bulk' do
-
   let(:expected_args) do
     [
         'POST',
@@ -35,31 +34,29 @@ describe 'client#bulk' do
   let(:body) { '' }
 
   context 'when a list of operations is provided' do
-
     let(:body) do
       <<-PAYLOAD.gsub(/^\s+/, '')
-        {"index":{"_index":"myindexA","_type":"mytype","_id":"1"}}
+        {"index":{"_index":"myindexA","_id":"1"}}
         {"title":"Test"}
-        {"update":{"_index":"myindexB","_type":"mytype","_id":"2"}}
+        {"update":{"_index":"myindexB","_id":"2"}}
         {"doc":{"title":"Update"}}
-        {"delete":{"_index":"myindexC","_type":"mytypeC","_id":"3"}}
-        {"index":{"_index":"myindexD","_type":"mytype","_id":"1"}}
+        {"delete":{"_index":"myindexC","_id":"3"}}
+        {"index":{"_index":"myindexD","_id":"1"}}
         {"data":"MYDATA"}
       PAYLOAD
     end
 
     it 'performs the request' do
       expect(client_double.bulk(:body => [
-          { :index =>  { :_index => 'myindexA', :_type => 'mytype', :_id => '1', :data => { :title => 'Test' } } },
-          { :update => { :_index => 'myindexB', :_type => 'mytype', :_id => '2', :data => { :doc => { :title => 'Update' } } } },
-          { :delete => { :_index => 'myindexC', :_type => 'mytypeC', :_id => '3' } },
-          { :index =>  { :_index => 'myindexD', :_type => 'mytype', :_id => '1', :data => { :data => 'MYDATA' } } },
+          { :index =>  { :_index => 'myindexA', :_id => '1', :data => { :title => 'Test' } } },
+          { :update => { :_index => 'myindexB', :_id => '2', :data => { :doc => { :title => 'Update' } } } },
+          { :delete => { :_index => 'myindexC', :_id => '3' } },
+          { :index =>  { :_index => 'myindexD', :_id => '1', :data => { :data => 'MYDATA' } } },
       ])).to be_a Elasticsearch::API::Response
     end
   end
 
   context 'when an index is specified' do
-
     let(:url) { 'myindex/_bulk' }
 
     it 'performs the request' do
@@ -68,22 +65,20 @@ describe 'client#bulk' do
   end
 
   context 'when there are data keys in the head/data payloads' do
-
     let(:body) do
       <<-PAYLOAD.gsub(/^\s+/, '')
-        {"update":{"_index":"myindex","_type":"mytype","_id":"1"}}
+        {"update":{"_index":"myindex","_id":"1"}}
         {"doc":{"data":{"title":"Update"}}}
       PAYLOAD
     end
 
     it 'performs the request' do
-      expect(client_double.bulk(body:[ { :update => { :_index => 'myindex', :_type => 'mytype', :_id => '1' } },
+      expect(client_double.bulk(body:[ { :update => { :_index => 'myindex', :_id => '1' } },
                                        { :doc => { :data => { :title => 'Update' } } } ])).to be_a Elasticsearch::API::Response
     end
   end
 
   context 'when the payload is a string' do
-
     let(:body) do
       'foo\nbar'
     end
@@ -94,7 +89,6 @@ describe 'client#bulk' do
   end
 
   context 'when the payload is an array of Strings' do
-
     let(:body) do
       "foo\nbar\n"
     end
@@ -105,7 +99,6 @@ describe 'client#bulk' do
   end
 
   context 'when there are parameters' do
-
     let(:params) do
       { refresh: true }
     end
@@ -116,7 +109,6 @@ describe 'client#bulk' do
   end
 
   context 'when url characters need to be URL-escaped' do
-
     let(:url) do
       'foo%5Ebar/_bulk'
     end
@@ -125,15 +117,4 @@ describe 'client#bulk' do
       expect(client_double.bulk(index: 'foo^bar', body: [])).to be_a Elasticsearch::API::Response
     end
   end
-
-  context 'when the type is provided' do
-
-    let(:url) do
-      'myindex/mytype/_bulk'
-    end
-
-    it 'performs the request' do
-      expect(client_double.bulk(index: 'myindex', type: 'mytype', body: [])).to be_a Elasticsearch::API::Response
-    end
-  end
 end

data/spec/elasticsearch/api/actions/count_spec.rb

@@ -18,10 +18,9 @@
 require 'spec_helper'
 
 describe 'client#count' do
-
   let(:expected_args) do
     [
-      'POST',
+      'GET',
       '_count',
       {},
       nil,
@@ -34,10 +33,9 @@ describe 'client#count' do
   end
 
   context 'when an index and type are specified' do
-
     let(:expected_args) do
       [
-        'POST',
+        'GET',
         'foo,bar/_count',
         {},
         nil,
@@ -51,7 +49,6 @@ describe 'client#count' do
   end
 
   context 'when there is a query provided' do
-
     let(:expected_args) do
       [
         'POST',

data/spec/elasticsearch/api/actions/delete_document_spec.rb

@@ -22,7 +22,7 @@ describe 'client#delete' do
   let(:expected_args) do
     [
         'DELETE',
-        'foo/bar/1',
+        'foo/_doc/1',
         params,
         nil,
         {}
@@ -39,18 +39,18 @@ describe 'client#delete' do
 
   it 'requires the :index argument' do
     expect {
-      client.delete(type: 'bar', id: '1')
+      client.delete(id: '1')
     }.to raise_exception(ArgumentError)
   end
 
   it 'requires the :id argument' do
     expect {
-      client.delete(index: 'foo', type: 'bar')
+      client.delete(index: 'foo')
     }.to raise_exception(ArgumentError)
   end
 
   it 'performs the request' do
-    expect(client_double.delete(index: 'foo', type: 'bar', id: '1')).to be_a Elasticsearch::API::Response
+    expect(client_double.delete(index: 'foo', id: '1')).to be_a Elasticsearch::API::Response
   end
 
   context 'when url params are provided' do
@@ -59,7 +59,7 @@ describe 'client#delete' do
     end
 
     it 'performs the request' do
-      expect(client_double.delete(index: 'foo', type: 'bar', id: '1', routing: 'abc123')).to be_a Elasticsearch::API::Response
+      expect(client_double.delete(index: 'foo', id: '1', routing: 'abc123')).to be_a Elasticsearch::API::Response
     end
   end
 
@@ -67,7 +67,7 @@ describe 'client#delete' do
     let(:expected_args) do
       [
           'DELETE',
-          'foo%5Ebar/bar%2Fbam/1',
+          'foo%5Ebar/_doc/1',
           params,
           nil,
           {}
@@ -75,7 +75,7 @@ describe 'client#delete' do
     end
 
     it 'escapes the url params' do
-      expect(client_double.delete(index: 'foo^bar', type: 'bar/bam', id: 1)).to be_a Elasticsearch::API::Response
+      expect(client_double.delete(index: 'foo^bar', id: 1)).to be_a Elasticsearch::API::Response
     end
   end
 
@@ -86,13 +86,13 @@ describe 'client#delete' do
 
     it 'raises the exception' do
       expect {
-        client.delete(index: 'foo', type: 'bar', id: 'XXX')
+        client.delete(index: 'foo', id: 'XXX')
       }.to raise_exception(NotFound)
     end
 
     context 'when the :ignore option is provided' do
       it 'does not raise the NotFound exception' do
-        expect(client.delete(index: 'foo', type: 'bar', id: 1, ignore: 404)).to eq(false)
+        expect(client.delete(index: 'foo', id: 1, ignore: 404)).to eq(false)
       end
     end
   end

data/spec/elasticsearch/api/actions/fleet/msearch_spec.rb

@@ -0,0 +1,44 @@
+# 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#fleet.msearch' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_fleet/_fleet_msearch',
+      {},
+      {},
+      { 'Content-Type' => 'application/x-ndjson' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.fleet.msearch(body: {})).to be_a Elasticsearch::API::Response
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'requires the :body argument' do
+    expect {
+      client.fleet.msearch
+    }.to raise_exception(ArgumentError)
+  end
+end

data/spec/elasticsearch/api/actions/fleet/search_spec.rb

@@ -0,0 +1,44 @@
+# 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#fleet.search' do
+  let(:expected_args) do
+    [
+      'GET',
+      'foo/_fleet/_fleet_search',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.fleet.search(index: 'foo')).to be_a Elasticsearch::API::Response
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'requires the :index argument' do
+    expect {
+      client.fleet.search
+    }.to raise_exception(ArgumentError)
+  end
+end

data/spec/elasticsearch/api/actions/indices/validate_query_spec.rb

@@ -55,16 +55,6 @@ describe 'client.cluster#validate_query' do
     end
   end
 
-  context 'when a type and index are specified' do
-    let(:url) do
-      'foo/bar/_validate/query'
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.validate_query(index: 'foo', type: 'bar')).to be_a Elasticsearch::API::Response
-    end
-  end
-
   context 'when multiple indicies are specified as a list' do
     let(:url) do
       'foo,bar/_validate/query'

data/spec/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats_spec.rb

@@ -0,0 +1,56 @@
+# 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#ml.get_model_snapshot_upgrade_stats' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_ml/anomaly_detectors/foo/model_snapshots/bar/_upgrade/_stats',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(
+      client_double.ml.get_model_snapshot_upgrade_stats(job_id: 'foo', snapshot_id: 'bar')
+    ).to be_a Elasticsearch::API::Response
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  context 'when a job_id is not provided' do
+    it 'raises an exception' do
+      expect {
+        client.ml.get_model_snapshot_upgrade_stats(snapshot_id: 'foo')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when a snapshot_id is not provided' do
+    it 'raises an exception' do
+      expect {
+        client.ml.get_model_snapshot_upgrade_stats(job_id: 'foo')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+end

data/spec/elasticsearch/api/actions/update_document_spec.rb

@@ -33,7 +33,7 @@ describe 'client#update' do
   end
 
   let(:url) do
-    'foo/bar/1/_update'
+    'foo/_update/1'
   end
 
   let(:client) do
@@ -46,23 +46,23 @@ describe 'client#update' do
 
   it 'requires the :index argument' do
     expect {
-      client.update(type: 'bar', id: '1')
+      client.update(id: '1')
     }.to raise_exception(ArgumentError)
   end
 
   it 'requires the :id argument' do
     expect {
-      client.update(index: 'foo', type: 'bar')
+      client.update(index: 'foo')
     }.to raise_exception(ArgumentError)
   end
 
   it 'performs the request' do
-    expect(client_double.update(index: 'foo', type: 'bar', id: '1', body: { doc: {} })).to be_a Elasticsearch::API::Response
+    expect(client_double.update(index: 'foo', id: '1', body: { doc: {} })).to be_a Elasticsearch::API::Response
   end
 
   context 'when URL parameters are provided' do
     let(:url) do
-      'foo/bar/1/_update'
+      'foo/_update/1'
     end
 
     let(:body) do
@@ -70,13 +70,13 @@ describe 'client#update' do
     end
 
     it 'performs the request' do
-      expect(client_double.update(index: 'foo', type: 'bar', id: '1', body: {}))
+      expect(client_double.update(index: 'foo', id: '1', body: {}))
     end
   end
 
   context 'when the request needs to be URL-escaped' do
     let(:url) do
-      'foo%5Ebar/bar%2Fbam/1/_update'
+      'foo%5Ebar/_update/1'
     end
 
     let(:body) do
@@ -84,7 +84,7 @@ describe 'client#update' do
     end
 
     it 'escapes the parts' do
-      expect(client_double.update(index: 'foo^bar', type: 'bar/bam', id: '1', body: {}))
+      expect(client_double.update(index: 'foo^bar', id: '1', body: {}))
     end
   end
 
@@ -95,13 +95,13 @@ describe 'client#update' do
 
     it 'raises it to the user' do
       expect {
-        client.update(index: 'foo', type: 'bar', id: 'XXX', body: {})
+        client.update(index: 'foo', id: 'XXX', body: {})
       }.to raise_exception(NotFound)
     end
 
     context 'when the :ignore parameter is specified' do
       it 'does not raise the error to the user' do
-        expect(client.update(index: 'foo', type: 'bar', id: 'XXX', body: {}, ignore: 404)).to eq(false)
+        expect(client.update(index: 'foo', id: 'XXX', body: {}, ignore: 404)).to eq(false)
       end
     end
   end

data/spec/elasticsearch/api/rest_api_yaml_spec.rb

@@ -30,10 +30,10 @@ describe 'Rest API YAML tests' do
   REST_API_YAML_FILES.each do |file|
     begin
       test_file = Elasticsearch::RestAPIYAMLTests::TestFile.new(file, ADMIN_CLIENT, REST_API_YAML_SKIP_FEATURES)
-    rescue SkipTestsException => _e
+    rescue SkipTestsException => e
       # If the test file has a `skip` at the top level that applies to this
       # version of Elasticsearch, continue with the next text.
-      LOGGER.info "Skipping #{file} due to 'skip all'."
+      LOGGER.info e.message
       next
     end
 
@@ -69,7 +69,12 @@ describe 'Rest API YAML tests' do
               if task_group.has_match_clauses?
                 task_group.match_clauses.each do |match|
                   it 'contains the expected error in the request response' do
-                    expect(task_group.exception.message).to match(Regexp.new(Regexp.escape(match['match'].values.first.to_s)))
+                    regexp = if (val = match['match'].values.first.to_s).include?('\\s')
+                               Regexp.new(val.gsub('\\\\', '\\').gsub('/', ''))
+                             else
+                               Regexp.new(Regexp.escape(val))
+                             end
+                    expect(task_group.exception.message).to match(regexp)
                   end
                 end
               end