elasticsearch-api 7.9.0 → 7.11.0

data/lib/elasticsearch/api/actions/tasks/get.rb

@@ -20,13 +20,17 @@ module Elasticsearch
     module Tasks
       module Actions
         # Returns information about a task.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
         #
         # @option arguments [String] :task_id Return the task with specified id (node_id:task_number)
         # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/tasks.html
         #
         def get(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/tasks/list.rb

@@ -20,6 +20,10 @@ module Elasticsearch
     module Tasks
       module Actions
         # Returns a list of tasks.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
         #
         # @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
         # @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all.
@@ -30,7 +34,7 @@ module Elasticsearch
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/tasks.html
         #
         def list(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/termvectors.rb

@@ -42,7 +42,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/docs-termvectors.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/docs-termvectors.html
       #
       def termvectors(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

data/lib/elasticsearch/api/actions/update.rb

@@ -34,6 +34,7 @@ module Elasticsearch
       # @option arguments [Time] :timeout Explicit operation timeout
       # @option arguments [Number] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number
       # @option arguments [Number] :if_primary_term only perform the update operation if the last operation that has changed the document has the specified primary term
+      # @option arguments [Boolean] :require_alias When true, requires destination is an alias. Default is false
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The request definition requires either `script` or partial `doc` (*Required*)
       #
@@ -42,7 +43,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/docs-update.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/docs-update.html
       #
       def update(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -89,7 +90,8 @@ module Elasticsearch
         :routing,
         :timeout,
         :if_seq_no,
-        :if_primary_term
+        :if_primary_term,
+        :require_alias
       ].freeze)
     end
   end

data/lib/elasticsearch/api/actions/update_by_query.rb

@@ -66,7 +66,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/docs-update-by-query.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/docs-update-by-query.html
       #
       def update_by_query(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb

@@ -24,7 +24,7 @@ module Elasticsearch
       # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*)
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/docs-update-by-query.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/docs-update-by-query.html
       #
       def update_by_query_rethrottle(arguments = {})
         raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]

data/lib/elasticsearch/api/version.rb

@@ -17,6 +17,6 @@
 
 module Elasticsearch
   module API
-    VERSION = "7.9.0"
+    VERSION = '7.11.0'.freeze
   end
 end

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

@@ -49,13 +49,12 @@ describe 'client#msearch' do
   end
 
   it 'requires the :body argument' do
-    expect {
+    expect do
       client.msearch
-    }.to raise_exception(ArgumentError)
+    end.to raise_exception(ArgumentError)
   end
 
   context 'when the body is an object' do
-
     let(:body) do
       <<-PAYLOAD.gsub(/^\s+/, '')
             {"index":"foo"}
@@ -68,16 +67,19 @@ describe 'client#msearch' do
     end
 
     it 'performs the request' do
-      expect(client_double.msearch body: [
-          { index: 'foo', search: { query: { match_all: {}  } } },
-          { index: 'bar', search: { query: { match: { foo: 'bar' } } } },
-          { search_type: 'count', search: { facets: { tags: {} } } }
-      ])
+      expect(
+        client_double.msearch(
+          body: [
+            { index: 'foo', search: { query: { match_all: {}  } } },
+            { index: 'bar', search: { query: { match: { foo: 'bar' } } } },
+            { search_type: 'count', search: { facets: { tags: {} } } }
+          ]
+        )
+      )
     end
   end
 
   context 'when the body is a string' do
-
     let(:body) do
       %Q|{"foo":"bar"}\n{"moo":"lam"}|
     end
@@ -88,7 +90,6 @@ describe 'client#msearch' do
   end
 
   context 'when an index is specified' do
-
     let(:url) do
       'foo/_msearch'
     end
@@ -102,25 +103,9 @@ describe 'client#msearch' do
     end
   end
 
-  context 'when a type and index are specified' do
-
-    let(:url) do
-      'foo/bar/_msearch'
-    end
-
-    let(:body) do
-      ''
-    end
-
-    it 'performs the request' do
-      expect(client_double.msearch(index: 'foo', type: 'bar', body: []))
-    end
-  end
-
-  context 'when multiple indices and multiple types are specified' do
-
+  context 'when multiple indices are specified' do
     let(:url) do
-      'foo,bar/lam,bam/_msearch'
+      'foo,bar/_msearch'
     end
 
     let(:body) do
@@ -128,14 +113,13 @@ describe 'client#msearch' do
     end
 
     it 'performs the request' do
-      expect(client_double.msearch(index: ['foo', 'bar'], type: ['lam', 'bam'], body: []))
+      expect(client_double.msearch(index: ['foo', 'bar'], body: []))
     end
   end
 
   context 'when the request needs to be URL-escaped' do
-
     let(:url) do
-      'foo%5Ebar/bar%2Fbam/_msearch'
+      'foo%5Ebar/_msearch'
     end
 
     let(:body) do
@@ -143,12 +127,11 @@ describe 'client#msearch' do
     end
 
     it 'performs the request' do
-      expect(client_double.msearch(index: 'foo^bar', type: 'bar/bam', body: [])).to eq({})
+      expect(client_double.msearch(index: 'foo^bar', body: [])).to eq({})
     end
   end
 
   context 'when the URL params need to be URL-encoded' do
-
     let(:url) do
       '_msearch'
     end

data/spec/elasticsearch/api/actions/snapshot/clone_spec.rb

@@ -0,0 +1,67 @@
+# 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.snapshot#clone' do
+  let(:expected_args) do
+    [
+        'PUT',
+        '_snapshot/foo/bar/_clone/snapshot',
+        {},
+        {},
+        {}
+    ]
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'requires the :body argument' do
+    expect {
+      client.snapshot.clone(snapshot: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :repository argument' do
+    expect {
+      client.snapshot.clone(snapshot: 'foo', body: {})
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :snapshot argument' do
+    expect {
+      client.snapshot.clone(repository: 'foo', body: {})
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :target_snapshot argument' do
+    expect {
+      client.snapshot.clone(repository: 'foo', body: {}, snapshot: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'performs the request' do
+    expect(client_double.snapshot.clone(
+             repository: 'foo',
+             snapshot: 'bar',
+             body: {},
+             target_snapshot: 'snapshot'
+           )).to eq({})
+  end
+end

data/spec/elasticsearch/api/rest_api_yaml_spec.rb

@@ -8,11 +8,18 @@ require 'rest_yaml_tests_helper'
 describe 'Rest API YAML tests' do
   # Traverse YAML files and create TestFile object:
   REST_API_YAML_FILES.each do |file|
-    test_file = Elasticsearch::RestAPIYAMLTests::TestFile.new(file, REST_API_YAML_SKIP_FEATURES)
+    begin
+      test_file = Elasticsearch::RestAPIYAMLTests::TestFile.new(file, ADMIN_CLIENT, REST_API_YAML_SKIP_FEATURES)
+    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 = Logger.new($stdout)
+      logger.info "Skipping #{file} due to 'skip all'."
+      next
+    end
 
     context "#{file.gsub("#{YAML_FILES_DIRECTORY}/", '')}" do
       test_file.tests.each do |test|
-
         context "#{test.description}" do
           if test.skip_test?(ADMIN_CLIENT)
             skip 'Test contains feature(s) not yet supported or version is not satisfied'
@@ -23,13 +30,13 @@ describe 'Rest API YAML tests' do
 
             # Runs once before each test in a test file
             before(:all) do
-              Elasticsearch::RestAPIYAMLTests::TestFile.clear_data(ADMIN_CLIENT)
-              test_file.setup(ADMIN_CLIENT)
+              Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
+              test_file.setup
             end
 
             after(:all) do
-              test_file.teardown(ADMIN_CLIENT)
-              Elasticsearch::RestAPIYAMLTests::TestFile.clear_data(ADMIN_CLIENT)
+              test_file.teardown
+              Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
             end
 
             test.task_groups.each do |task_group|

data/spec/rest_yaml_tests_helper.rb

@@ -22,7 +22,7 @@ include Elasticsearch::RestAPIYAMLTests
 TRANSPORT_OPTIONS = {}
 PROJECT_PATH = File.join(File.dirname(__FILE__), '..', '..')
 
-if hosts = ELASTICSEARCH_URL
+if (hosts = ELASTICSEARCH_URL)
   split_hosts = hosts.split(',').map do |host|
     /(http\:\/\/)?\S+/.match(host)
   end
@@ -49,11 +49,19 @@ end
 
 
 YAML_FILES_DIRECTORY = "#{File.expand_path(File.dirname('..'), '..')}" +
-    "/tmp/elasticsearch/rest-api-spec/src/main/resources/rest-api-spec/test"
+                       '/tmp/elasticsearch/rest-api-spec/src/main/resources/rest-api-spec/test'
 
 SINGLE_TEST = if ENV['SINGLE_TEST'] && !ENV['SINGLE_TEST'].empty?
-                ["#{File.expand_path(File.dirname('..'), '..')}" +
-                     "/tmp/elasticsearch/rest-api-spec/src/main/resources/rest-api-spec/test/#{ENV['SINGLE_TEST']}"]
+                test_target = ENV['SINGLE_TEST']
+                path = File.expand_path(File.dirname('..'), '..')
+
+                if test_target.match?(/\.yml$/)
+                  ["#{path}/tmp/elasticsearch/rest-api-spec/src/main/resources/rest-api-spec/test/#{test_target}"]
+                else
+                  Dir.glob(
+                    ["#{path}/tmp/elasticsearch/rest-api-spec/src/main/resources/rest-api-spec/test/#{test_target}/*.yml"]
+                  )
+                end
               end
 
 skipped_tests = []
@@ -86,10 +94,6 @@ skipped_tests << { file:        'delete/70_mix_typeless_typeful.yml',
 skipped_tests << { file:        'cat.templates/10_basic.yml',
                    description: '*' }
 
-# node_selector is not supported yet
-skipped_tests << { file: 'cat.aliases/10_basic.yml',
-                   description: '*' }
-
 # Responses are there but not equal (eg.: yellow status)
 skipped_tests << { file: 'cluster.health/10_basic.yml',
                    description: 'cluster health with closed index (pre 7.2.0)' }
@@ -98,10 +102,16 @@ skipped_tests << { file: 'cluster.health/10_basic.yml',
 skipped_tests << { file: 'cat.indices/10_basic.yml',
                    description: 'Test cat indices output for closed index (pre 7.2.0)' }
 
+# TODO
+skipped_tests << {
+  file: 'nodes.info/10_basic.yml',
+  description: 'node_info role test'
+}
+
 SKIPPED_TESTS = skipped_tests
 
 # The directory of rest api YAML files.
 REST_API_YAML_FILES = SINGLE_TEST || Dir.glob("#{YAML_FILES_DIRECTORY}/**/*.yml")
 
 # The features to skip
-REST_API_YAML_SKIP_FEATURES = ['warnings'].freeze
+REST_API_YAML_SKIP_FEATURES = ['warnings', 'node_selector'].freeze

data/utils/thor/generator/endpoint_specifics.rb

@@ -136,11 +136,11 @@ module Elasticsearch
               end.
               map { |item| Elasticsearch::API.serializer.dump(item) }
             payload << "" unless payload.empty?
-            payload = payload.join("\n")
+            payload = payload.join("\\n")
           when body.is_a?(Array)
             payload = body.map { |d| d.is_a?(String) ? d : Elasticsearch::API.serializer.dump(d) }
             payload << "" unless payload.empty?
-            payload = payload.join("\n")
+            payload = payload.join("\\n")
           else
             payload = body
           end

data/utils/thor/templates/_documentation_top.erb

@@ -12,7 +12,7 @@
 <%- end -%><%# Body -%>
 <%# URL parameters -%>
 <%- @params.each do |name, info| -%>
-  <%= docs_helper(name, info) -%>
+  <%= docs_helper(name, info) unless (!@parts.empty? && @parts.keys.include?(name)) -%>
 <%- end -%>
 # @option arguments [Hash] :headers Custom HTTP headers
 <%- if @spec['body'] -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 7.9.0
+  version: 7.11.0
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-18 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: shoulda-context
   requirement: !ruby/object:Gem::Requirement
@@ -340,7 +340,7 @@ dependencies:
         version: '0'
 description: 'Ruby API for Elasticsearch. See the `elasticsearch` gem for full integration.
 
-'
+  '
 email:
 - karel.minarik@elasticsearch.org
 executables: []
@@ -500,6 +500,7 @@ files:
 - lib/elasticsearch/api/actions/search_shards.rb
 - lib/elasticsearch/api/actions/search_template.rb
 - lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb
+- lib/elasticsearch/api/actions/snapshot/clone.rb
 - lib/elasticsearch/api/actions/snapshot/create.rb
 - lib/elasticsearch/api/actions/snapshot/create_repository.rb
 - lib/elasticsearch/api/actions/snapshot/delete.rb
@@ -642,6 +643,7 @@ files:
 - spec/elasticsearch/api/actions/search_shards_spec.rb
 - spec/elasticsearch/api/actions/search_spec.rb
 - spec/elasticsearch/api/actions/search_template_spec.rb
+- spec/elasticsearch/api/actions/snapshot/clone_spec.rb
 - spec/elasticsearch/api/actions/snapshot/create_repository_spec.rb
 - spec/elasticsearch/api/actions/snapshot/create_spec.rb
 - spec/elasticsearch/api/actions/snapshot/delete_repository_spec.rb
@@ -702,7 +704,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby API for Elasticsearch.
@@ -819,6 +821,7 @@ test_files:
 - spec/elasticsearch/api/actions/search_shards_spec.rb
 - spec/elasticsearch/api/actions/search_spec.rb
 - spec/elasticsearch/api/actions/search_template_spec.rb
+- spec/elasticsearch/api/actions/snapshot/clone_spec.rb
 - spec/elasticsearch/api/actions/snapshot/create_repository_spec.rb
 - spec/elasticsearch/api/actions/snapshot/create_spec.rb
 - spec/elasticsearch/api/actions/snapshot/delete_repository_spec.rb