elasticsearch-api 7.8.0 → 7.8.1

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

@@ -28,7 +28,6 @@ module Elasticsearch
       # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
       # @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 [Hash] :headers Custom HTTP headers
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/search-shards.html

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

@@ -27,13 +27,11 @@ module Elasticsearch
       # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
       # @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 [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [List] :routing A comma-separated list of specific routing values
       # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
       # @option arguments [String] :search_type Search operation type
       #   (options: query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)
-
       # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
       # @option arguments [Boolean] :profile Specify whether to profile the query execution
       # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response

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

@@ -28,7 +28,6 @@ module Elasticsearch
         # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
         # @option arguments [String] :group_by Group tasks by nodes or parent/child relationships
         #   (options: nodes,parents,none)
-
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #

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

@@ -35,7 +35,6 @@ module Elasticsearch
       # @option arguments [Number] :version Explicit version number for concurrency control
       # @option arguments [String] :version_type Specific version type
       #   (options: internal,external,external_gte,force)
-
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body Define parameters and or supply a document to get termvectors for. See documentation.
       #

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

@@ -30,7 +30,6 @@ module Elasticsearch
       # @option arguments [String] :lang The script language (default: painless)
       # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.
       #   (options: true,false,wait_for)
-
       # @option arguments [Number] :retry_on_conflict Specify how many times should the operation be retried when a conflict occurs (default: 0)
       # @option arguments [String] :routing Specific routing value
       # @option arguments [Time] :timeout Explicit operation timeout

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

@@ -27,17 +27,14 @@ module Elasticsearch
       # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
       # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
       #   (options: AND,OR)
-
       # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
       # @option arguments [Number] :from Starting offset (default: 0)
       # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
       # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
       # @option arguments [String] :conflicts What to do when the update by query hits version conflicts?
       #   (options: abort,proceed)
-
       # @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] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
       # @option arguments [String] :pipeline Ingest pipeline to set on index requests made by this action. (default: none)
       # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
@@ -46,7 +43,6 @@ module Elasticsearch
       # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
       # @option arguments [String] :search_type Search operation type
       #   (options: query_then_fetch,dfs_query_then_fetch)
-
       # @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout.
       # @option arguments [Number] :size Deprecated, please use `max_docs` instead
       # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)

data/lib/elasticsearch/api/version.rb

@@ -17,6 +17,6 @@
 
 module Elasticsearch
   module API
-    VERSION = "7.8.0"
+    VERSION = "7.8.1"
   end
 end

data/utils/thor/generate_source.rb

@@ -222,12 +222,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" : ''
+        options = info['options'] ? "\n    #   (options: #{info['options'].join(', '.strip)})" : nil
         required = info['required'] ? ' (*Required*)' : ''
         deprecated = info['deprecated'] ? ' *Deprecated*' : ''
         "# @option arguments [#{tipo}] :#{name} #{description} #{required} #{deprecated} #{options}\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
         copy_file 'templates/test_helper.rb', @output.join('test').join('test_helper.rb')
 

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| -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 7.8.0
+  version: 7.8.1
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-18 00:00:00.000000000 Z
+date: 2020-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -695,7 +695,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.