elasticsearch-api 8.0.0 → 8.1.0

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

@@ -23,7 +23,7 @@ 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 = {})
           headers = arguments.delete(:headers) || {}

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

@@ -25,7 +25,7 @@ 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 = {})
           headers = arguments.delete(:headers) || {}

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

@@ -24,7 +24,7 @@ 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 = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/version.rb

@@ -17,6 +17,6 @@
 
 module Elasticsearch
   module API
-    VERSION = '8.0.0'.freeze
+    VERSION = '8.1.0'.freeze
   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/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

data/spec/unit_tests_platinum/unit/security/oidc_authenticate_test.rb

@@ -0,0 +1,40 @@
+# 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 'test_helper'
+
+module Elasticsearch
+  module Test
+    class SecurityOidcAuthenticateTest < Minitest::Test
+      context 'Security: OIDC Authenticate' do
+        subject { FakeClient.new }
+
+        should 'perform correct request' do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal('POST', method)
+            assert_equal('_security/oidc/authenticate', url)
+            assert_equal({}, params)
+            assert_equal(body, {})
+            true
+          end.returns(FakeResponse.new)
+
+          subject.security.oidc_authenticate(body: {})
+        end
+      end
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/security/oidc_logout_test.rb

@@ -0,0 +1,40 @@
+# 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 'test_helper'
+
+module Elasticsearch
+  module Test
+    class SecurityOidcLogoutTest < Minitest::Test
+      context 'Security: OIDC Logout' do
+        subject { FakeClient.new }
+
+        should 'perform correct request' do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal('POST', method)
+            assert_equal('_security/oidc/logout', url)
+            assert_equal({}, params)
+            assert_equal(body, {})
+            true
+          end.returns(FakeResponse.new)
+
+          subject.security.oidc_logout(body: {})
+        end
+      end
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/security/oidc_prepare_authentication_test.rb

@@ -0,0 +1,40 @@
+# 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 'test_helper'
+
+module Elasticsearch
+  module Test
+    class SecurityOidcPrepareAuthenticationTest < Minitest::Test
+      context 'Security: OIDC Prepare_Authentication' do
+        subject { FakeClient.new }
+
+        should 'perform correct request' do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal('POST', method)
+            assert_equal('_security/oidc/prepare', url)
+            assert_equal({}, params)
+            assert_equal(body, {})
+            true
+          end.returns(FakeResponse.new)
+
+          subject.security.oidc_prepare_authentication(body: {})
+        end
+      end
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/transform/reset_transform_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 'client.transform#reset_transform' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_transform/1/_reset',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.transform.reset_transform(transform_id: 1)).to be_a Elasticsearch::API::Response
+  end
+end

data/utils/README.md

@@ -18,6 +18,11 @@ $ thor code:generate
 
 - The Ruby code will be generated in `elasticsearch-api/lib/elasticsearch/api/actions`.
 - The generator runs Rubocop to autolint and clean up the generated files.
+- You can use the environment variable `IGNORE_VERSION` to ignore the current version of the client when generating the source code documentation urls. This is currently used when generating code from `main`:
+
+```bash
+$ IGNORE_VERSION=true thor code:generate
+```
 
 ### Development
 

data/utils/thor/generate_source.rb

@@ -74,6 +74,10 @@ module Elasticsearch
           @full_namespace   = __full_namespace
           @namespace_depth  = @full_namespace.size > 0 ? @full_namespace.size - 1 : 0
           @module_namespace = @full_namespace[0, @namespace_depth]
+
+          # Don't generate code for internal APIs:
+          next if @module_namespace.flatten.first == '_internal'
+
           @method_name      = @full_namespace.last
           @parts            = __endpoint_parts
           @params           = @spec['params'] || {}

data/utils/thor/generator/files_helper.rb

@@ -49,7 +49,7 @@ module Elasticsearch
         regex = /([0-9]{1,2}\.[0-9x]{1,2})/
         version = Elasticsearch::API::VERSION.match(regex)[0]
         # TODO - How do we fix this so it doesn't depend on which branch we're running from
-        if version == '8.0'
+        if ENV['IGNORE_VERSION']
           documentation_url
         else
           documentation_url.gsub(/\/(current|master|main)\//, "/#{version}/")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-10 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -428,6 +428,8 @@ files:
 - lib/elasticsearch/api/actions/features/reset_features.rb
 - lib/elasticsearch/api/actions/field_caps.rb
 - lib/elasticsearch/api/actions/fleet/global_checkpoints.rb
+- lib/elasticsearch/api/actions/fleet/msearch.rb
+- lib/elasticsearch/api/actions/fleet/search.rb
 - lib/elasticsearch/api/actions/get.rb
 - lib/elasticsearch/api/actions/get_script.rb
 - lib/elasticsearch/api/actions/get_script_context.rb
@@ -662,6 +664,9 @@ files:
 - lib/elasticsearch/api/actions/security/has_privileges.rb
 - lib/elasticsearch/api/actions/security/invalidate_api_key.rb
 - lib/elasticsearch/api/actions/security/invalidate_token.rb
+- lib/elasticsearch/api/actions/security/oidc_authenticate.rb
+- lib/elasticsearch/api/actions/security/oidc_logout.rb
+- lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb
 - lib/elasticsearch/api/actions/security/put_privileges.rb
 - lib/elasticsearch/api/actions/security/put_role.rb
 - lib/elasticsearch/api/actions/security/put_role_mapping.rb
@@ -715,6 +720,7 @@ files:
 - lib/elasticsearch/api/actions/transform/get_transform_stats.rb
 - lib/elasticsearch/api/actions/transform/preview_transform.rb
 - lib/elasticsearch/api/actions/transform/put_transform.rb
+- lib/elasticsearch/api/actions/transform/reset_transform.rb
 - lib/elasticsearch/api/actions/transform/start_transform.rb
 - lib/elasticsearch/api/actions/transform/stop_transform.rb
 - lib/elasticsearch/api/actions/transform/update_transform.rb
@@ -821,6 +827,8 @@ files:
 - spec/elasticsearch/api/actions/features/reset_features_spec.rb
 - spec/elasticsearch/api/actions/field_caps_spec.rb
 - spec/elasticsearch/api/actions/fleet/global_checkpoints_spec.rb
+- spec/elasticsearch/api/actions/fleet/msearch_spec.rb
+- spec/elasticsearch/api/actions/fleet/search_spec.rb
 - spec/elasticsearch/api/actions/get_document_source_spec.rb
 - spec/elasticsearch/api/actions/get_document_spec.rb
 - spec/elasticsearch/api/actions/get_script_spec.rb
@@ -1061,12 +1069,16 @@ files:
 - spec/unit_tests_platinum/unit/security/grant_api_key_test.rb
 - spec/unit_tests_platinum/unit/security/has_privileges_test.rb
 - spec/unit_tests_platinum/unit/security/invalidate_token_test.rb
+- spec/unit_tests_platinum/unit/security/oidc_authenticate_test.rb
+- spec/unit_tests_platinum/unit/security/oidc_logout_test.rb
+- spec/unit_tests_platinum/unit/security/oidc_prepare_authentication_test.rb
 - spec/unit_tests_platinum/unit/security/put_privileges_test.rb
 - spec/unit_tests_platinum/unit/security/put_role_mapping_test.rb
 - spec/unit_tests_platinum/unit/security/put_role_test.rb
 - spec/unit_tests_platinum/unit/security/put_user_test.rb
 - spec/unit_tests_platinum/unit/ssl/certificates_test.rb
 - spec/unit_tests_platinum/unit/text_structure/find_structure_test.rb
+- spec/unit_tests_platinum/unit/transform/reset_transform_spec.rb
 - spec/unit_tests_platinum/unit/transform/upgrade_transforms_spec.rb
 - spec/unit_tests_platinum/unit/usage_test.rb
 - spec/unit_tests_platinum/unit/watcher/ack_watch_test.rb
@@ -1171,6 +1183,8 @@ test_files:
 - spec/elasticsearch/api/actions/features/reset_features_spec.rb
 - spec/elasticsearch/api/actions/field_caps_spec.rb
 - spec/elasticsearch/api/actions/fleet/global_checkpoints_spec.rb
+- spec/elasticsearch/api/actions/fleet/msearch_spec.rb
+- spec/elasticsearch/api/actions/fleet/search_spec.rb
 - spec/elasticsearch/api/actions/get_document_source_spec.rb
 - spec/elasticsearch/api/actions/get_document_spec.rb
 - spec/elasticsearch/api/actions/get_script_spec.rb
@@ -1411,12 +1425,16 @@ test_files:
 - spec/unit_tests_platinum/unit/security/grant_api_key_test.rb
 - spec/unit_tests_platinum/unit/security/has_privileges_test.rb
 - spec/unit_tests_platinum/unit/security/invalidate_token_test.rb
+- spec/unit_tests_platinum/unit/security/oidc_authenticate_test.rb
+- spec/unit_tests_platinum/unit/security/oidc_logout_test.rb
+- spec/unit_tests_platinum/unit/security/oidc_prepare_authentication_test.rb
 - spec/unit_tests_platinum/unit/security/put_privileges_test.rb
 - spec/unit_tests_platinum/unit/security/put_role_mapping_test.rb
 - spec/unit_tests_platinum/unit/security/put_role_test.rb
 - spec/unit_tests_platinum/unit/security/put_user_test.rb
 - spec/unit_tests_platinum/unit/ssl/certificates_test.rb
 - spec/unit_tests_platinum/unit/text_structure/find_structure_test.rb
+- spec/unit_tests_platinum/unit/transform/reset_transform_spec.rb
 - spec/unit_tests_platinum/unit/transform/upgrade_transforms_spec.rb
 - spec/unit_tests_platinum/unit/usage_test.rb
 - spec/unit_tests_platinum/unit/watcher/ack_watch_test.rb