elasticsearch-api 6.8.0 → 7.10.0

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

@@ -1,18 +1,29 @@
+# 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 Actions
-
-      # Return true if the specified document exists, false otherwise.
-      #
-      # @example
-      #
-      #     client.exists? index: 'myindex', type: 'mytype', id: '1'
+      # Returns information about whether a document exists in an index.
       #
-      # @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] :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
@@ -22,44 +33,60 @@ module Elasticsearch
       # @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 [Hash] :headers Custom HTTP headers
+      #
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      # @see http://elasticsearch.org/guide/reference/api/get/
       #
-      def exists(arguments={})
-        raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-get.html
+      #
+      def exists(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        arguments[:type] ||= UNDERSCORE_ALL
-        method = HTTP_HEAD
-        path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                 Utils.__escape(arguments[:type]),
-                                 Utils.__escape(arguments[:id])
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+        headers = arguments.delete(:headers) || {}
 
+        arguments = arguments.clone
+
+        _id = arguments.delete(:id)
+
+        _index = arguments.delete(:index)
+
+        _type = arguments.delete(:type)
+
+        method = Elasticsearch::API::HTTP_HEAD
+        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
+
+        body = nil
 
         Utils.__rescue_from_not_found do
-          perform_request(method, path, params, body).status == 200 ? true : false
+          perform_request(method, path, params, body, headers).status == 200 ? true : false
         end
       end
-      alias_method :exists?, :exists
-
 
+      alias_method :exists?, :exists
       # Register this action with its valid params when the module is loaded.
       #
       # @since 6.2.0
       ParamsRegistry.register(:exists, [
-          :stored_fields,
-          :parent,
-          :preference,
-          :realtime,
-          :refresh,
-          :routing,
-          :_source,
-          :_source_excludes,
-          :_source_includes,
-          :version,
-          :version_type ].freeze)
+        :stored_fields,
+        :preference,
+        :realtime,
+        :refresh,
+        :routing,
+        :_source,
+        :_source_excludes,
+        :_source_includes,
+        :version,
+        :version_type
+      ].freeze)
     end
   end
 end

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

@@ -1,13 +1,28 @@
+# 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 Actions
-
-      # The get API allows to get a typed JSON document from the index based on its id.
+      # Returns information about whether a document source exists in an index.
       #
-      # @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] :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
@@ -17,35 +32,56 @@ module Elasticsearch
       # @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 [Hash] :headers Custom HTTP headers
       #
-      # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      def exists_source(arguments={})
-        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-get.html
+      #
+      def exists_source(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        raise ArgumentError, "Required argument 'type' missing" unless arguments[:type]
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _id = arguments.delete(:id)
+
+        _index = arguments.delete(:index)
+
+        _type = arguments.delete(: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
+        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__)
 
-        perform_request(method, path, params, body).body
+        body = nil
+        perform_request(method, path, params, body, headers).body
       end
 
+      alias_method :exists_source?, :exists_source
       # 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)
+        :preference,
+        :realtime,
+        :refresh,
+        :routing,
+        :_source,
+        :_source_excludes,
+        :_source_includes,
+        :version,
+        :version_type
+      ].freeze)
     end
   end
 end

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

@@ -1,74 +1,98 @@
+# 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 Actions
-
-      # Return information if and how well a document matches a query.
-      #
-      # The returned information contains a `_score` and its explanation, if the document matches the query.
-      #
-      # @example Passing the query in the Lucene query syntax as the `:q` URL parameter
-      #
-      #     client.explain index: 'myindex', type: 'mytype', id: '1', q: 'test'
+      # Returns information about why a specific matches (or doesn't match) a query.
       #
-      # @example Passing the query in the Query DSL as the request `:body`
-      #
-      #     client.explain index: 'myindex', type: 'mytype', id: '1',
-      #                    body: { query: { match: { title: 'test' } } }
-      #
-      # @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
+      # @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*
       # @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] :df The default field for query string query (default: _all)
       # @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] :q Query in the Lucene query string syntax
       # @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
-      # @see http://elasticsearch.org/guide/reference/api/explain/
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The query definition using the Query DSL
+      #
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      def explain(arguments={})
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/search-explain.html
+      #
+      def explain(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
-        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]),
-                                 '_explain'
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _id = arguments.delete(:id)
 
-        params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
+        _index = arguments.delete(:index)
+
+        _type = arguments.delete(:type)
+
+        method = if arguments[:body]
+                   Elasticsearch::API::HTTP_POST
+                 else
+                   Elasticsearch::API::HTTP_GET
+                 end
+
+        path = if _index && _type && _id
+                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/_explain"
+               else
+                 "#{Utils.__listify(_index)}/_explain/#{Utils.__listify(_id)}"
+               end
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
-        perform_request(method, path, params, body).body
+        body = arguments[:body]
+        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(:explain, [
-          :analyze_wildcard,
-          :analyzer,
-          :default_operator,
-          :df,
-          :stored_fields,
-          :lenient,
-          :parent,
-          :preference,
-          :q,
-          :routing,
-          :_source,
-          :_source_excludes,
-          :_source_includes ].freeze)
+        :analyze_wildcard,
+        :analyzer,
+        :default_operator,
+        :df,
+        :stored_fields,
+        :lenient,
+        :preference,
+        :q,
+        :routing,
+        :_source,
+        :_source_excludes,
+        :_source_includes
+      ].freeze)
     end
   end
 end

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

@@ -1,40 +1,70 @@
+# 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 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 [Hash] :body Field json objects containing an array of field names
       # @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, hidden, none, all)
+      # @option arguments [Boolean] :include_unmapped Indicates whether unmapped fields should be included in the response.
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body An index filter specified with the Query DSL
       #
-      # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/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 = {})
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        method = if arguments[:body]
+                   Elasticsearch::API::HTTP_POST
+                 else
+                   Elasticsearch::API::HTTP_GET
+                 end
+
+        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]
 
-        perform_request(method, path, params, body).body
+        body = arguments[:body]
+        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(:field_caps, [
-          :fields,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards ].freeze)
+        :fields,
+        :ignore_unavailable,
+        :allow_no_indices,
+        :expand_wildcards,
+        :include_unmapped
+      ].freeze)
     end
   end
 end

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

@@ -1,20 +1,29 @@
+# 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 Actions
-
-      # Return a specified document.
-      #
-      # The response contains full document, as stored in Elasticsearch, incl. `_source`, `_version`, etc.
-      #
-      # @example Get a document
+      # Returns a document.
       #
-      #     client.get 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 (use `_all` to fetch the first document matching the ID across all types) (*Required*)
+      # @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
@@ -22,31 +31,44 @@ 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 [Hash] :headers Custom HTTP headers
+      #
+      # *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.10/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] ||= UNDERSCORE_ALL
-        method = HTTP_GET
-        path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                 Utils.__escape(arguments[:type]),
-                                 Utils.__escape(arguments[:id])
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = nil
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _id = arguments.delete(:id)
 
-        params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
+        _index = arguments.delete(:index)
+
+        _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 }
+          Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
         else
-          perform_request(method, path, params, body).body
+          perform_request(method, path, params, body, headers).body
         end
       end
 
@@ -54,19 +76,17 @@ module Elasticsearch
       #
       # @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