elasticsearch-api 7.3.0 → 7.5.0

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

@@ -5,40 +5,47 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Return the capabilities of fields among multiple indices
-      #
-      # @example
-      #     client.field_caps fields: '*'
-      #     # => { "fields" => "t"=>{"text"=>{"type"=>"text", "searchable"=>true, "aggregatable"=>false}} ...
+      # Returns the information about the capabilities of fields among multiple indices.
       #
       # @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 [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)
+      # @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 [Boolean] :include_unmapped Indicates whether unmapped fields should be included in the response.
+
       #
-      # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/search-field-caps.html
       #
-      def field_caps(arguments={})
-        raise ArgumentError, "Required argument 'fields' missing" unless arguments[:fields]
-        method = HTTP_GET
-        path   = Utils.__pathify Utils.__listify(arguments[:index]), '_field_caps'
+      def field_caps(arguments = {})
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        method = Elasticsearch::API::HTTP_GET
+        path   = if _index
+                   "#{Utils.__listify(_index)}/_field_caps"
+                 else
+                   "_field_caps"
+end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
 
+        body = nil
         perform_request(method, path, params, body).body
       end
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.1.1
+      # @since 6.2.0
       ParamsRegistry.register(:field_caps, [
-          :fields,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :include_unmapped ].freeze)
+        :fields,
+        :ignore_unavailable,
+        :allow_no_indices,
+        :expand_wildcards,
+        :include_unmapped
+      ].freeze)
+    end
     end
-  end
 end

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

@@ -5,20 +5,12 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Return a specified document.
-      #
-      # The response contains full document, as stored in Elasticsearch, incl. `_source`, `_version`, etc.
-      #
-      # @example Get a document
-      #
-      #     client.get index: 'myindex', type: 'mytype', id: '1'
+      # Returns a document.
       #
-      # @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)
+      # @option arguments [String] :id The document ID
+      # @option arguments [String] :index The name of the index
+      # @option arguments [String] :type The type of the document (use `_all` to fetch the first document matching the ID across all types)   *Deprecated*
       # @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 [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
@@ -26,28 +18,39 @@ module Elasticsearch
       # @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] :version_type Specific version type
+      #   (options: internal,external,external_gte,force)
+
+      #
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
+      #
       #
-      # @see http://elasticsearch.org/guide/reference/api/get/
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-get.html
       #
-      def get(arguments={})
+      def get(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
-        arguments[:type] ||= DEFAULT_DOC
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
-        method = HTTP_GET
-        path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                 Utils.__escape(arguments[:type]),
-                                 Utils.__escape(arguments[:id])
+        arguments = arguments.clone
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = nil
+        _id = arguments.delete(:id)
+
+        _index = arguments.delete(:index)
 
-        params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
+        _type = arguments.delete(:type)
 
+        method = Elasticsearch::API::HTTP_GET
+        path   = if _index && _type && _id
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}"
+                 else
+                   "#{Utils.__listify(_index)}/_doc/#{Utils.__listify(_id)}"
+  end
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+        body = nil
         if Array(arguments[:ignore]).include?(404)
           Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
         else
@@ -57,21 +60,19 @@ module Elasticsearch
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.1.1
+      # @since 6.2.0
       ParamsRegistry.register(:get, [
-          :stored_fields,
-          :parent,
-          :preference,
-          :realtime,
-          :refresh,
-          :routing,
-          :_source,
-          :_source_excludes,
-          :_source_includes,
-          :_source_exclude,
-          :_source_include,
-          :version,
-          :version_type ].freeze)
+        :stored_fields,
+        :preference,
+        :realtime,
+        :refresh,
+        :routing,
+        :_source,
+        :_source_excludes,
+        :_source_includes,
+        :version,
+        :version_type
+      ].freeze)
+    end
     end
-  end
 end

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

@@ -5,30 +5,35 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Retrieve an indexed script from Elasticsearch
+      # Returns a script.
       #
-      # @option arguments [String] :id Script ID (*Required*)
-      # @option arguments [String] :lang Script language
+      # @option arguments [String] :id Script ID
+      # @option arguments [Time] :master_timeout Specify timeout for connection to master
+
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html#_indexed_scripts
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/modules-scripting.html
       #
-      def get_script(arguments={})
-        raise ArgumentError, "Required argument 'id' missing"   unless arguments[:id]
+      def get_script(arguments = {})
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+        arguments = arguments.clone
+
+        _id = arguments.delete(:id)
+
         method = Elasticsearch::API::HTTP_GET
-        path   = "_scripts/#{arguments[:id]}"
-        params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = nil
+        path   = "_scripts/#{Utils.__listify(_id)}"
+        params = 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.1.1
+      # @since 6.2.0
       ParamsRegistry.register(:get_script, [
-          :master_timeout ].freeze)
+        :master_timeout
+      ].freeze)
+    end
     end
-  end
 end

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

@@ -5,19 +5,11 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Return a specified document's `_source`.
-      #
-      # The response contains just the original document, as passed to Elasticsearch during indexing.
-      #
-      # @example Get a document `_source`
+      # Returns the source of a document.
       #
-      #     client.get_source index: 'myindex', type: 'mytype', id: '1'
-      #
-      # @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; deprecated and optional starting with 7.0
-      # @option arguments [String] :parent The ID of the parent document
+      # @option arguments [String] :id The document ID
+      # @option arguments [String] :index The name of the index
+      # @option arguments [String] :type The type of the document; deprecated and optional starting with 7.0   *Deprecated*
       # @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
@@ -26,53 +18,55 @@ module Elasticsearch
       # @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)
+      # @option arguments [String] :version_type Specific version type
+      #   (options: internal,external,external_gte,force)
+
+      #
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      # @see http://elasticsearch.org/guide/reference/api/get/
       #
-      # @since 0.90.1
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-get.html
       #
-      def get_source(arguments={})
+      def get_source(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
-        arguments[:type] ||= DEFAULT_DOC
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
-        method = HTTP_GET
+        arguments = arguments.clone
 
-        if arguments[:type]
-          path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                   Utils.__escape(arguments[:type]),
-                                   Utils.__escape(arguments[:id]),
-                                   '_source'
-        else
-          path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                   '_source',
-                                   Utils.__escape(arguments[:id])
-        end
+        _id = arguments.delete(:id)
 
+        _index = arguments.delete(:index)
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = nil
+        _type = arguments.delete(:type)
 
-        params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
+        method = Elasticsearch::API::HTTP_GET
+        path   = if _index && _type && _id
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/_source"
+                 else
+                   "#{Utils.__listify(_index)}/_source/#{Utils.__listify(_id)}"
+  end
+        params = 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.1.1
+      # @since 6.2.0
       ParamsRegistry.register(:get_source, [
-          :parent,
-          :preference,
-          :realtime,
-          :refresh,
-          :routing,
-          :_source,
-          :_source_excludes,
-          :_source_includes,
-          :version,
-          :version_type ].freeze)
+        :preference,
+        :realtime,
+        :refresh,
+        :routing,
+        :_source,
+        :_source_excludes,
+        :_source_includes,
+        :version,
+        :version_type
+      ].freeze)
+    end
     end
-  end
 end

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

@@ -5,109 +5,80 @@
 module Elasticsearch
   module API
     module Actions
+      # Creates or updates a document in an index.
+      #
+      # @option arguments [String] :id Document ID
+      # @option arguments [String] :index The name of the index
+      # @option arguments [String] :type The type of the document   *Deprecated*
+      # @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. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID
+      #   (options: index,create)
+
+      # @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)
 
-      # Create or update a document.
-      #
-      # The `index` API will either _create_ a new document, or _update_ an existing one, when a document `:id`
-      # is passed. When creating a document, an ID will be auto-generated, when it's not passed as an argument.
-      #
-      # You can specifically enforce the _create_ operation by setting the `op_type` argument to `create`, or
-      # by using the {Actions#create} method.
-      #
-      # Optimistic concurrency control is performed, when the `version` argument is specified. By default,
-      # no version checks are performed.
-      #
-      # By default, the document will be available for {Actions#get} immediately, for {Actions#search} only
-      # after an index refresh operation has been performed (either automatically or manually).
-      #
-      # @example Create or update a document `myindex/mytype/1`
-      #
-      #     client.index index: 'myindex',
-      #                  type: 'mytype',
-      #                  id: '1',
-      #                  body: {
-      #                   title: 'Test 1',
-      #                   tags: ['y', 'z'],
-      #                   published: true,
-      #                   published_at: Time.now.utc.iso8601,
-      #                   counter: 1
-      #                 }
-      #
-      # @example Refresh the index after the operation (useful e.g. in integration tests)
-      #
-      #     client.index index: 'myindex', type: 'mytype', id: '1', body: { title: 'TEST' }, refresh: true
-      #     client.search index: 'myindex', q: 'title:test'
-      #
-      # @example Create a document with a specific expiration time (TTL)
-      #
-      #     # Decrease the default housekeeping interval first:
-      #     client.cluster.put_settings body: { transient: { 'indices.ttl.interval' => '1s' } }
-      #
-      #     # Enable the `_ttl` property for all types within the index
-      #     client.indices.create index: 'myindex', body: { mappings: { properties: { _ttl: { enabled: true } }  } }
-      #
-      #     client.index index: 'myindex', type: 'mytype', id: '1', body: { title: 'TEST' }, ttl: '5s'
-      #
-      #     sleep 3 and client.get index: 'myindex', type: 'mytype', id: '1'
-      #     # => {"_index"=>"myindex" ... "_source"=>{"title"=>"TEST"}}
-      #
-      #     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] :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 [Boolean] :include_type_name Whether a type should be expected in the body of the mappings.
-      # @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] :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 [String] :version_type Specific version type
+      #   (options: internal,external,external_gte)
+
+      # @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
+
+      # @option arguments [Hash] :body The document (*Required*)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      def index(arguments={})
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-index_.html
+      #
+      def index(arguments = {})
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        arguments[:type] ||= DEFAULT_DOC
-        method = arguments[:id] ? HTTP_PUT : HTTP_POST
-        path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                 Utils.__escape(arguments[:type]),
-                                 Utils.__escape(arguments[:id])
 
+        arguments = arguments.clone
+
+        _id = arguments.delete(:id)
+
+        _index = arguments.delete(:index)
+
+        _type = arguments.delete(:type)
+
+        method = _id ? Elasticsearch::API::HTTP_PUT : Elasticsearch::API::HTTP_POST
+        path   = if _index && _type && _id
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}"
+                 elsif _index && _id
+                   "#{Utils.__listify(_index)}/_doc/#{Utils.__listify(_id)}"
+                 elsif _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}"
+                 else
+                   "#{Utils.__listify(_index)}/_doc"
+  end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
+
+        body = arguments[:body]
         perform_request(method, path, params, body).body
       end
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.1.1
+      # @since 6.2.0
       ParamsRegistry.register(:index, [
-          :consistency,
-          :include_type_name,
-          :op_type,
-          :parent,
-          :percolate,
-          :pipeline,
-          :refresh,
-          :replication,
-          :routing,
-          :timeout,
-          :timestamp,
-          :ttl,
-          :version,
-          :version_type,
-          :if_seq_no,
-          :if_primary_term ].freeze)
+        :wait_for_active_shards,
+        :op_type,
+        :refresh,
+        :routing,
+        :timeout,
+        :version,
+        :version_type,
+        :if_seq_no,
+        :if_primary_term,
+        :pipeline
+      ].freeze)
+    end
     end
-  end
 end

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

@@ -6,68 +6,39 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Return the result of the analysis process (tokens)
-        #
-        # Allows to "test-drive" the Elasticsearch analysis process by performing the analysis on the
-        # same text with different analyzers. An ad-hoc analysis chain can be built from specific
-        # _tokenizer_ and _filters_.
-        #
-        # @example Analyze text "Quick Brown Jumping Fox" with the _snowball_ analyzer
-        #
-        #     client.indices.analyze text: 'The Quick Brown Jumping Fox', analyzer: 'snowball'
-        #
-        # @example Analyze text "Quick Brown Jumping Fox" with a custom tokenizer and filter chain
-        #
-        #     client.indices.analyze body: { text: 'The Quick Brown Jumping Fox',
-        #                                    tokenizer: 'whitespace',
-        #                                    filter: ['lowercase','stop'] }
-        #
-        # @note If your text for analysis is longer than 4096 bytes then you should use the :body argument, rather than :text, to avoid HTTP transport errors
-        #
-        # @example Analyze text "Quick <b>Brown</b> Jumping Fox" with custom tokenizer, token and character filters
-        #
-        # client.indices.analyze body: { text: 'The Quick <b>Brown</b> Jumping Fox',
-        #                                tokenizer: 'standard',
-        #                                char_filter: ['html_strip'] }
+        # Performs the analysis process on a text and return the tokens breakdown of the text.
         #
         # @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 https://www.elastic.co/guide/reference/api/admin-indices-analyze/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-analyze.html
         #
-        def analyze(arguments={})
-          method = HTTP_GET
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_analyze'
+        def analyze(arguments = {})
+          arguments = arguments.clone
 
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          params[:filters] = Utils.__listify(params[:filters]) if params[:filters]
+          _index = arguments.delete(:index)
 
-          body   = arguments[:body]
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_analyze"
+                   else
+                     "_analyze"
+end
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
+          body = arguments[:body]
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:analyze, [
-            :index ].freeze)
+          :index
+        ].freeze)
+end
       end
-    end
   end
 end