elasticsearch-api 6.8.3 → 7.0.0.pre

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

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -13,13 +26,12 @@ module Elasticsearch
       #     # => { "fields" => "t"=>{"text"=>{"type"=>"text", "searchable"=>true, "aggregatable"=>false}} ...
       #
       # @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)
       #
-      # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html
+      # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html
       #
       def field_caps(arguments={})
         raise ArgumentError, "Required argument 'fields' missing" unless arguments[:fields]
@@ -33,7 +45,7 @@ module Elasticsearch
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.2.0
+      # @since 6.1.1
       ParamsRegistry.register(:field_caps, [
           :fields,
           :ignore_unavailable,

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

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -16,7 +29,7 @@ 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 (use `_all` to fetch the first document matching the ID across all types) (*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 [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)
@@ -36,7 +49,8 @@ module Elasticsearch
       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
+        arguments[:type] ||= DEFAULT_DOC
+
         method = HTTP_GET
         path   = Utils.__pathify Utils.__escape(arguments[:index]),
                                  Utils.__escape(arguments[:type]),
@@ -56,7 +70,7 @@ module Elasticsearch
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.2.0
+      # @since 6.1.1
       ParamsRegistry.register(:get, [
           :stored_fields,
           :parent,

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

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -9,15 +22,15 @@ module Elasticsearch
       # Retrieve an indexed script from Elasticsearch
       #
       # @option arguments [String] :id Script ID (*Required*)
-      # @option arguments [Time] :master_timeout Specify timeout for connection to master
+      # @option arguments [String] :lang Script language
       #
-      # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html#_indexed_scripts
       #
       def get_script(arguments={})
         raise ArgumentError, "Required argument 'id' missing"   unless arguments[:id]
-        method = HTTP_GET
-        path   = "_scripts/#{arguments.has_key?(:lang) ? "#{arguments.delete(:lang)}/" : ''}#{arguments[:id]}"
-        params = {}
+        method = Elasticsearch::API::HTTP_GET
+        path   = "_scripts/#{arguments[:id]}"
+        params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
         body   = nil
 
         perform_request(method, path, params, body).body
@@ -26,7 +39,7 @@ module Elasticsearch
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.2.0
+      # @since 6.1.1
       ParamsRegistry.register(:get_script, [
           :master_timeout ].freeze)
     end

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

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -16,7 +29,7 @@ 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; use `_all` to fetch the first document matching the ID across all types (*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] :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
@@ -35,12 +48,21 @@ module Elasticsearch
       def get_source(arguments={})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
-        arguments[:type] ||= UNDERSCORE_ALL
+        arguments[:type] ||= DEFAULT_DOC
+
         method = HTTP_GET
-        path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                 Utils.__escape(arguments[:type]),
-                                 Utils.__escape(arguments[:id]),
-                                 '_source'
+
+        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
+
 
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
         body   = nil
@@ -54,7 +76,7 @@ module Elasticsearch
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.2.0
+      # @since 6.1.1
       ParamsRegistry.register(:get_source, [
           :parent,
           :preference,

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

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -44,7 +57,7 @@ module Elasticsearch
       #     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: { mytype: { _ttl: { enabled: true } }  } }
+      #     client.indices.create index: 'myindex', body: { mappings: { properties: { _ttl: { enabled: true } }  } }
       #
       #     client.index index: 'myindex', type: 'mytype', id: '1', body: { title: 'TEST' }, ttl: '5s'
       #
@@ -54,27 +67,30 @@ 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
+      # @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 (*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 [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] :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] :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 [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
       #
       def index(arguments={})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
+        arguments[:type] ||= DEFAULT_DOC
         method = arguments[:id] ? HTTP_PUT : HTTP_POST
         path   = Utils.__pathify Utils.__escape(arguments[:index]),
                                  Utils.__escape(arguments[:type]),
@@ -82,25 +98,29 @@ module Elasticsearch
 
         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.2.0
+      # @since 6.1.1
       ParamsRegistry.register(:index, [
-          :wait_for_active_shards,
+          :consistency,
+          :include_type_name,
           :op_type,
           :parent,
+          :percolate,
+          :pipeline,
           :refresh,
+          :replication,
           :routing,
           :timeout,
+          :timestamp,
+          :ttl,
           :version,
           :version_type,
           :if_seq_no,
-          :if_primary_term,
-          :pipeline ].freeze)
+          :if_primary_term ].freeze)
     end
   end
 end

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

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -32,7 +45,21 @@ module Elasticsearch
         #                                char_filter: ['html_strip'] }
         #
         # @option arguments [String] :index The name of the index to scope the operation
-        # @option arguments [Hash] :body Define analyzer/tokenizer parameters and the text on which the analysis should be performed
+        # @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
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-analyze/
         #
@@ -48,10 +75,9 @@ 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
+        # @since 6.1.1
         ParamsRegistry.register(:analyze, [
             :index ].freeze)
       end

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

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -27,14 +40,15 @@ 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. This is deprecated. Prefer `fielddata`.
+        # @option arguments [Boolean] :field_data Clear field data
         # @option arguments [Boolean] :fielddata Clear field data
-        # @option arguments [List] :fields A comma-separated list of fields to clear when using the `fielddata` parameter (default: all)
+        # @option arguments [List] :fields A comma-separated list of fields to clear when using the `field_data` 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
         #
@@ -54,9 +68,8 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.2.0
+        # @since 6.1.1
         ParamsRegistry.register(:clear_cache, [
-            :field_data,
             :fielddata,
             :fields,
             :query,
@@ -64,7 +77,6 @@ module Elasticsearch
             :allow_no_indices,
             :expand_wildcards,
             :index,
-            :request_cache,
             :request ].freeze)
       end
     end

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

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -15,14 +28,20 @@ module Elasticsearch
         #
         #     client.indices.close index: 'myindex'
         #
-        # @option arguments [List] :index A comma separated list of indices to close (*Required*)
+        # @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 [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.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/
         #
         def close(arguments={})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -37,13 +56,14 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.2.0
+        # @since 6.1.1
         ParamsRegistry.register(:close, [
             :timeout,
             :master_timeout,
             :ignore_unavailable,
             :allow_no_indices,
-            :expand_wildcards ].freeze)
+            :expand_wildcards,
+            :wait_for_active_shards ].freeze)
       end
     end
   end