elasticsearch-api 6.2.0 → 6.3.0

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

@@ -18,8 +18,8 @@ module Elasticsearch
       # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
       # @option arguments [String] :routing Specific routing value
       # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
-      # @option arguments [List] :_source_exclude A list of fields to exclude from the returned _source field
-      # @option arguments [List] :_source_include A list of fields to extract and return from the _source field
+      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
       # @option arguments [Number] :version Explicit version number for concurrency control
       # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
 
@@ -44,6 +44,7 @@ module Elasticsearch
       end
       alias_method :exists?, :exists
 
+
       # Register this action with its valid params when the module is loaded.
       #
       # @since 6.2.0
@@ -55,9 +56,7 @@ module Elasticsearch
           :refresh,
           :routing,
           :_source,
-          :_source_exclude,
           :_source_excludes,
-          :_source_include,
           :_source_includes,
           :version,
           :version_type ].freeze)

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

@@ -0,0 +1,51 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # The get API allows to get a typed JSON document from the index based on its id.
+      #
+      # @option arguments [String] :id The document ID (*Required*)
+      # @option arguments [String] :index The name of the index (*Required*)
+      # @option arguments [String] :type The type of the document; use `_all` to fetch the first document matching the ID across all types (*Required*)
+      # @option arguments [String] :parent The ID of the parent document
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
+      # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
+      # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
+      # @option arguments [String] :routing Specific routing value
+      # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
+      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
+      # @option arguments [Number] :version Explicit version number for concurrency control
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
+      #
+      # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
+      #
+      def exists_source(arguments={})
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+        raise ArgumentError, "Required argument 'type' missing" unless arguments[:type]
+        method = Elasticsearch::API::HTTP_HEAD
+        path   = "#{arguments[:index]}/#{arguments[:type]}/#{arguments[:id]}/_source"
+        params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        body   = nil
+
+        perform_request(method, path, params, body).body
+      end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:exists_source, [
+          :parent,
+          :preference,
+          :realtime,
+          :refresh,
+          :routing,
+          :_source,
+          :_source_excludes,
+          :_source_includes,
+          :version,
+          :version_type ].freeze)
+    end
+  end
+end

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

@@ -18,29 +18,20 @@ module Elasticsearch
       # @option arguments [String] :id The document ID (*Required*)
       # @option arguments [String] :index The name of the index (*Required*)
       # @option arguments [String] :type The type of the document (*Required*)
-      # @option arguments [Hash] :body The query definition using the Query DSL (*Required*)
-      # @option arguments [Boolean] :analyze_wildcard Specify whether wildcards and prefix queries in the query string
-      #                                               query should be analyzed (default: false)
+      # @option arguments [Hash] :body The query definition using the Query DSL
+      # @option arguments [Boolean] :analyze_wildcard Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
       # @option arguments [String] :analyzer The analyzer for the query string query
-      # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
-      #                                              (options: AND, OR)
+      # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
       # @option arguments [String] :df The default field for query string query (default: _all)
-      # @option arguments [List] :fields A comma-separated list of fields to return in the response
-      # @option arguments [Boolean] :lenient Specify whether format-based query failures
-      #                                      (such as providing text to a numeric field) should be ignored
-      # @option arguments [Boolean] :lowercase_expanded_terms Specify whether query terms should be lowercased
+      # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
+      # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
       # @option arguments [String] :parent The ID of the parent document
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
-      #                                        (default: random)
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [String] :q Query in the Lucene query string syntax
       # @option arguments [String] :routing Specific routing value
-      # @option arguments [String] :source The URL-encoded query definition (instead of using the request body)
-      # @option arguments [String] :_source Specify whether the _source field should be returned,
-      #                                     or a list of fields to return
-      # @option arguments [String] :_source_exclude A list of fields to exclude from the returned _source field
-      # @option arguments [String] :_source_include A list of fields to extract and return from the _source field
-      # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
-      #
+      # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
+      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
       # @see http://elasticsearch.org/guide/reference/api/explain/
       #
       def explain(arguments={})
@@ -69,20 +60,15 @@ module Elasticsearch
           :analyzer,
           :default_operator,
           :df,
-          :fields,
+          :stored_fields,
           :lenient,
-          :lowercase_expanded_terms,
           :parent,
           :preference,
           :q,
           :routing,
-          :source,
           :_source,
-          :_source_include,
-          :_source_includes,
-          :_source_exclude,
           :_source_excludes,
-          :stored_fields ].freeze)
+          :_source_includes ].freeze)
     end
   end
 end

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

@@ -10,12 +10,12 @@ module Elasticsearch
       #
       # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
       # @option arguments [Hash] :body Field json objects containing an array of field names
-      # @option arguments [List] :fields A comma-separated list of field names (*Required*)
+      # @option arguments [List] :fields A comma-separated list of field names
       # @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] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
       #
-      # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html
+      # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html
       #
       def field_caps(arguments={})
         raise ArgumentError, "Required argument 'fields' missing" unless arguments[:fields]

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

@@ -11,25 +11,21 @@ module Elasticsearch
       #     client.get index: 'myindex', type: 'mytype', id: '1'
       #
       # @option arguments [String] :id The document ID (*Required*)
-      # @option arguments [Number,List] :ignore The list of HTTP errors to ignore; only `404` supported at the moment
       # @option arguments [String] :index The name of the index (*Required*)
-      # @option arguments [String] :type The type of the document; use `_all` to fetch the first document
-      #                                  matching the ID across all types) (*Required*)
-      # @option arguments [List] :fields A comma-separated list of fields to return in the response
+      # @option arguments [String] :type The type of the document (use `_all` to fetch the first document matching the ID across all types) (*Required*)
+      # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
       # @option arguments [String] :parent The ID of the parent document
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
-      #                                        (default: random)
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
       # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
       # @option arguments [String] :routing Specific routing value
+      # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
+      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
+      # @option arguments [List] :_source_exclude A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_include A list of fields to extract and return from the _source field
       # @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 [String] :_source Specify whether the _source field should be returned,
-      #                                     or a list of fields to return
-      # @option arguments [String] :_source_exclude A list of fields to exclude from the returned _source field
-      # @option arguments [String] :_source_include A list of fields to extract and return from the _source field
-      # @option arguments [Boolean] :_source_transform Retransform the source before returning it
-      # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
       #
       # @see http://elasticsearch.org/guide/reference/api/get/
       #
@@ -58,21 +54,19 @@ module Elasticsearch
       #
       # @since 6.2.0
       ParamsRegistry.register(:get, [
-          :fields,
+          :stored_fields,
           :parent,
           :preference,
           :realtime,
           :refresh,
           :routing,
-          :version,
-          :version_type,
           :_source,
-          :_source_include,
+          :_source_excludes,
           :_source_includes,
           :_source_exclude,
-          :_source_excludes,
-          :_source_transform,
-          :stored_fields ].freeze)
+          :_source_include,
+          :version,
+          :version_type ].freeze)
     end
   end
 end

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

@@ -5,9 +5,9 @@ module Elasticsearch
       # Retrieve an indexed script from Elasticsearch
       #
       # @option arguments [String] :id Script ID (*Required*)
-      # @option arguments [String] :lang Script language
+      # @option arguments [Time] :master_timeout Specify timeout for connection to master
       #
-      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html#_indexed_scripts
+      # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
       #
       def get_script(arguments={})
         raise ArgumentError, "Required argument 'id' missing"   unless arguments[:id]
@@ -18,6 +18,13 @@ module Elasticsearch
 
         perform_request(method, path, params, body).body
       end
+
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:get_script, [
+          :master_timeout ].freeze)
     end
   end
 end

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

@@ -11,21 +11,18 @@ module Elasticsearch
       #     client.get_source index: 'myindex', type: 'mytype', id: '1'
       #
       # @option arguments [String] :id The document ID (*Required*)
-      # @option arguments [Number,List] :ignore The list of HTTP errors to ignore; only `404` supported at the moment
       # @option arguments [String] :index The name of the index (*Required*)
-      # @option arguments [String] :type The type of the document; use `_all` to fetch the first document
-      #                                  matching the ID across all types) (*Required*)
-      # @option arguments [List] :fields A comma-separated list of fields to return in the response
+      # @option arguments [String] :type The type of the document; use `_all` to fetch the first document matching the ID across all types (*Required*)
       # @option arguments [String] :parent The ID of the parent document
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
-      #                                        (default: random)
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
       # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
       # @option arguments [String] :routing Specific routing value
-      # @option arguments [String] :_source Specify whether the _source field should be returned,
-      #                                     or a list of fields to return
-      # @option arguments [String] :_source_exclude A list of fields to exclude from the returned _source field
-      # @option arguments [String] :_source_include A list of fields to extract and return from the _source field
+      # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
+      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
+      # @option arguments [Number] :version Explicit version number for concurrency control
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
       #
       # @see http://elasticsearch.org/guide/reference/api/get/
       #
@@ -55,17 +52,16 @@ module Elasticsearch
       #
       # @since 6.2.0
       ParamsRegistry.register(:get_source, [
-          :fields,
           :parent,
           :preference,
           :realtime,
           :refresh,
           :routing,
           :_source,
-          :_source_include,
+          :_source_excludes,
           :_source_includes,
-          :_source_exclude,
-          :_source_excludes ].freeze)
+          :version,
+          :version_type ].freeze)
     end
   end
 end

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

@@ -50,23 +50,21 @@ module Elasticsearch
       #     sleep 3 and client.get index: 'myindex', type: 'mytype', id: '1'
       #     # => Elasticsearch::Transport::Transport::Errors::NotFound: [404] ...
       #
-      # @option arguments [String] :id Document ID (optional, will be auto-generated if missing)
+      # @option arguments [String] :id Document ID
       # @option arguments [String] :index The name of the index (*Required*)
       # @option arguments [String] :type The type of the document (*Required*)
-      # @option arguments [Hash] :body The document
-      # @option arguments [String] :consistency Explicit write consistency setting for the operation
-      #                                         (options: one, quorum, all)
+      # @option arguments [Hash] :body The document (*Required*)
+      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
       # @option arguments [String] :op_type Explicit operation type (options: index, create)
       # @option arguments [String] :parent ID of the parent document
-      # @option arguments [String] :percolate Percolator queries to execute while indexing the document
-      # @option arguments [Boolean] :refresh Refresh the index after performing the operation
-      # @option arguments [String] :replication Specific replication type (options: sync, async)
+      # @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 [String] :routing Specific routing value
       # @option arguments [Time] :timeout Explicit operation timeout
-      # @option arguments [Time] :timestamp Explicit timestamp for the document
-      # @option arguments [Duration] :ttl Expiration time for the document
       # @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 [Number] :if_seq_no only perform the index operation if the last operation that has changed the document has the specified sequence number
+      # @option arguments [Number] :if_primary_term only perform the index operation if the last operation that has changed the document has the specified primary term
+      # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
       #
@@ -88,21 +86,17 @@ module Elasticsearch
       #
       # @since 6.2.0
       ParamsRegistry.register(:index, [
-          :consistency,
+          :wait_for_active_shards,
           :op_type,
           :parent,
-          :percolate,
-          :pipeline,
           :refresh,
-          :replication,
           :routing,
           :timeout,
-          :timestamp,
-          :ttl,
           :version,
           :version_type,
           :if_seq_no,
-          :if_primary_term ].freeze)
+          :if_primary_term,
+          :pipeline ].freeze)
     end
   end
 end

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

@@ -28,21 +28,7 @@ module Elasticsearch
         #                                char_filter: ['html_strip'] }
         #
         # @option arguments [String] :index The name of the index to scope the operation
-        # @option arguments [String] :body The text on which the analysis should be performed
-        # @option arguments [String] :analyzer The name of the analyzer to use
-        # @option arguments [String] :field Use the analyzer configured for this field
-        #                                   (instead of passing the analyzer name)
-        # @option arguments [List] :filters A comma-separated list of token filters to use for the analysis.
-        #                                   (Also available as the `:token_filters` option)
-        # @option arguments [List] :char_filters A comma-separated list of char filters to use for the analysis
-        # @option arguments [Boolean] :explain Whether to output further details (default: false)
-        # @option arguments [List] :attributes A comma-separated list of token attributes to output (use with `:explain`)
-        # @option arguments [String] :index The name of the index to scope the operation
-        # @option arguments [Boolean] :prefer_local With `true`, specify that a local shard should be used if available,
-        #                                           with `false`, use a random shard (default: true)
-        # @option arguments [String] :text The text on which the analysis should be performed
-        #                                  (when request body is not used)
-        # @option arguments [String] :tokenizer The name of the tokenizer to use for the analysis
+        # @option arguments [Hash] :body Define analyzer/tokenizer parameters and the text on which the analysis should be performed
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-analyze/
         #
@@ -58,22 +44,12 @@ module Elasticsearch
           perform_request(method, path, params, body).body
         end
 
+        # Register this action with its valid params when the module is loaded.
         # Register this action with its valid params when the module is loaded.
         #
         # @since 6.2.0
         ParamsRegistry.register(:analyze, [
-            :analyzer,
-            :char_filters,
-            :explain,
-            :attributes,
-            :field,
-            :filters,
-            :filter,
-            :index,
-            :prefer_local,
-            :text,
-            :tokenizer,
-            :token_filters ].freeze)
+            :index ].freeze)
       end
     end
   end

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

@@ -23,15 +23,14 @@ module Elasticsearch
         #     client.indices.clear_cache field_data: true, fields: 'created_at', filter_cache: false, id_cache: false
         #
         # @option arguments [List] :index A comma-separated list of index name to limit the operation
-        # @option arguments [Boolean] :field_data Clear field data
+        # @option arguments [Boolean] :field_data Clear field data. This is deprecated. Prefer `fielddata`.
         # @option arguments [Boolean] :fielddata Clear field data
-        # @option arguments [List] :fields A comma-separated list of fields to clear when using the `field_data` parameter (default: all)
+        # @option arguments [List] :fields A comma-separated list of fields to clear when using the `fielddata` parameter (default: all)
         # @option arguments [Boolean] :query Clear query caches
         # @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] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
         # @option arguments [List] :index A comma-separated list of index name to limit the operation
-        # @option arguments [Boolean] :recycler Clear the recycler cache
         # @option arguments [Boolean] :request_cache Clear request cache
         # @option arguments [Boolean] :request Clear request cache
         #
@@ -61,7 +60,6 @@ module Elasticsearch
             :allow_no_indices,
             :expand_wildcards,
             :index,
-            :recycler,
             :request_cache,
             :request ].freeze)
       end

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

@@ -11,20 +11,14 @@ module Elasticsearch
         #
         #     client.indices.close index: 'myindex'
         #
-        # @option arguments [List] :index A comma separated list of indices to perform the operation on
-        #                                 (*Required*)
-        # @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)
-        # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
-        #                                            `missing` ones (options: none, missing) @until 1.0
-        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-        #                                                 unavailable (missing, closed, etc)
+        # @option arguments [List] :index A comma separated list of indices to close (*Required*)
         # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @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] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
         #
-        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html
         #
         def close(arguments={})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -41,11 +35,11 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:close, [
-            :ignore_indices,
+            :timeout,
+            :master_timeout,
             :ignore_unavailable,
             :allow_no_indices,
-            :expand_wildcards,
-            :timeout ].freeze)
+            :expand_wildcards ].freeze)
       end
     end
   end