elasticsearch-api 7.9.0.pre → 7.11.0.pre.1

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)' }
@@ -104,4 +108,4 @@ SKIPPED_TESTS = skipped_tests
 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/generate_source.rb

@@ -229,10 +229,38 @@ module Elasticsearch
         info['type'] = 'String' if info['type'] == 'enum' # Rename 'enums' to 'strings'
         tipo = info['type'] ? info['type'].capitalize : 'String'
         description = info['description'] ? info['description'].strip : '[TODO]'
-        options = info['options'] ? "\n    #   (options: #{info['options'].join(', '.strip)})\n" : ''
-        required = info['required'] ? ' (*Required*)' : ''
-        deprecated = info['deprecated'] ? ' *Deprecated*' : ''
-        "# @option arguments [#{tipo}] :#{name} #{description} #{required} #{deprecated} #{options}\n"
+        options = info['options'] ? "(options: #{info['options'].join(', ').strip})" : nil
+        required = info['required'] ? '(*Required*)' : ''
+        deprecated = info['deprecated'] ? '*Deprecated*' : ''
+        optionals = [required, deprecated, options].join(' ').strip
+
+        "# @option arguments [#{tipo}] :#{name} #{description} #{optionals}\n"
+      end
+
+      def stability_doc_helper(stability)
+        return if stability == 'stable'
+
+        if stability == 'experimental'
+          <<~MSG
+            # 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.
+          MSG
+        elsif stability == 'beta'
+          <<~MSG
+            # This functionality is in Beta and is subject to change. The design and
+            # code is less mature than official GA features and is being provided
+            # as-is with no warranties. Beta features are not subject to the support
+            # SLA of official GA features.
+          MSG
+        else
+          <<~MSG
+            # This functionality is subject to potential breaking changes within a
+            # minor version, meaning that your referencing code may break when this
+            # library is upgraded.
+          MSG
+        end
       end
 
       def generate_tests

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

@@ -3,6 +3,7 @@
 <%- else %>
   <%= '  '*(@namespace_depth+3) %># TODO: Description
 <%- end %>
+<%= stability_doc_helper(@spec['stability']) -%>
 <%= '  '*(@namespace_depth+3) %>#
 <%- unless @parts.nil? || @parts.empty? %><%# URL parts -%>
   <%- @parts.each do |name, info| -%>
@@ -11,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.pre
+  version: 7.11.0.pre.1
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2021-01-11 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: []
@@ -425,11 +425,8 @@ files:
 - lib/elasticsearch/api/actions/indices/clone.rb
 - lib/elasticsearch/api/actions/indices/close.rb
 - lib/elasticsearch/api/actions/indices/create.rb
-- lib/elasticsearch/api/actions/indices/create_data_stream.rb
-- lib/elasticsearch/api/actions/indices/data_streams_stats.rb
 - lib/elasticsearch/api/actions/indices/delete.rb
 - lib/elasticsearch/api/actions/indices/delete_alias.rb
-- lib/elasticsearch/api/actions/indices/delete_data_stream.rb
 - lib/elasticsearch/api/actions/indices/delete_index_template.rb
 - lib/elasticsearch/api/actions/indices/delete_template.rb
 - lib/elasticsearch/api/actions/indices/exists.rb
@@ -443,7 +440,6 @@ files:
 - lib/elasticsearch/api/actions/indices/freeze.rb
 - lib/elasticsearch/api/actions/indices/get.rb
 - lib/elasticsearch/api/actions/indices/get_alias.rb
-- lib/elasticsearch/api/actions/indices/get_data_stream.rb
 - lib/elasticsearch/api/actions/indices/get_field_mapping.rb
 - lib/elasticsearch/api/actions/indices/get_index_template.rb
 - lib/elasticsearch/api/actions/indices/get_mapping.rb
@@ -504,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
@@ -589,7 +586,6 @@ files:
 - spec/elasticsearch/api/actions/indices/clone_spec.rb
 - spec/elasticsearch/api/actions/indices/close_spec.rb
 - spec/elasticsearch/api/actions/indices/create_spec.rb
-- spec/elasticsearch/api/actions/indices/data_streams_stats_spec.rb
 - spec/elasticsearch/api/actions/indices/delete_alias_spec.rb
 - spec/elasticsearch/api/actions/indices/delete_spec.rb
 - spec/elasticsearch/api/actions/indices/delete_template_spec.rb
@@ -647,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
@@ -767,7 +764,6 @@ test_files:
 - spec/elasticsearch/api/actions/indices/clone_spec.rb
 - spec/elasticsearch/api/actions/indices/close_spec.rb
 - spec/elasticsearch/api/actions/indices/create_spec.rb
-- spec/elasticsearch/api/actions/indices/data_streams_stats_spec.rb
 - spec/elasticsearch/api/actions/indices/delete_alias_spec.rb
 - spec/elasticsearch/api/actions/indices/delete_spec.rb
 - spec/elasticsearch/api/actions/indices/delete_template_spec.rb
@@ -825,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

data/lib/elasticsearch/api/actions/indices/create_data_stream.rb

@@ -1,49 +0,0 @@
-# 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.
-
-module Elasticsearch
-  module API
-    module Indices
-      module Actions
-        # Creates or updates a data stream
-        #
-        # @option arguments [String] :name The name of the data stream
-        # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The data stream definition
-        #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/data-streams.html
-        #
-        def create_data_stream(arguments = {})
-          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
-
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _name = arguments.delete(:name)
-
-          method = Elasticsearch::API::HTTP_PUT
-          path   = "_data_stream/#{Utils.__listify(_name)}"
-          params = {}
-
-          body = arguments[:body]
-          perform_request(method, path, params, body, headers).body
-        end
-      end
-    end
-  end
-end

data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb

@@ -1,62 +0,0 @@
-# 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.
-
-module Elasticsearch
-  module API
-    module Indices
-      module Actions
-        # Provides statistics on operations happening in a data stream.
-        #
-        # @option arguments [List] :name A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams
-        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
-        #   (options: open,closed,hidden,none,all)
-
-        # @option arguments [Boolean] :forbid_closed_indices If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/data-streams.html
-        #
-        def data_streams_stats(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _name = arguments.delete(:name)
-
-          method = Elasticsearch::API::HTTP_GET
-          path   = if _name
-                     "_data_stream/#{Utils.__listify(_name)}/_stats"
-                   else
-                     "_data_stream/_stats"
-                   end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
-          perform_request(method, path, params, body, headers).body
-        end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:data_streams_stats, [
-          :expand_wildcards,
-          :forbid_closed_indices
-        ].freeze)
-      end
-    end
-  end
-end

data/lib/elasticsearch/api/actions/indices/delete_data_stream.rb

@@ -1,48 +0,0 @@
-# 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.
-
-module Elasticsearch
-  module API
-    module Indices
-      module Actions
-        # Deletes a data stream.
-        #
-        # @option arguments [List] :name A comma-separated list of data streams to delete; use `*` to delete all data streams
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/data-streams.html
-        #
-        def delete_data_stream(arguments = {})
-          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
-
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _name = arguments.delete(:name)
-
-          method = Elasticsearch::API::HTTP_DELETE
-          path   = "_data_stream/#{Utils.__listify(_name)}"
-          params = {}
-
-          body = nil
-          perform_request(method, path, params, body, headers).body
-        end
-      end
-    end
-  end
-end