elasticsearch-api 6.8.3 → 7.0.0.pre

data/lib/elasticsearch/api/actions/indices/shard_stores.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,7 +28,7 @@ module Elasticsearch
         # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
         # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-shards-stores.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html
         #
         def shard_stores(arguments={})
           method = 'GET'
@@ -28,7 +41,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(:shard_stores, [
             :status,
             :ignore_unavailable,

data/lib/elasticsearch/api/actions/indices/shrink.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
@@ -12,12 +25,11 @@ module Elasticsearch
         # @option arguments [String] :index The name of the source index to shrink (*Required*)
         # @option arguments [String] :target The name of the target index to shrink into (*Required*)
         # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
-        # @option arguments [Boolean] :copy_settings whether or not to copy settings from the source index (defaults to false)
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the shrunken index before the operation returns.
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-shrink-index.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html
         #
         def shrink(arguments={})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -36,9 +48,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(:shrink, [
-            :copy_settings,
             :timeout,
             :master_timeout,
             :wait_for_active_shards ].freeze)

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

@@ -1,24 +1,35 @@
-# 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
     module Indices
       module Actions
 
-        # The split index API allows you to split an existing index into a new index,
-        # where each original primary shard is split into two or more primary shards in the new index.
+        # The split index API allows you to split an existing index into a new index with multiple of its primary shards.
         #
         # @option arguments [String] :index The name of the source index to split (*Required*)
         # @option arguments [String] :target The name of the target index to split into (*Required*)
         # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
-        # @option arguments [Boolean] :copy_settings whether or not to copy settings from the source index (defaults to false)
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the shrunken index before the operation returns.
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-split-index.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html
         #
         def split(arguments={})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -37,9 +48,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(:split, [
-            :copy_settings,
             :timeout,
             :master_timeout,
             :wait_for_active_shards ].freeze)

data/lib/elasticsearch/api/actions/indices/stats.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
@@ -95,7 +108,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(:stats_params, [
             :fields,
             :completion_fields,
@@ -111,7 +124,7 @@ module Elasticsearch
 
         # Register this action with its valid parts when the module is loaded.
         #
-        # @since 6.2.0
+        # @since 6.1.1
         ParamsRegistry.register(:stats_parts, [
             :docs,
             :fielddata,

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

@@ -1,7 +1,3 @@
-# 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
-
 module Elasticsearch
   module API
     module Indices

data/lib/elasticsearch/api/actions/indices/update_aliases.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
@@ -33,7 +46,7 @@ module Elasticsearch
         # @option arguments [Time] :timeout Request timeout
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
         #
         def update_aliases(arguments={})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -48,7 +61,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(:update_aliases, [
             :timeout,
             :master_timeout ].freeze)

data/lib/elasticsearch/api/actions/indices/upgrade.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 [Boolean] :wait_for_completion Specify whether the request should block until the all segments are upgraded (default: false)
         # @option arguments [Boolean] :only_ancient_segments If true, only ancient (an older Lucene major release) segments will be upgraded
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-upgrade.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-upgrade.html
         #
         def upgrade(arguments={})
           method = HTTP_POST
@@ -29,7 +42,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(:upgrade, [
             :allow_no_indices,
             :expand_wildcards,

data/lib/elasticsearch/api/actions/indices/validate_query.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
@@ -57,7 +70,7 @@ module Elasticsearch
         # @option arguments [Boolean] :rewrite Provide a more detailed explanation showing the actual Lucene query that will be executed.
         # @option arguments [Boolean] :all_shards Execute validation on all shards instead of one random shard per index
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/search-validate.html
+        # @see http://www.elasticsearch.org/guide/reference/api/validate/
         #
         def validate_query(arguments={})
           method = HTTP_GET
@@ -73,7 +86,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(:validate_query, [
             :explain,
             :ignore_unavailable,

data/lib/elasticsearch/api/actions/info.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
@@ -18,12 +31,6 @@ 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(:info, [
-      ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/ingest/delete_pipeline.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,7 +26,7 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html
         #
         def delete_pipeline(arguments={})
           raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
@@ -27,7 +40,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(:delete_pipeline, [
             :master_timeout,
             :timeout ].freeze)

data/lib/elasticsearch/api/actions/ingest/get_pipeline.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,10 +22,10 @@ module Elasticsearch
 
         # Return a specified pipeline
         #
-        # @option arguments [String] :id Comma separated list of pipeline ids. Wildcards supported
+        # @option arguments [String] :id Comma separated list of pipeline ids (wildcards supported).
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html
         #
         def get_pipeline(arguments={})
           method = 'GET'
@@ -25,9 +38,8 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.2.0
-        ParamsRegistry.register(:get_pipeline, [
-            :master_timeout ].freeze)
+        # @since 6.1.1
+        ParamsRegistry.register(:get_pipeline, [ :master_timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/ingest/params_registry.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
@@ -12,7 +25,7 @@ module Elasticsearch
 
           # A Mapping of all the actions to their list of valid params.
           #
-          # @since 6.2.0
+          # @since 6.1.1
           PARAMS = {}
 
           # Register an action with its list of valid params.
@@ -23,7 +36,7 @@ module Elasticsearch
           # @param [ Symbol ] action The action to register.
           # @param [ Array[Symbol] ] valid_params The list of valid params.
           #
-          # @since 6.2.0
+          # @since 6.1.1
           def register(action, valid_params)
             PARAMS[action.to_sym] = valid_params
           end
@@ -37,7 +50,7 @@ module Elasticsearch
           #
           # @return [ Array<Symbol> ] The list of valid params for the action.
           #
-          # @since 6.2.0
+          # @since 6.1.1
           def get(action)
             PARAMS.fetch(action, [])
           end