From 7aa6f18b945fb7ad20d1a68b51902fe05ef47e9d Mon Sep 17 00:00:00 2001 From: Fernando Briano Date: Tue, 14 Oct 2025 10:17:35 +0100 Subject: [PATCH 1/4] Revert "[API] Adds streams namespace and endpoints" This reverts commit d0b99dadf53f6b83722d869bc0083e6dc78fe184. --- elasticsearch-api/lib/elasticsearch/api.rb | 3 +- .../api/actions/streams/logs_disable.rb | 52 ------------------- .../api/actions/streams/logs_enable.rb | 52 ------------------- .../api/actions/streams/status.rb | 50 ------------------ .../elasticsearch/api/namespace/streams.rb | 36 ------------- .../api/actions/streams/logs_disable_spec.rb | 35 ------------- .../api/actions/streams/logs_enable_spec.rb | 35 ------------- .../api/actions/streams/status_spec.rb | 35 ------------- 8 files changed, 1 insertion(+), 297 deletions(-) delete mode 100644 elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_disable.rb delete mode 100644 elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_enable.rb delete mode 100644 elasticsearch-api/lib/elasticsearch/api/actions/streams/status.rb delete mode 100644 elasticsearch-api/lib/elasticsearch/api/namespace/streams.rb delete mode 100644 elasticsearch-api/spec/elasticsearch/api/actions/streams/logs_disable_spec.rb delete mode 100644 elasticsearch-api/spec/elasticsearch/api/actions/streams/logs_enable_spec.rb delete mode 100644 elasticsearch-api/spec/elasticsearch/api/actions/streams/status_spec.rb diff --git a/elasticsearch-api/lib/elasticsearch/api.rb b/elasticsearch-api/lib/elasticsearch/api.rb index 2b8c298722..a20a31a23b 100644 --- a/elasticsearch-api/lib/elasticsearch/api.rb +++ b/elasticsearch-api/lib/elasticsearch/api.rb @@ -87,8 +87,7 @@ def self.included(base) Elasticsearch::API::Profiling, Elasticsearch::API::Simulate, Elasticsearch::API::Connector, - Elasticsearch::API::QueryRules, - Elasticsearch::API::Streams + Elasticsearch::API::QueryRules end # The serializer class diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_disable.rb b/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_disable.rb deleted file mode 100644 index c187e2212b..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_disable.rb +++ /dev/null @@ -1,52 +0,0 @@ -# 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. -# -# Auto generated from build hash Unavailable -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# -module Elasticsearch - module API - module Streams - module Actions - # Disable the Logs Streams feature for this cluster - # - # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. - # @option arguments [Hash] :headers Custom HTTP headers - # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/streams-logs-disable.html - # - def logs_disable(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'streams.logs_disable' } - - arguments = arguments.clone - headers = arguments.delete(:headers) || {} - - body = nil - - method = Elasticsearch::API::HTTP_POST - path = '_streams/logs/_disable' - params = Utils.process_params(arguments) - - Elasticsearch::API::Response.new( - perform_request(method, path, params, body, headers, request_opts) - ) - end - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_enable.rb b/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_enable.rb deleted file mode 100644 index d560f85d19..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_enable.rb +++ /dev/null @@ -1,52 +0,0 @@ -# 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. -# -# Auto generated from build hash Unavailable -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# -module Elasticsearch - module API - module Streams - module Actions - # Enable the Logs Streams feature for this cluster - # - # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. - # @option arguments [Hash] :headers Custom HTTP headers - # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/streams-logs-enable.html - # - def logs_enable(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'streams.logs_enable' } - - arguments = arguments.clone - headers = arguments.delete(:headers) || {} - - body = nil - - method = Elasticsearch::API::HTTP_POST - path = '_streams/logs/_enable' - params = Utils.process_params(arguments) - - Elasticsearch::API::Response.new( - perform_request(method, path, params, body, headers, request_opts) - ) - end - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/streams/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/streams/status.rb deleted file mode 100644 index 9e9ca9c13c..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/actions/streams/status.rb +++ /dev/null @@ -1,50 +0,0 @@ -# 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. -# -# Auto generated from build hash Unavailable -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# -module Elasticsearch - module API - module Streams - module Actions - # Return the current status of the streams feature for each streams type - # - # @option arguments [Hash] :headers Custom HTTP headers - # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/streams-status.html - # - def status(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'streams.status' } - - arguments = arguments.clone - headers = arguments.delete(:headers) || {} - - body = nil - - method = Elasticsearch::API::HTTP_GET - path = '_streams/status' - params = {} - - Elasticsearch::API::Response.new( - perform_request(method, path, params, body, headers, request_opts) - ) - end - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/streams.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/streams.rb deleted file mode 100644 index 7d7f892d56..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/streams.rb +++ /dev/null @@ -1,36 +0,0 @@ -# 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 Streams - module Actions; end - - # Client for the "streams" namespace (includes the {Streams::Actions} methods) - # - class StreamsClient - include Common::Client, Common::Client::Base, Streams::Actions - end - - # Proxy method for {StreamsClient}, available in the receiving object - # - def streams - @streams ||= StreamsClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/streams/logs_disable_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/streams/logs_disable_spec.rb deleted file mode 100644 index c802267b5f..0000000000 --- a/elasticsearch-api/spec/elasticsearch/api/actions/streams/logs_disable_spec.rb +++ /dev/null @@ -1,35 +0,0 @@ -# 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. - -require 'spec_helper' - -describe 'client.streams#logs_disable' do - let(:expected_args) do - [ - 'POST', - '_streams/logs/_disable', - {}, - nil, - {}, - { endpoint: 'streams.logs_disable' } - ] - end - - it 'performs the request' do - expect(client_double.streams.logs_disable).to be_a Elasticsearch::API::Response - end -end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/streams/logs_enable_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/streams/logs_enable_spec.rb deleted file mode 100644 index ad4aa3f5aa..0000000000 --- a/elasticsearch-api/spec/elasticsearch/api/actions/streams/logs_enable_spec.rb +++ /dev/null @@ -1,35 +0,0 @@ -# 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. - -require 'spec_helper' - -describe 'client.streams#logs_enable' do - let(:expected_args) do - [ - 'POST', - '_streams/logs/_enable', - {}, - nil, - {}, - { endpoint: 'streams.logs_enable' } - ] - end - - it 'performs the request' do - expect(client_double.streams.logs_enable).to be_a Elasticsearch::API::Response - end -end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/streams/status_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/streams/status_spec.rb deleted file mode 100644 index def22a386c..0000000000 --- a/elasticsearch-api/spec/elasticsearch/api/actions/streams/status_spec.rb +++ /dev/null @@ -1,35 +0,0 @@ -# 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. - -require 'spec_helper' - -describe 'client.streams#status' do - let(:expected_args) do - [ - 'GET', - '_streams/status', - {}, - nil, - {}, - { endpoint: 'streams.status' } - ] - end - - it 'performs the request' do - expect(client_double.streams.status).to be_a Elasticsearch::API::Response - end -end From 704b80397d902e87ec987ea4632ef1aaffcf9bcf Mon Sep 17 00:00:00 2001 From: Fernando Briano Date: Tue, 14 Oct 2025 10:40:52 +0100 Subject: [PATCH 2/4] [API] Updates generated code --- .../api/actions/async_search/delete.rb | 2 +- .../api/actions/async_search/get.rb | 2 +- .../api/actions/async_search/status.rb | 2 +- .../api/actions/async_search/submit.rb | 2 +- .../autoscaling/delete_autoscaling_policy.rb | 2 +- .../autoscaling/get_autoscaling_capacity.rb | 2 +- .../autoscaling/get_autoscaling_policy.rb | 4 +- .../autoscaling/put_autoscaling_policy.rb | 2 +- .../lib/elasticsearch/api/actions/bulk.rb | 2 +- .../elasticsearch/api/actions/cat/aliases.rb | 4 +- .../api/actions/cat/allocation.rb | 5 +- .../api/actions/cat/component_templates.rb | 4 +- .../elasticsearch/api/actions/cat/count.rb | 4 +- .../api/actions/cat/fielddata.rb | 5 +- .../elasticsearch/api/actions/cat/health.rb | 3 +- .../lib/elasticsearch/api/actions/cat/help.rb | 2 +- .../elasticsearch/api/actions/cat/indices.rb | 4 +- .../elasticsearch/api/actions/cat/master.rb | 4 +- .../actions/cat/ml_data_frame_analytics.rb | 6 +- .../api/actions/cat/ml_datafeeds.rb | 5 +- .../elasticsearch/api/actions/cat/ml_jobs.rb | 6 +- .../api/actions/cat/ml_trained_models.rb | 4 +- .../api/actions/cat/nodeattrs.rb | 4 +- .../elasticsearch/api/actions/cat/nodes.rb | 4 +- .../api/actions/cat/pending_tasks.rb | 3 +- .../elasticsearch/api/actions/cat/plugins.rb | 4 +- .../elasticsearch/api/actions/cat/recovery.rb | 4 +- .../api/actions/cat/repositories.rb | 4 +- .../elasticsearch/api/actions/cat/segments.rb | 5 +- .../elasticsearch/api/actions/cat/shards.rb | 4 +- .../api/actions/cat/snapshots.rb | 3 +- .../elasticsearch/api/actions/cat/tasks.rb | 5 +- .../api/actions/cat/templates.rb | 4 +- .../api/actions/cat/thread_pool.rb | 4 +- .../api/actions/cat/transforms.rb | 3 +- .../elasticsearch/api/actions/clear_scroll.rb | 2 +- .../api/actions/cluster/allocation_explain.rb | 2 +- .../cluster/delete_component_template.rb | 2 +- .../delete_voting_config_exclusions.rb | 4 +- .../cluster/exists_component_template.rb | 2 +- .../actions/cluster/get_component_template.rb | 2 +- .../api/actions/cluster/get_settings.rb | 2 +- .../api/actions/cluster/health.rb | 2 +- .../elasticsearch/api/actions/cluster/info.rb | 2 +- .../api/actions/cluster/pending_tasks.rb | 3 +- .../cluster/post_voting_config_exclusions.rb | 4 +- .../actions/cluster/put_component_template.rb | 2 +- .../api/actions/cluster/put_settings.rb | 2 +- .../api/actions/cluster/remote_info.rb | 2 +- .../api/actions/cluster/reroute.rb | 2 +- .../api/actions/cluster/state.rb | 2 +- .../api/actions/cluster/stats.rb | 2 +- .../api/actions/connector/check_in.rb | 2 +- .../api/actions/connector/delete.rb | 10 +-- .../api/actions/connector/get.rb | 10 +-- .../api/actions/connector/last_sync.rb | 66 ------------------- .../api/actions/connector/list.rb | 10 +-- .../api/actions/connector/post.rb | 10 +-- .../api/actions/connector/put.rb | 10 +-- .../api/actions/connector/secret_delete.rb | 2 +- .../api/actions/connector/secret_get.rb | 2 +- .../api/actions/connector/secret_post.rb | 2 +- .../api/actions/connector/secret_put.rb | 2 +- .../api/actions/connector/sync_job_cancel.rb | 10 +-- .../actions/connector/sync_job_check_in.rb | 2 +- .../api/actions/connector/sync_job_claim.rb | 2 +- .../api/actions/connector/sync_job_delete.rb | 10 +-- .../api/actions/connector/sync_job_error.rb | 2 +- .../api/actions/connector/sync_job_get.rb | 10 +-- .../api/actions/connector/sync_job_list.rb | 10 +-- .../api/actions/connector/sync_job_post.rb | 10 +-- .../connector/sync_job_update_stats.rb | 2 +- .../connector/update_active_filtering.rb | 2 +- .../actions/connector/update_api_key_id.rb | 10 +-- .../actions/connector/update_configuration.rb | 10 +-- .../api/actions/connector/update_error.rb | 2 +- .../api/actions/connector/update_features.rb | 2 +- .../api/actions/connector/update_filtering.rb | 10 +-- .../connector/update_filtering_validation.rb | 4 +- .../actions/connector/update_index_name.rb | 10 +-- .../api/actions/connector/update_name.rb | 10 +-- .../api/actions/connector/update_native.rb | 12 ++-- .../api/actions/connector/update_pipeline.rb | 10 +-- .../actions/connector/update_scheduling.rb | 10 +-- .../actions/connector/update_service_type.rb | 10 +-- .../api/actions/connector/update_status.rb | 2 +- .../lib/elasticsearch/api/actions/count.rb | 2 +- .../lib/elasticsearch/api/actions/create.rb | 4 +- .../delete_auto_follow_pattern.rb | 2 +- .../cross_cluster_replication/follow.rb | 2 +- .../cross_cluster_replication/follow_info.rb | 2 +- .../cross_cluster_replication/follow_stats.rb | 2 +- .../forget_follower.rb | 2 +- .../get_auto_follow_pattern.rb | 2 +- .../pause_auto_follow_pattern.rb | 2 +- .../cross_cluster_replication/pause_follow.rb | 2 +- .../put_auto_follow_pattern.rb | 2 +- .../resume_auto_follow_pattern.rb | 2 +- .../resume_follow.rb | 2 +- .../cross_cluster_replication/stats.rb | 2 +- .../cross_cluster_replication/unfollow.rb | 2 +- .../dangling_indices/delete_dangling_index.rb | 4 +- .../dangling_indices/import_dangling_index.rb | 4 +- .../dangling_indices/list_dangling_indices.rb | 4 +- .../lib/elasticsearch/api/actions/delete.rb | 2 +- .../api/actions/delete_by_query.rb | 2 +- .../api/actions/delete_by_query_rethrottle.rb | 4 +- .../api/actions/delete_script.rb | 4 +- .../api/actions/enrich/delete_policy.rb | 2 +- .../api/actions/enrich/execute_policy.rb | 2 +- .../api/actions/enrich/get_policy.rb | 2 +- .../api/actions/enrich/put_policy.rb | 2 +- .../elasticsearch/api/actions/enrich/stats.rb | 2 +- .../elasticsearch/api/actions/eql/delete.rb | 4 +- .../lib/elasticsearch/api/actions/eql/get.rb | 4 +- .../api/actions/eql/get_status.rb | 4 +- .../elasticsearch/api/actions/eql/search.rb | 2 +- .../api/actions/esql/async_query.rb | 2 +- .../api/actions/esql/async_query_delete.rb | 2 +- .../api/actions/esql/async_query_get.rb | 2 +- .../api/actions/esql/async_query_stop.rb | 2 +- .../elasticsearch/api/actions/esql/query.rb | 4 +- .../lib/elasticsearch/api/actions/exists.rb | 2 +- .../api/actions/exists_source.rb | 2 +- .../lib/elasticsearch/api/actions/explain.rb | 2 +- .../api/actions/features/get_features.rb | 2 +- .../api/actions/features/reset_features.rb | 4 +- .../elasticsearch/api/actions/field_caps.rb | 2 +- .../api/actions/fleet/delete_secret.rb | 2 +- .../api/actions/fleet/get_secret.rb | 2 +- .../api/actions/fleet/global_checkpoints.rb | 2 +- .../api/actions/fleet/msearch.rb | 2 +- .../api/actions/fleet/post_secret.rb | 2 +- .../elasticsearch/api/actions/fleet/search.rb | 2 +- .../lib/elasticsearch/api/actions/get.rb | 2 +- .../elasticsearch/api/actions/get_script.rb | 4 +- .../api/actions/get_script_context.rb | 4 +- .../api/actions/get_script_languages.rb | 4 +- .../elasticsearch/api/actions/get_source.rb | 2 +- .../api/actions/graph/explore.rb | 2 +- .../api/actions/health_report.rb | 2 +- .../lib/elasticsearch/api/actions/index.rb | 2 +- .../delete_lifecycle.rb | 2 +- .../explain_lifecycle.rb | 2 +- .../get_lifecycle.rb | 2 +- .../index_lifecycle_management/get_status.rb | 2 +- .../migrate_to_data_tiers.rb | 2 +- .../move_to_step.rb | 2 +- .../put_lifecycle.rb | 2 +- .../remove_policy.rb | 2 +- .../index_lifecycle_management/retry.rb | 2 +- .../index_lifecycle_management/start.rb | 2 +- .../index_lifecycle_management/stop.rb | 2 +- .../api/actions/indices/add_block.rb | 4 +- .../api/actions/indices/analyze.rb | 4 +- .../api/actions/indices/clear_cache.rb | 2 +- .../api/actions/indices/clone.rb | 2 +- .../api/actions/indices/close.rb | 4 +- .../api/actions/indices/create.rb | 2 +- .../api/actions/indices/create_data_stream.rb | 4 +- .../api/actions/indices/data_streams_stats.rb | 4 +- .../api/actions/indices/delete.rb | 2 +- .../api/actions/indices/delete_alias.rb | 4 +- .../actions/indices/delete_data_lifecycle.rb | 2 +- .../api/actions/indices/delete_data_stream.rb | 4 +- .../indices/delete_data_stream_options.rb | 2 +- .../actions/indices/delete_index_template.rb | 2 +- .../api/actions/indices/delete_template.rb | 2 +- .../api/actions/indices/disk_usage.rb | 2 +- .../api/actions/indices/downsample.rb | 2 +- .../api/actions/indices/exists.rb | 2 +- .../api/actions/indices/exists_alias.rb | 4 +- .../actions/indices/exists_index_template.rb | 4 +- .../api/actions/indices/exists_template.rb | 2 +- .../actions/indices/explain_data_lifecycle.rb | 2 +- .../api/actions/indices/field_usage_stats.rb | 2 +- .../api/actions/indices/flush.rb | 2 +- .../api/actions/indices/forcemerge.rb | 2 +- .../elasticsearch/api/actions/indices/get.rb | 2 +- .../api/actions/indices/get_alias.rb | 4 +- .../api/actions/indices/get_data_lifecycle.rb | 2 +- .../indices/get_data_lifecycle_stats.rb | 2 +- .../api/actions/indices/get_data_stream.rb | 4 +- .../indices/get_data_stream_options.rb | 2 +- .../api/actions/indices/get_field_mapping.rb | 2 +- .../api/actions/indices/get_index_template.rb | 2 +- .../api/actions/indices/get_mapping.rb | 2 +- .../api/actions/indices/get_settings.rb | 2 +- .../api/actions/indices/get_template.rb | 2 +- .../actions/indices/migrate_to_data_stream.rb | 4 +- .../api/actions/indices/modify_data_stream.rb | 4 +- .../elasticsearch/api/actions/indices/open.rb | 2 +- .../actions/indices/promote_data_stream.rb | 4 +- .../api/actions/indices/put_alias.rb | 4 +- .../api/actions/indices/put_data_lifecycle.rb | 4 +- .../indices/put_data_stream_options.rb | 2 +- .../api/actions/indices/put_index_template.rb | 4 +- .../api/actions/indices/put_mapping.rb | 2 +- .../api/actions/indices/put_settings.rb | 2 +- .../api/actions/indices/put_template.rb | 2 +- .../api/actions/indices/recovery.rb | 2 +- .../api/actions/indices/refresh.rb | 2 +- .../indices/reload_search_analyzers.rb | 2 +- .../api/actions/indices/resolve_cluster.rb | 2 +- .../api/actions/indices/resolve_index.rb | 2 +- .../api/actions/indices/rollover.rb | 3 +- .../api/actions/indices/segments.rb | 2 +- .../api/actions/indices/shard_stores.rb | 2 +- .../api/actions/indices/shrink.rb | 2 +- .../indices/simulate_index_template.rb | 2 +- .../api/actions/indices/simulate_template.rb | 2 +- .../api/actions/indices/split.rb | 2 +- .../api/actions/indices/stats.rb | 2 +- .../api/actions/indices/unfreeze.rb | 2 +- .../api/actions/indices/update_aliases.rb | 4 +- .../api/actions/indices/validate_query.rb | 2 +- .../inference/chat_completion_unified.rb | 2 +- .../api/actions/inference/completion.rb | 2 +- .../api/actions/inference/inference.rb | 2 +- .../api/actions/inference/put.rb | 2 +- .../api/actions/inference/put_alibabacloud.rb | 2 +- .../actions/inference/put_amazonbedrock.rb | 2 +- .../actions/inference/put_amazonsagemaker.rb | 4 +- .../api/actions/inference/put_anthropic.rb | 2 +- .../actions/inference/put_azureaistudio.rb | 2 +- .../api/actions/inference/put_azureopenai.rb | 2 +- .../api/actions/inference/put_cohere.rb | 2 +- .../api/actions/inference/put_custom.rb | 2 +- .../api/actions/inference/put_deepseek.rb | 2 +- .../actions/inference/put_elasticsearch.rb | 2 +- .../api/actions/inference/put_elser.rb | 2 +- .../actions/inference/put_googleaistudio.rb | 2 +- .../actions/inference/put_googlevertexai.rb | 2 +- .../api/actions/inference/put_hugging_face.rb | 2 +- .../api/actions/inference/put_jinaai.rb | 2 +- .../api/actions/inference/put_mistral.rb | 2 +- .../api/actions/inference/put_openai.rb | 2 +- .../api/actions/inference/put_voyageai.rb | 4 +- .../api/actions/inference/put_watsonx.rb | 2 +- .../api/actions/inference/rerank.rb | 2 +- .../api/actions/inference/sparse_embedding.rb | 2 +- .../actions/inference/stream_completion.rb | 4 +- .../api/actions/inference/text_embedding.rb | 2 +- .../api/actions/inference/update.rb | 2 +- .../lib/elasticsearch/api/actions/info.rb | 4 +- .../actions/ingest/delete_geoip_database.rb | 4 +- .../ingest/delete_ip_location_database.rb | 2 +- .../api/actions/ingest/delete_pipeline.rb | 2 +- .../api/actions/ingest/geo_ip_stats.rb | 4 +- .../api/actions/ingest/get_geoip_database.rb | 4 +- .../ingest/get_ip_location_database.rb | 2 +- .../api/actions/ingest/get_pipeline.rb | 2 +- .../api/actions/ingest/processor_grok.rb | 4 +- .../api/actions/ingest/put_geoip_database.rb | 4 +- .../ingest/put_ip_location_database.rb | 2 +- .../api/actions/ingest/put_pipeline.rb | 4 +- .../api/actions/ingest/simulate.rb | 2 +- .../elasticsearch/api/actions/knn_search.rb | 4 +- .../api/actions/license/delete.rb | 2 +- .../elasticsearch/api/actions/license/get.rb | 2 +- .../api/actions/license/get_basic_status.rb | 2 +- .../api/actions/license/get_trial_status.rb | 2 +- .../elasticsearch/api/actions/license/post.rb | 4 +- .../api/actions/license/post_start_basic.rb | 2 +- .../api/actions/license/post_start_trial.rb | 2 +- .../api/actions/logstash/delete_pipeline.rb | 2 +- .../api/actions/logstash/get_pipeline.rb | 2 +- .../api/actions/logstash/put_pipeline.rb | 2 +- .../clear_trained_model_deployment_cache.rb | 2 +- .../api/actions/machine_learning/close_job.rb | 2 +- .../machine_learning/delete_calendar.rb | 2 +- .../machine_learning/delete_calendar_event.rb | 2 +- .../machine_learning/delete_calendar_job.rb | 2 +- .../delete_data_frame_analytics.rb | 2 +- .../machine_learning/delete_datafeed.rb | 2 +- .../machine_learning/delete_expired_data.rb | 2 +- .../actions/machine_learning/delete_filter.rb | 2 +- .../machine_learning/delete_forecast.rb | 2 +- .../actions/machine_learning/delete_job.rb | 2 +- .../machine_learning/delete_model_snapshot.rb | 2 +- .../machine_learning/delete_trained_model.rb | 2 +- .../delete_trained_model_alias.rb | 2 +- .../machine_learning/estimate_model_memory.rb | 4 +- .../machine_learning/evaluate_data_frame.rb | 2 +- .../explain_data_frame_analytics.rb | 4 +- .../api/actions/machine_learning/flush_job.rb | 2 +- .../api/actions/machine_learning/forecast.rb | 2 +- .../actions/machine_learning/get_buckets.rb | 2 +- .../machine_learning/get_calendar_events.rb | 2 +- .../actions/machine_learning/get_calendars.rb | 2 +- .../machine_learning/get_categories.rb | 2 +- .../get_data_frame_analytics.rb | 2 +- .../get_data_frame_analytics_stats.rb | 2 +- .../machine_learning/get_datafeed_stats.rb | 2 +- .../actions/machine_learning/get_datafeeds.rb | 2 +- .../actions/machine_learning/get_filters.rb | 2 +- .../machine_learning/get_influencers.rb | 2 +- .../actions/machine_learning/get_job_stats.rb | 2 +- .../api/actions/machine_learning/get_jobs.rb | 2 +- .../machine_learning/get_memory_stats.rb | 2 +- .../get_model_snapshot_upgrade_stats.rb | 2 +- .../machine_learning/get_model_snapshots.rb | 2 +- .../machine_learning/get_overall_buckets.rb | 2 +- .../actions/machine_learning/get_records.rb | 2 +- .../machine_learning/get_trained_models.rb | 2 +- .../get_trained_models_stats.rb | 2 +- .../machine_learning/infer_trained_model.rb | 2 +- .../api/actions/machine_learning/info.rb | 2 +- .../api/actions/machine_learning/open_job.rb | 2 +- .../machine_learning/post_calendar_events.rb | 2 +- .../api/actions/machine_learning/post_data.rb | 2 +- .../preview_data_frame_analytics.rb | 4 +- .../machine_learning/preview_datafeed.rb | 2 +- .../actions/machine_learning/put_calendar.rb | 2 +- .../machine_learning/put_calendar_job.rb | 2 +- .../put_data_frame_analytics.rb | 2 +- .../actions/machine_learning/put_datafeed.rb | 2 +- .../actions/machine_learning/put_filter.rb | 2 +- .../api/actions/machine_learning/put_job.rb | 2 +- .../machine_learning/put_trained_model.rb | 2 +- .../put_trained_model_alias.rb | 2 +- .../put_trained_model_definition_part.rb | 2 +- .../put_trained_model_vocabulary.rb | 2 +- .../api/actions/machine_learning/reset_job.rb | 2 +- .../machine_learning/revert_model_snapshot.rb | 2 +- .../machine_learning/set_upgrade_mode.rb | 2 +- .../start_data_frame_analytics.rb | 2 +- .../machine_learning/start_datafeed.rb | 2 +- .../start_trained_model_deployment.rb | 2 +- .../stop_data_frame_analytics.rb | 2 +- .../actions/machine_learning/stop_datafeed.rb | 2 +- .../stop_trained_model_deployment.rb | 2 +- .../update_data_frame_analytics.rb | 4 +- .../machine_learning/update_datafeed.rb | 2 +- .../actions/machine_learning/update_filter.rb | 2 +- .../actions/machine_learning/update_job.rb | 2 +- .../machine_learning/update_model_snapshot.rb | 2 +- .../update_trained_model_deployment.rb | 4 +- .../machine_learning/upgrade_job_snapshot.rb | 2 +- .../api/actions/machine_learning/validate.rb | 2 +- .../machine_learning/validate_detector.rb | 4 +- .../lib/elasticsearch/api/actions/mget.rb | 2 +- .../api/actions/migration/deprecations.rb | 2 +- .../migration/get_feature_upgrade_status.rb | 4 +- .../actions/migration/post_feature_upgrade.rb | 4 +- .../api/actions/monitoring/bulk.rb | 4 +- .../lib/elasticsearch/api/actions/msearch.rb | 4 +- .../api/actions/msearch_template.rb | 4 +- .../elasticsearch/api/actions/mtermvectors.rb | 2 +- .../clear_repositories_metering_archive.rb | 2 +- .../nodes/get_repositories_metering_info.rb | 2 +- .../api/actions/nodes/hot_threads.rb | 2 +- .../elasticsearch/api/actions/nodes/info.rb | 2 +- .../actions/nodes/reload_secure_settings.rb | 4 +- .../elasticsearch/api/actions/nodes/stats.rb | 2 +- .../elasticsearch/api/actions/nodes/usage.rb | 2 +- .../api/actions/open_point_in_time.rb | 2 +- .../lib/elasticsearch/api/actions/ping.rb | 4 +- .../api/actions/profiling/flamegraph.rb | 2 +- .../api/actions/profiling/stacktraces.rb | 2 +- .../api/actions/profiling/status.rb | 2 +- .../api/actions/profiling/topn_functions.rb | 2 +- .../elasticsearch/api/actions/put_script.rb | 4 +- .../api/actions/query_rules/delete_rule.rb | 2 +- .../api/actions/query_rules/delete_ruleset.rb | 2 +- .../api/actions/query_rules/get_rule.rb | 2 +- .../api/actions/query_rules/get_ruleset.rb | 2 +- .../api/actions/query_rules/list_rulesets.rb | 2 +- .../api/actions/query_rules/put_rule.rb | 2 +- .../api/actions/query_rules/put_ruleset.rb | 2 +- .../api/actions/query_rules/test.rb | 6 +- .../elasticsearch/api/actions/rank_eval.rb | 2 +- .../lib/elasticsearch/api/actions/reindex.rb | 4 +- .../api/actions/reindex_rethrottle.rb | 2 +- .../api/actions/render_search_template.rb | 2 +- .../api/actions/rollup/delete_job.rb | 2 +- .../api/actions/rollup/get_jobs.rb | 2 +- .../api/actions/rollup/get_rollup_caps.rb | 2 +- .../actions/rollup/get_rollup_index_caps.rb | 2 +- .../api/actions/rollup/put_job.rb | 2 +- .../api/actions/rollup/rollup_search.rb | 2 +- .../api/actions/rollup/start_job.rb | 2 +- .../api/actions/rollup/stop_job.rb | 2 +- .../api/actions/scripts_painless_execute.rb | 2 +- .../lib/elasticsearch/api/actions/scroll.rb | 4 +- .../lib/elasticsearch/api/actions/search.rb | 4 +- .../api/actions/search_application/delete.rb | 10 +-- .../delete_behavioral_analytics.rb | 2 +- .../api/actions/search_application/get.rb | 10 +-- .../get_behavioral_analytics.rb | 2 +- .../api/actions/search_application/list.rb | 12 ++-- .../post_behavioral_analytics_event.rb | 4 +- .../api/actions/search_application/put.rb | 10 +-- .../put_behavioral_analytics.rb | 2 +- .../search_application/render_query.rb | 2 +- .../api/actions/search_application/search.rb | 10 +-- .../elasticsearch/api/actions/search_mvt.rb | 6 +- .../api/actions/search_shards.rb | 2 +- .../api/actions/search_template.rb | 4 +- .../searchable_snapshots/cache_stats.rb | 4 +- .../searchable_snapshots/clear_cache.rb | 4 +- .../api/actions/searchable_snapshots/mount.rb | 2 +- .../api/actions/searchable_snapshots/stats.rb | 4 +- .../actions/security/activate_user_profile.rb | 2 +- .../api/actions/security/authenticate.rb | 2 +- .../api/actions/security/bulk_delete_role.rb | 2 +- .../api/actions/security/bulk_put_role.rb | 2 +- .../actions/security/bulk_update_api_keys.rb | 2 +- .../api/actions/security/change_password.rb | 2 +- .../actions/security/clear_api_key_cache.rb | 2 +- .../security/clear_cached_privileges.rb | 2 +- .../actions/security/clear_cached_realms.rb | 2 +- .../actions/security/clear_cached_roles.rb | 2 +- .../security/clear_cached_service_tokens.rb | 2 +- .../api/actions/security/create_api_key.rb | 2 +- .../security/create_cross_cluster_api_key.rb | 2 +- .../actions/security/create_service_token.rb | 2 +- .../api/actions/security/delegate_pki.rb | 2 +- .../api/actions/security/delete_privileges.rb | 2 +- .../api/actions/security/delete_role.rb | 2 +- .../actions/security/delete_role_mapping.rb | 2 +- .../actions/security/delete_service_token.rb | 2 +- .../api/actions/security/delete_user.rb | 2 +- .../api/actions/security/disable_user.rb | 2 +- .../actions/security/disable_user_profile.rb | 2 +- .../api/actions/security/enable_user.rb | 2 +- .../actions/security/enable_user_profile.rb | 2 +- .../api/actions/security/enroll_kibana.rb | 2 +- .../api/actions/security/enroll_node.rb | 2 +- .../api/actions/security/get_api_key.rb | 2 +- .../security/get_builtin_privileges.rb | 2 +- .../api/actions/security/get_privileges.rb | 2 +- .../api/actions/security/get_role.rb | 2 +- .../api/actions/security/get_role_mapping.rb | 2 +- .../actions/security/get_service_accounts.rb | 2 +- .../security/get_service_credentials.rb | 2 +- .../api/actions/security/get_settings.rb | 2 +- .../api/actions/security/get_token.rb | 2 +- .../api/actions/security/get_user.rb | 2 +- .../actions/security/get_user_privileges.rb | 2 +- .../api/actions/security/get_user_profile.rb | 2 +- .../api/actions/security/grant_api_key.rb | 2 +- .../api/actions/security/has_privileges.rb | 2 +- .../security/has_privileges_user_profile.rb | 2 +- .../actions/security/invalidate_api_key.rb | 2 +- .../api/actions/security/invalidate_token.rb | 2 +- .../api/actions/security/oidc_authenticate.rb | 2 +- .../api/actions/security/oidc_logout.rb | 2 +- .../security/oidc_prepare_authentication.rb | 2 +- .../api/actions/security/put_privileges.rb | 2 +- .../api/actions/security/put_role.rb | 2 +- .../api/actions/security/put_role_mapping.rb | 2 +- .../api/actions/security/put_user.rb | 2 +- .../api/actions/security/query_api_keys.rb | 2 +- .../api/actions/security/query_role.rb | 2 +- .../api/actions/security/query_user.rb | 2 +- .../api/actions/security/saml_authenticate.rb | 2 +- .../actions/security/saml_complete_logout.rb | 2 +- .../api/actions/security/saml_invalidate.rb | 2 +- .../api/actions/security/saml_logout.rb | 2 +- .../security/saml_prepare_authentication.rb | 2 +- .../saml_service_provider_metadata.rb | 2 +- .../actions/security/suggest_user_profiles.rb | 2 +- .../api/actions/security/update_api_key.rb | 2 +- .../security/update_cross_cluster_api_key.rb | 2 +- .../api/actions/security/update_settings.rb | 2 +- .../security/update_user_profile_data.rb | 2 +- .../api/actions/shutdown/delete_node.rb | 4 +- .../api/actions/shutdown/get_node.rb | 4 +- .../api/actions/shutdown/put_node.rb | 4 +- .../api/actions/simulate/ingest.rb | 2 +- .../actions/snapshot/cleanup_repository.rb | 2 +- .../api/actions/snapshot/clone.rb | 4 +- .../api/actions/snapshot/create.rb | 4 +- .../api/actions/snapshot/create_repository.rb | 4 +- .../api/actions/snapshot/delete.rb | 4 +- .../api/actions/snapshot/delete_repository.rb | 4 +- .../elasticsearch/api/actions/snapshot/get.rb | 4 +- .../api/actions/snapshot/get_repository.rb | 4 +- .../actions/snapshot/repository_analyze.rb | 4 +- .../api/actions/snapshot/restore.rb | 4 +- .../api/actions/snapshot/status.rb | 4 +- .../api/actions/snapshot/verify_repository.rb | 4 +- .../delete_lifecycle.rb | 2 +- .../execute_lifecycle.rb | 2 +- .../execute_retention.rb | 2 +- .../get_lifecycle.rb | 2 +- .../get_stats.rb | 2 +- .../get_status.rb | 2 +- .../put_lifecycle.rb | 2 +- .../snapshot_lifecycle_management/start.rb | 2 +- .../snapshot_lifecycle_management/stop.rb | 2 +- .../api/actions/sql/clear_cursor.rb | 2 +- .../api/actions/sql/delete_async.rb | 2 +- .../api/actions/sql/get_async.rb | 2 +- .../api/actions/sql/get_async_status.rb | 2 +- .../elasticsearch/api/actions/sql/query.rb | 2 +- .../api/actions/sql/translate.rb | 2 +- .../api/actions/ssl/certificates.rb | 2 +- .../api/actions/synonyms/delete_synonym.rb | 2 +- .../actions/synonyms/delete_synonym_rule.rb | 2 +- .../api/actions/synonyms/get_synonym.rb | 2 +- .../api/actions/synonyms/get_synonym_rule.rb | 2 +- .../api/actions/synonyms/get_synonyms_sets.rb | 4 +- .../api/actions/synonyms/put_synonym.rb | 2 +- .../api/actions/synonyms/put_synonym_rule.rb | 2 +- .../elasticsearch/api/actions/tasks/cancel.rb | 2 +- .../elasticsearch/api/actions/tasks/get.rb | 2 +- .../elasticsearch/api/actions/tasks/list.rb | 2 +- .../elasticsearch/api/actions/terms_enum.rb | 2 +- .../elasticsearch/api/actions/termvectors.rb | 2 +- .../text_structure/find_field_structure.rb | 2 +- .../text_structure/find_message_structure.rb | 2 +- .../actions/text_structure/find_structure.rb | 2 +- .../text_structure/test_grok_pattern.rb | 2 +- .../api/actions/transform/delete_transform.rb | 2 +- .../api/actions/transform/get_node_stats.rb | 2 +- .../api/actions/transform/get_transform.rb | 2 +- .../actions/transform/get_transform_stats.rb | 2 +- .../actions/transform/preview_transform.rb | 2 +- .../api/actions/transform/put_transform.rb | 2 +- .../api/actions/transform/reset_transform.rb | 2 +- .../transform/schedule_now_transform.rb | 2 +- .../api/actions/transform/set_upgrade_mode.rb | 4 +- .../api/actions/transform/start_transform.rb | 2 +- .../api/actions/transform/stop_transform.rb | 2 +- .../api/actions/transform/update_transform.rb | 4 +- .../actions/transform/upgrade_transforms.rb | 4 +- .../lib/elasticsearch/api/actions/update.rb | 2 +- .../api/actions/update_by_query.rb | 3 +- .../api/actions/update_by_query_rethrottle.rb | 4 +- .../api/actions/watcher/ack_watch.rb | 4 +- .../api/actions/watcher/activate_watch.rb | 4 +- .../api/actions/watcher/deactivate_watch.rb | 4 +- .../api/actions/watcher/delete_watch.rb | 4 +- .../api/actions/watcher/execute_watch.rb | 4 +- .../api/actions/watcher/get_settings.rb | 4 +- .../api/actions/watcher/get_watch.rb | 4 +- .../api/actions/watcher/put_watch.rb | 7 +- .../api/actions/watcher/query_watches.rb | 4 +- .../api/actions/watcher/start.rb | 4 +- .../api/actions/watcher/stats.rb | 4 +- .../elasticsearch/api/actions/watcher/stop.rb | 4 +- .../api/actions/watcher/update_settings.rb | 4 +- .../elasticsearch/api/actions/xpack/info.rb | 2 +- .../elasticsearch/api/actions/xpack/usage.rb | 4 +- 546 files changed, 786 insertions(+), 841 deletions(-) delete mode 100644 elasticsearch-api/lib/elasticsearch/api/actions/connector/last_sync.rb diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb index 9516dd3e59..fc56ea296e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module AsyncSearch module Actions - # Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. + # Delete an async search # # @option arguments [String] :id The async search ID # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb index e1faa2b981..b30ae0c7bb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module AsyncSearch module Actions - # Retrieves the results of a previously submitted async search request given its ID. + # Get async search results # # @option arguments [String] :id The async search ID # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb index 4324d9aabd..2e0ca100f8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module AsyncSearch module Actions - # Retrieves the status of a previously submitted async search request given its ID. + # Get the async search status # # @option arguments [String] :id The async search ID # @option arguments [Time] :keep_alive Specify the time interval in which the results (partial or final) for this search will be available diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb index 4367fe366a..42f1808805 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module AsyncSearch module Actions - # Executes a search request asynchronously. + # Run an async search # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/delete_autoscaling_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/delete_autoscaling_policy.rb index f71ae17fbb..8b8e1e61bd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/delete_autoscaling_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/delete_autoscaling_policy.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Autoscaling module Actions - # Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + # Delete an autoscaling policy # # @option arguments [String] :name the name of the autoscaling policy # @option arguments [Time] :master_timeout Timeout for processing on master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_capacity.rb b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_capacity.rb index 050ea5af7d..f0969e05de 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_capacity.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_capacity.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Autoscaling module Actions - # Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + # Get the autoscaling capacity # # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_policy.rb index 89a7aaf745..b7170a67f4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/get_autoscaling_policy.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Autoscaling module Actions - # Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + # Get an autoscaling policy # # @option arguments [String] :name the name of the autoscaling policy # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-get-autoscaling-policy.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-get-autoscaling-capacity.html # def get_autoscaling_policy(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'autoscaling.get_autoscaling_policy' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/put_autoscaling_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/put_autoscaling_policy.rb index 18d49b29e6..813766569f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/put_autoscaling_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/autoscaling/put_autoscaling_policy.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Autoscaling module Actions - # Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + # Create or update an autoscaling policy # # @option arguments [String] :name the name of the autoscaling policy # @option arguments [Time] :master_timeout Timeout for processing on master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb b/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb index 927e9cd968..c86409f84e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Allows to perform multiple index/update/delete operations in a single request. + # Bulk index or delete documents # # @option arguments [String] :index Default index for items which don't provide one # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk 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) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb index e659b016fa..0e1443d9dc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Shows information about currently configured aliases to indices including filter and routing infos. + # Get aliases # # @option arguments [List] :name A comma-separated list of alias names to return # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @@ -32,6 +32,8 @@ module Actions # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers # @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 [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-alias.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb index 436703ce93..5c4397a441 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb @@ -22,11 +22,12 @@ module Elasticsearch module API module Cat module Actions - # Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. + # Get shard allocation information # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [List] :h Comma-separated list of column names to display diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb index f3b3a4971d..3a4962323c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns information about existing component_templates templates. + # Get component templates # # @option arguments [String] :name A pattern that returned component template names must match # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @@ -32,6 +32,8 @@ module Actions # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-component-templates.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb index 0d3dba5fd9..fa6a1a394d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Provides quick access to the document count of the entire cluster, or individual indices. + # Get a document count # # @option arguments [List] :index A comma-separated list of index names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @@ -30,6 +30,8 @@ module Actions # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-count.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb index 7aea84e053..1d98f94e86 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb @@ -22,15 +22,16 @@ module Elasticsearch module API module Cat module Actions - # Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + # Get field data cache information # # @option arguments [List] :fields A comma-separated list of fields to return the fielddata size # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-fielddata.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb index 270c335a49..a4e2fc05f8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns a concise representation of the cluster health. + # Get the cluster health status # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [List] :h Comma-separated list of column names to display @@ -31,6 +31,7 @@ module Actions # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :ts Set to false to disable timestamping # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-health.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb index 2512647795..781e73119a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns help for the Cat APIs. + # Get CAT help # # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb index 22774ec150..6826a215f0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Cat module Actions - # Returns information about indices: number of primaries and replicas, document counts, disk size, ... + # Get index information # # @option arguments [List] :index A comma-separated list of index names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (options: green, yellow, red) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb index af172987ac..e5242cbe11 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns information about the master node. + # Get master node information # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) @@ -31,6 +31,8 @@ module Actions # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-master.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb index c6cc0148f3..eefa12efa1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Cat module Actions - # Gets configuration and usage information about data frame analytics jobs. + # Get data frame analytics jobs # # @option arguments [String] :id The ID of the data frame analytics to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified) - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information @@ -35,7 +35,7 @@ module Actions # @option arguments [Boolean] :v Verbose mode. Display column headers # @option arguments [Hash] :headers Custom HTTP headers # - # @see http://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-dfanalytics.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-dfanalytics.html # def ml_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_data_frame_analytics' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb index a506d32a43..7db400a71e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Gets configuration and usage information about datafeeds. + # Get datafeeds # # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) @@ -32,9 +32,10 @@ module Actions # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Hash] :headers Custom HTTP headers # - # @see http://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-datafeeds.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-datafeeds.html # def ml_datafeeds(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_datafeeds' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb index 61af82c6ba..00723cf7e5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Cat module Actions - # Gets configuration and usage information about anomaly detection jobs. + # Get anomaly detection jobs # # @option arguments [String] :job_id The ID of the jobs stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information @@ -35,7 +35,7 @@ module Actions # @option arguments [Boolean] :v Verbose mode. Display column headers # @option arguments [Hash] :headers Custom HTTP headers # - # @see http://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-anomaly-detectors.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-anomaly-detectors.html # def ml_jobs(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_jobs' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb index 6b5644aea7..6ba80368dc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Cat module Actions - # Gets configuration and usage information about inference trained models. + # Get trained models # # @option arguments [String] :model_id The ID of the trained models stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) # @option arguments [Integer] :from skips a number of trained models # @option arguments [Integer] :size specifies a max number of trained models to get - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb index c135dea575..6fc865f366 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns information about custom node attributes. + # Get node attribute information # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) @@ -31,6 +31,8 @@ module Actions # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-nodeattrs.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb index a8fd9a68db..61c506715c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb @@ -22,9 +22,9 @@ module Elasticsearch module API module Cat module Actions - # Returns basic statistics about performance of cluster nodes. + # Get node information # - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :full_id Return the full node ID instead of the shortened version (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb index 08f83806a2..4d8ee9fac4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns a concise representation of the cluster pending tasks. + # Get pending task information # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) @@ -32,6 +32,7 @@ module Actions # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-pending-tasks.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb index 9f5ba5f4a6..3935cbc332 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns information about installed plugins across nodes node. + # Get plugin information # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) @@ -32,6 +32,8 @@ module Actions # @option arguments [Boolean] :include_bootstrap Include bootstrap plugins in the response # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-plugins.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb index 6976a3cde7..6f7d6afe8e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Cat module Actions - # Returns information about index shard recoveries, both on-going completed. + # Get shard recovery information # # @option arguments [List] :index Comma-separated list or wildcard expression of index names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb index 318519fc95..0dc4ea89a2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns information about snapshot repositories registered in the cluster. + # Get snapshot repository information # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node @@ -31,6 +31,8 @@ module Actions # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-repositories.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb index 053a6b9675..a61c07506f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb @@ -22,17 +22,18 @@ module Elasticsearch module API module Cat module Actions - # Provides low-level information about the segments in the shards of an index. + # Get segment information # # @option arguments [List] :index A comma-separated list of index names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-segments.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb index 39948c700d..9c1012b156 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Cat module Actions - # Provides a detailed view of shard allocation on nodes. + # Get shard information # # @option arguments [List] :index A comma-separated list of index names to limit the returned information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [List] :h Comma-separated list of column names to display # @option arguments [Boolean] :help Return help information diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb index a2fe0fa7c7..649418bf21 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns all snapshots in a specific repository. + # Get snapshot information # # @option arguments [List] :repository Name of repository from which to fetch the snapshot information # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @@ -33,6 +33,7 @@ module Actions # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-snapshots.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb index ddfb454210..4b563fbb36 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns information about the tasks currently executing on one or more nodes in the cluster. + # Get task information # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -40,9 +40,10 @@ module Actions # @option arguments [Boolean] :v Verbose mode. Display column headers # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the task has completed. + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/tasks.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-tasks.html # def tasks(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.tasks' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb index 1cfe8f0a74..af0e842b88 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns information about existing templates. + # Get index template information # # @option arguments [String] :name A pattern that returned template names must match # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @@ -32,6 +32,8 @@ module Actions # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) + # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-templates.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb index fec1c415d9..5089909fe3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb @@ -22,8 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Returns cluster-wide thread pool statistics per node. - # By default the active, queue and rejected statistics are returned for all thread pools. + # Get thread pool statistics # # @option arguments [List] :thread_pool_patterns A comma-separated list of regular-expressions to filter the thread pools in the output # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @@ -34,6 +33,7 @@ module Actions # @option arguments [Boolean] :help Return help information # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-thread-pool.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb index 27ca6176db..dd1c80fa9b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cat module Actions - # Gets configuration and usage information about transforms. + # Get transform information # # @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms # @option arguments [Integer] :from skips a number of transform configs, defaults to 0 @@ -34,6 +34,7 @@ module Actions # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb) # @option arguments [Hash] :headers Custom HTTP headers # # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-transforms.html diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb b/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb index 7465abc866..a8873b31de 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Explicitly clears the search context for a scroll. + # Clear a scrolling search # # @option arguments [List] :scroll_id A comma-separated list of scroll IDs to clear *Deprecated* # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb index cb369d4279..cd7da4e3ae 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Provides explanations for shard allocations in the cluster. + # Explain the shard allocations # # @option arguments [Time] :master_timeout Timeout for connection to master node # @option arguments [Boolean] :include_yes_decisions Return 'YES' decisions in explanation (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb index 1a0f86efe0..81820a3050 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Deletes a component template + # Delete component templates # # @option arguments [String] :name The name of the template # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb index 84eabc2c23..81205de3f6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Cluster module Actions - # Clears cluster voting config exclusions. + # Clear cluster voting config exclusions # # @option arguments [Boolean] :wait_for_removal Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. # @option arguments [Time] :master_timeout Timeout for submitting request to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/voting-config-exclusions.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-cluster-post-voting-config-exclusions # def delete_voting_config_exclusions(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.delete_voting_config_exclusions' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb index 93c79da187..5c3da0681a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Returns information about whether a particular component template exist + # Check component templates # # @option arguments [String] :name The name of the template # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb index c36e5a47b3..32c25e5e95 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Returns one or more component templates + # Get component templates # # @option arguments [List] :name The comma separated names of the component templates # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb index fb93a36807..72be4bd8be 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Returns cluster settings. + # Get cluster-wide settings # # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb index aa74e80127..1cc104481c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Returns basic information about the health of the cluster. + # Get the cluster health status # # @option arguments [List] :index Limit the information returned to a specific index # @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) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb index 41c6837345..bad4902b65 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Returns different information about the cluster. + # Get cluster info # # @option arguments [List] :target Limit the information returned to the specified target. (options: _all, http, ingest, thread_pool, script) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb index 2371a4607e..6caa3752b7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb @@ -22,8 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Returns a list of any cluster-level changes (e.g. create index, update mapping, - # allocate or fail shard) which have not yet been executed. + # Get the pending cluster tasks # # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Time] :master_timeout Specify timeout for connection to master diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb index 5cd95c1101..25724690bb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Updates the cluster voting config exclusions by node ids or node names. + # Update voting configuration exclusions # # @option arguments [String] :node_ids A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_names. # @option arguments [String] :node_names A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_ids. @@ -30,7 +30,7 @@ module Actions # @option arguments [Time] :master_timeout Timeout for submitting request to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/voting-config-exclusions.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-cluster-post-voting-config-exclusions # def post_voting_config_exclusions(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.post_voting_config_exclusions' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb index a5f55ae8b3..105b2c6c72 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Creates or updates a component template + # Create or update a component template # # @option arguments [String] :name The name of the template # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb index a559925aea..695190ac9d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Updates the cluster settings. + # Update the cluster settings # # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/remote_info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/remote_info.rb index 2c4d28f070..0f398eaf82 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/remote_info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/remote_info.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Returns the information about configured remote clusters. + # Get remote cluster information # # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb index ab95643f37..38ef242d6e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Allows to manually change the allocation of individual shards in the cluster. + # Reroute the cluster # # @option arguments [Boolean] :dry_run Simulate the operation only and return the resulting state # @option arguments [Boolean] :explain Return an explanation of why the commands can or cannot be executed diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb index 195c857c06..0c758e7ee6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Returns a comprehensive information about the state of the cluster. + # Get the cluster state # # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, blocks, metadata, nodes, routing_table, routing_nodes, master_node, version) # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb index 50a2aa6543..9acc6b48cf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Cluster module Actions - # Returns high-level overview of cluster statistics. + # Get cluster statistics # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes # @option arguments [Boolean] :include_remotes Include remote cluster data into the response (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb index f96304611e..af1488011e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Updates the last_seen timestamp in the connector document. + # Check in a connector # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb index 5924c2c540..6ff8df8de6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Deletes a connector. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Delete a connector + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be deleted. # @option arguments [Boolean] :delete_sync_jobs Determines whether associated sync jobs are also deleted. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb index e1b6e3b026..17dbe28f0f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Returns the details about a connector. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Get a connector + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be returned. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/last_sync.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/last_sync.rb deleted file mode 100644 index 145194db14..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/last_sync.rb +++ /dev/null @@ -1,66 +0,0 @@ -# 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. -# -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# -module Elasticsearch - module API - module Connector - module Actions - # Updates the stats of last sync in the connector document. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. - # - # @option arguments [String] :connector_id The unique identifier of the connector to be updated. - # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Object with stats related to the last connector sync run. (*Required*) - # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-last-sync-api.html - # - def last_sync(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'connector.last_sync' } - - defined_params = [:connector_id].each_with_object({}) do |variable, set_variables| - set_variables[variable] = arguments[variable] if arguments.key?(variable) - end - request_opts[:defined_params] = defined_params unless defined_params.empty? - - raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] - raise ArgumentError, "Required argument 'connector_id' missing" unless arguments[:connector_id] - - arguments = arguments.clone - headers = arguments.delete(:headers) || {} - - body = arguments.delete(:body) - - _connector_id = arguments.delete(:connector_id) - - method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_last_sync" - params = {} - - Elasticsearch::API::Response.new( - perform_request(method, path, params, body, headers, request_opts) - ) - end - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb index 0b1e249d84..d7942d4a73 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Lists all connectors. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Get all connectors + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [Integer] :from Starting offset (default: 0) # @option arguments [Integer] :size Specifies a max number of results to get (default: 100) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb index a6f2e0d849..34858a05ce 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Creates a connector. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Create a connector + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The connector configuration. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb index 00d857b6a3..e5e75755aa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Creates or updates a connector. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Create or update a connector + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be created or updated. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_delete.rb index 931bec6795..e9bba65f06 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_delete.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Deletes a connector secret. + # Deletes a connector secret # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_get.rb index 7ec6d602de..b9ea37d6f7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_get.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Retrieves a secret stored by Connectors. + # Retrieves a secret stored by Connectors # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_post.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_post.rb index 311404cadd..f2952986c5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_post.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_post.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Creates a secret for a Connector. + # Creates a secret for a Connector # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_put.rb index 94077f9da0..ced86732d6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/secret_put.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Creates or updates a secret for a Connector. + # Creates or updates a secret for a Connector # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb index 4b01b79f74..7abfb9c4c8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Cancels a connector sync job. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Cancel a connector sync job + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be canceled # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb index f4c73dbc62..537f964bd3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Checks in a connector sync job (refreshes 'last_seen'). + # Check in a connector sync job # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb index 1301192435..062ec41089 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Claims a connector sync job. + # Claim a connector sync job # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_delete.rb index 20e5cfec77..ebb5fbe440 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_delete.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Deletes a connector sync job. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Delete a connector sync job + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be deleted. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb index 393b4e16a4..6a4ffc2434 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Sets an error for a connector sync job. + # Set a connector sync job error # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_get.rb index 361a1bf6a9..b4b902bcc1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_get.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Returns the details about a connector sync job. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Get a connector sync job + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be returned. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_list.rb index 15a8a80050..bb6ff2f68f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_list.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Lists all connector sync jobs. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Get all connector sync jobs + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [Integer] :from Starting offset (default: 0) # @option arguments [Integer] :size specifies a max number of results to get (default: 100) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_post.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_post.rb index 98e04e8545..c06e31a00a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_post.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_post.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Creates a connector sync job. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Create a connector sync job + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The connector sync job data. (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb index 9c48876eaf..dd18f7b1a0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Updates the stats fields in the connector sync job document. + # Set the connector sync job stats # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_active_filtering.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_active_filtering.rb index 75a3c46b90..0500d4441d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_active_filtering.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Activates the draft filtering rules if they are in a validated state. + # Activate the connector draft filter # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb index f327702d7f..7dbb330188 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Updates the API key id and/or API key secret id fields in the connector document. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector API key ID + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb index 8282f8d80f..c84763aa67 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Updates the connector configuration. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector configuration + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb index f51edf1d6a..734d7df95c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Updates the error field in the connector document. + # Update the connector error field # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb index 90fa0151eb..e1462543d8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Updates the connector features in the connector document. + # Update the connector features # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering.rb index 8489314d24..cf35272c3f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Updates the filtering field in the connector document. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector filtering + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb index fd1c31ddf5..5bf670da01 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Updates the validation info of the draft filtering rules. + # Update the connector draft filtering validation # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Validation info for the draft filtering rules (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-filtering-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-filtering-validation-api.html # def update_filtering_validation(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_filtering_validation' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_index_name.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_index_name.rb index f2d7517b1f..265a706f75 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_index_name.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_index_name.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Updates the index name of the connector. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector index name + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_name.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_name.rb index 569506ddc0..2d0ca07176 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_name.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_name.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Updates the name and/or description fields in the connector document. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector name and description + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_native.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_native.rb index beec02fb6b..ba9a8276bc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_native.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_native.rb @@ -22,17 +22,17 @@ module Elasticsearch module API module Connector module Actions - # Updates the is_native flag of the connector. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector is_native flag + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An object containing the connector's is_native flag (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/connector-apis.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-native-api.html # def update_native(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_native' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_pipeline.rb index b41f6fd0fc..9ef634b7f2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_pipeline.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Updates the pipeline field in the connector document. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector pipeline + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_scheduling.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_scheduling.rb index a1e02f4031..4fd925e028 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_scheduling.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_scheduling.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Updates the scheduling field in the connector document. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector scheduling + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_service_type.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_service_type.rb index e335b3a830..e7c4df83ac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_service_type.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_service_type.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Connector module Actions - # Updates the service type of the connector. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Update the connector service type + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :connector_id The unique identifier of the connector to be updated. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb index 91fa939ada..353dab2d4d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Connector module Actions - # Updates the status of the connector. + # Update the connector status # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/count.rb b/elasticsearch-api/lib/elasticsearch/api/actions/count.rb index f6be676d21..aac3bd520c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/count.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/count.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns number of documents matching a query. + # Count search results # # @option arguments [List] :index A comma-separated list of indices to restrict the results # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/create.rb index 879086f83d..de4c0e5d56 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/create.rb @@ -21,9 +21,7 @@ module Elasticsearch module API module Actions - # Creates a new document in the index. - # - # Returns a 409 response when a document with a same ID already exists in the index. + # Create a new document in the index # # @option arguments [String] :id Document ID # @option arguments [String] :index The name of the index diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb index 8d9d8e024b..e9909deb86 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Deletes auto-follow patterns. + # Delete auto-follow patterns # # @option arguments [String] :name The name of the auto follow pattern. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb index e592737494..ea6fe4cff4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Creates a new follower index configured to follow the referenced leader index. + # Create a follower # # @option arguments [String] :index The name of the follower index # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before returning. Defaults to 0. 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) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb index 40943224ae..5b7842f2dd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Retrieves information about all follower indices, including parameters and status for each follower index + # Get follower information # # @option arguments [List] :index A comma-separated list of index patterns; use `_all` to perform the operation on all indices # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb index b57ac2b8d0..0b360a0eb7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + # Get follower stats # # @option arguments [List] :index A comma-separated list of index patterns; use `_all` to perform the operation on all indices # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb index aec2f07484..551ea68760 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Removes the follower retention leases from the leader. + # Forget a follower # # @option arguments [String] :index the name of the leader index for which specified follower retention leases should be removed # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb index 77996b6fc1..5ddb4051fe 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + # Get auto-follow patterns # # @option arguments [String] :name The name of the auto follow pattern. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb index 41a1fb3b1c..38c29fe94c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Pauses an auto-follow pattern + # Pause an auto-follow pattern # # @option arguments [String] :name The name of the auto follow pattern that should pause discovering new indices to follow. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb index 5fa62cbd8c..ac956f80c6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + # Pause a follower # # @option arguments [String] :index The name of the follower index that should pause following its leader index. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb index 9ef548970d..03c94dcac1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + # Create or update auto-follow patterns # # @option arguments [String] :name The name of the auto follow pattern. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb index 581352e9a5..9b0dcb5979 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Resumes an auto-follow pattern that has been paused + # Resume an auto-follow pattern # # @option arguments [String] :name The name of the auto follow pattern to resume discovering new indices to follow. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb index 9834e0bef0..439c0b5463 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Resumes a follower index that has been paused + # Resume a follower # # @option arguments [String] :index The name of the follow index to resume following. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb index 09568f7c12..0eec88abd0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Gets all stats related to cross-cluster replication. + # Get cross-cluster replication stats # # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb index d52ccf44de..acc106998c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module CrossClusterReplication module Actions - # Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + # Unfollow an index # # @option arguments [String] :index The name of the follower index that should be turned into a regular index. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb index da6173b31d..ba14bfa49d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module DanglingIndices module Actions - # Deletes the specified dangling index + # Delete a dangling index # # @option arguments [String] :index_uuid The UUID of the dangling index # @option arguments [Boolean] :accept_data_loss Must be set to true in order to delete the dangling index @@ -30,7 +30,7 @@ module Actions # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-gateway-dangling-indices.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/dangling-index-delete.html # def delete_dangling_index(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'dangling_indices.delete_dangling_index' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb index c96074eb0a..1e3ac7f476 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module DanglingIndices module Actions - # Imports the specified dangling index + # Import a dangling index # # @option arguments [String] :index_uuid The UUID of the dangling index # @option arguments [Boolean] :accept_data_loss Must be set to true in order to import the dangling index @@ -30,7 +30,7 @@ module Actions # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-gateway-dangling-indices.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/dangling-index-import.html # def import_dangling_index(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'dangling_indices.import_dangling_index' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb index e7e8959620..39b64bc75d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module DanglingIndices module Actions - # Returns all dangling indices. + # Get the dangling indices # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-gateway-dangling-indices.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/dangling-indices-list.html # def list_dangling_indices(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'dangling_indices.list_dangling_indices' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb index 7291a8171d..e62199346d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Removes a document from the index. + # Delete a document # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb index 12d1afe2a2..44abcb9c69 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Deletes documents matching the provided query. + # Delete documents # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [String] :analyzer The analyzer to use for the query string diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb index 3e1900894c..66434f2855 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb @@ -21,13 +21,13 @@ module Elasticsearch module API module Actions - # Changes the number of requests per second for a particular Delete By Query operation. + # Throttle a delete by query operation # # @option arguments [String] :task_id The task id to rethrottle # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-delete-by-query.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-delete-by-query.html#docs-delete-by-query-rethrottle # def delete_by_query_rethrottle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'delete_by_query_rethrottle' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb index 74aae3d1e9..34d49b27b1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb @@ -21,14 +21,14 @@ module Elasticsearch module API module Actions - # Deletes a script. + # Delete a script or search template # # @option arguments [String] :id Script ID # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-scripting.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-stored-script-api.html # def delete_script(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'delete_script' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb index c49d447d3e..c645d9cee0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Enrich module Actions - # Deletes an existing enrich policy and its enrich index. + # Delete an enrich policy # # @option arguments [String] :name The name of the enrich policy # @option arguments [Time] :master_timeout Timeout for processing on master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb index 5b8bad3caf..85a8464bd5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Enrich module Actions - # Creates the enrich index for an existing enrich policy. + # Run an enrich policy # # @option arguments [String] :name The name of the enrich policy # @option arguments [Boolean] :wait_for_completion Should the request should block until the execution is complete. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb index fddf09b50d..d9d6ea8c23 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Enrich module Actions - # Gets information about an enrich policy. + # Get an enrich policy # # @option arguments [List] :name A comma-separated list of enrich policy names # @option arguments [Time] :master_timeout Timeout for processing on master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb index 7c0f6ae758..7aa0b1dba1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Enrich module Actions - # Creates a new enrich policy. + # Create an enrich policy # # @option arguments [String] :name The name of the enrich policy # @option arguments [Time] :master_timeout Timeout for processing on master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/stats.rb index f1d1628cf0..cffc5d36b8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Enrich module Actions - # Gets enrich coordinator statistics and information about enrich policies that are currently executing. + # Get enrich stats # # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb index 30c98bf918..3a6974528c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Eql module Actions - # Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. + # Delete an async EQL search # # @option arguments [String] :id The async search ID # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/eql-search-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-eql-delete # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'eql.delete' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb index e18f92fed8..cc5b59f667 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Eql module Actions - # Returns async results from previously executed Event Query Language (EQL) search + # Get async EQL search results # # @option arguments [String] :id The async search ID # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response # @option arguments [Time] :keep_alive Update the time interval in which the results (partial or final) for this search will be available # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/eql-search-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-async-eql-search-api.html # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'eql.get' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb index b484093132..47a796e3f3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Eql module Actions - # Returns the status of a previously submitted async or stored Event Query Language (EQL) search + # Get the async EQL status # # @option arguments [String] :id The async search ID # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/eql-search-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-async-eql-status-api.html # def get_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'eql.get_status' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb index 60be0559af..39c520ced9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Eql module Actions - # Returns results matching a query expressed in Event Query Language (EQL) + # Get EQL search results # # @option arguments [String] :index The name of the index to scope the operation # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb index e32269a00e..53d3bb3d4d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Esql module Actions - # Executes an ESQL request asynchronously + # Run an async ES|QL query # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the csv format. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_delete.rb index 093fa6fd6d..d4819a78b9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_delete.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Esql module Actions - # Delete an async query request given its ID. + # Delete an async ES|QL query # # @option arguments [String] :id The async query ID # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb index 92eb404bbf..aaa3dd8ca0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Esql module Actions - # Retrieves the results of a previously submitted async query request given its ID. + # Get async ES|QL query results # # @option arguments [String] :id The async query ID # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb index 3bcdbeedeb..59bae9be1d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Esql module Actions - # Stops a previously submitted async query request given its ID and collects the results. + # Stop async ES|QL query # # @option arguments [String] :id The async query ID # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb index 4c5b32cfa6..53720942bb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Esql module Actions - # Executes an ESQL request + # Run an ES|QL query # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the csv format. @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Use the `query` element to start a query. Use `columnar` to format the answer. (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/esql-query-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/esql-rest.html # def query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'esql.query' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb b/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb index ef6b6b49dc..c0acfc2652 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns information about whether a document exists in an index. + # Check a document # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb b/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb index 0ce94a0976..8581f8a5db 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns information about whether a document source exists in an index. + # Check for a document source # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb b/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb index 934df7d1b0..ce87a58c03 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns information about why a specific matches (or doesn't match) a query. + # Explain a document match result # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb b/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb index 6cec38a8dd..8a3610e3ba 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Features module Actions - # Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + # Get the features # # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb b/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb index 5117397d6e..cb475be2b5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Features module Actions - # Resets the internal state of features, usually by deleting system indices + # Reset the features # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -31,7 +31,7 @@ module Actions # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/reset-features-api.html # def reset_features(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'features.reset_features' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb b/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb index 3f4f510061..54af835163 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns the information about the capabilities of fields among multiple indices. + # Get the field capabilities # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/delete_secret.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/delete_secret.rb index 8ff603ad77..7520ec5c58 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/delete_secret.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/delete_secret.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Fleet module Actions - # Deletes a secret stored by Fleet. + # Deletes a secret stored by Fleet # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/get_secret.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/get_secret.rb index f00f51e05c..bbf72e46b2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/get_secret.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/get_secret.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Fleet module Actions - # Retrieves a secret stored by Fleet. + # Retrieves a secret stored by Fleet # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb index 9c54aa2439..1e8f2364bb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Fleet module Actions - # Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project. + # Get global checkpoints # # @option arguments [String] :index The name of the index. # @option arguments [Boolean] :wait_for_advance Whether to wait for the global checkpoint to advance past the specified current checkpoints diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb index d80bbed755..8fbb576a63 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Fleet module Actions - # Multi Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project. + # Executes several fleet searches with a single API request # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/post_secret.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/post_secret.rb index 340520db70..d51b48519e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/post_secret.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/post_secret.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Fleet module Actions - # Creates a secret stored by Fleet. + # Creates a secret stored by Fleet # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb index d3f67b21dc..13e07bf6ef 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Fleet module Actions - # Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project. + # The purpose of the fleet search api is to provide a search api where the search will only be executed # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get.rb index d976cc137e..bfb8f2586a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns a document. + # Get a document by its ID # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb index 57f4907498..180828b772 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb @@ -21,13 +21,13 @@ module Elasticsearch module API module Actions - # Returns a script. + # Get a script or search template # # @option arguments [String] :id Script ID # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-scripting.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-stored-script-api.html # def get_script(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'get_script' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb index 56525362f5..2c7f093a46 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb @@ -21,11 +21,11 @@ module Elasticsearch module API module Actions - # Returns all script contexts. + # Get script contexts # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/painless/8.19/painless-contexts.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-script-contexts-api.html # def get_script_context(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'get_script_context' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb index e17febc645..fdb86bc4db 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb @@ -21,11 +21,11 @@ module Elasticsearch module API module Actions - # Returns available script types, languages and contexts + # Get script languages # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-scripting.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-script-languages-api.html # def get_script_languages(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'get_script_languages' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb index 687db89708..518da06b9e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns the source of a document. + # Get a document's source # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb b/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb index e0e311daf6..2a605045ea 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Graph module Actions - # Explore extracted and summarized information about the documents and terms in an index. + # Explore graph analytics # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [String] :routing Specific routing value diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb b/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb index 69ca029f70..ecc091b939 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns the health of the cluster. + # Get the cluster health # # @option arguments [String] :feature A feature of the cluster, as returned by the top-level health API # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index.rb index efcffeb223..03c43c6a71 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Creates or updates a document in an index. + # Create or update a document in an index # # @option arguments [String] :id Document ID # @option arguments [String] :index The name of the index diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb index 19970d79d2..2475615939 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted. + # Delete a lifecycle policy # # @option arguments [String] :policy The name of the index lifecycle policy # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb index f4f11115d0..c1bd7196bf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step. + # Explain the lifecycle state # # @option arguments [String] :index The name of the index to explain # @option arguments [Boolean] :only_managed filters the indices included in the response to ones managed by ILM diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb index af153b3579..7716b773f9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Returns the specified policy definition. Includes the policy version and last modified date. + # Get lifecycle policies # # @option arguments [String] :policy The name of the index lifecycle policy # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb index 1eba19261b..ebf9a79821 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Retrieves the current index lifecycle management (ILM) status. + # Get the ILM status # # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb index 04c232f811..2fc1b06284 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing + # Migrate to data tiers routing # # @option arguments [Boolean] :dry_run If set to true it will simulate the migration, providing a way to retrieve the ILM policies and indices that need to be migrated. The default is false # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb index 1b17910865..bd5c58d033 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Manually moves an index into the specified step and executes that step. + # Move to a lifecycle step # # @option arguments [String] :index The name of the index whose lifecycle step is to change # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb index 842bf100de..2f7a680055 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Creates a lifecycle policy + # Create or update a lifecycle policy # # @option arguments [String] :policy The name of the index lifecycle policy # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb index 628c59ccd0..aef6b6b7d9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Removes the assigned lifecycle policy and stops managing the specified index + # Remove policies from an index # # @option arguments [String] :index The name of the index to remove policy on # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb index ac11b7cae5..3845d8e048 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Retries executing the policy for an index that is in the ERROR step. + # Retry a policy # # @option arguments [String] :index The name of the indices (comma-separated) whose failed lifecycle step is to be retry # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb index 12627a36fe..943af594ad 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Start the index lifecycle management (ILM) plugin. + # Start the ILM plugin # # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb index abb8cd4af4..68294988ba 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module IndexLifecycleManagement module Actions - # Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + # Stop the ILM plugin # # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb index 69ed26b1a2..3f16cc4c6c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Adds a block to an index. + # Add an index block # # @option arguments [List] :index A comma separated list of indices to add a block to # @option arguments [String] :block The block to add (one of read, write, read_only or metadata) @@ -33,7 +33,7 @@ module Actions # @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 [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/index-modules-blocks.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/index-modules-blocks.html#add-index-block # def add_block(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.add_block' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb index 49727a09d0..f9121ffa20 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Indices module Actions - # Performs the analysis process on a text and return the tokens breakdown of the text. + # Get tokens from text analysis # # @option arguments [String] :index The name of the index to scope the operation # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Define analyzer/tokenizer parameters and the text on which the analysis should be performed # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-analyze.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-analyze # def analyze(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.analyze' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb index b709186fc0..c365216806 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Clears all or specific caches for one or more indices. + # Clear the cache # # @option arguments [List] :index A comma-separated list of index name to limit the operation # @option arguments [Boolean] :fielddata Clear field data diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb index 6c5c7dde64..b56203205e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Clones an index + # Clone an index # # @option arguments [String] :index The name of the source index to clone # @option arguments [String] :target The name of the target index to clone into diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb index 9239be3c00..64df55857f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Closes an index. + # Close an index # # @option arguments [List] :index A comma separated list of indices to close # @option arguments [Time] :timeout Explicit operation timeout @@ -33,7 +33,7 @@ module Actions # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-open-close.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-close.html # def close(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.close' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb index 26f6d969c7..08bd36b2c1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Creates an index with optional settings and mappings. + # Create an index # # @option arguments [String] :index The name of the index # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for before the operation returns. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb index aa4a8e4a8b..8c61526a45 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Indices module Actions - # Creates a data stream + # Create a data stream # # @option arguments [String] :name The name of the data stream # @option arguments [Time] :timeout Specify timeout for acknowledging the cluster state update # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-create-data-stream.html # def create_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.create_data_stream' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb index 99c5e7a1f9..9d1d240ca6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Indices module Actions - # Provides statistics on operations happening in a data stream. + # Get data stream stats # # @option arguments [List] :name A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-stream-stats-api.html # def data_streams_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.data_streams_stats' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb index 52ef37b6c5..06397232b2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Deletes an index. + # Delete indices # # @option arguments [List] :index A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb index 9076d60565..d9af1cf744 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Deletes an alias. + # Delete an alias # # @option arguments [List] :index A comma-separated list of index names (supports wildcards); use `_all` for all indices # @option arguments [List] :name A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. @@ -30,7 +30,7 @@ module Actions # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-aliases.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-delete-alias.html # def delete_alias(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_alias' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb index b2de6b3068..15cc639d33 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Deletes the data stream lifecycle of the selected data streams. + # Delete data stream lifecycles # # @option arguments [List] :name A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb index 8dad583efb..56da37f23d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Indices module Actions - # Deletes a data stream. + # Delete data streams # # @option arguments [List] :name A comma-separated list of data streams to delete; use `*` to delete all data streams # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-delete-data-stream.html # def delete_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_data_stream' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb index 9a49196535..ed420f5ca2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Deletes the data stream options of the selected data streams. + # Deletes the data stream options of the selected data streams # # @option arguments [List] :name A comma-separated list of data streams of which the data stream options will be deleted; use `*` to get all data streams # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb index 0ff1da8627..a55e8c4bdd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Deletes an index template. + # Delete an index template # # @option arguments [String] :name The name of the template # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb index efa5b5eefd..b3e0775ca9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Deletes an index template. + # Delete a legacy index template # # @option arguments [String] :name The name of the template # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb index 8d6034605d..aa2e38299a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Analyzes the disk usage of each field of an index or data stream + # Analyze the index disk usage # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb index 314559c949..a660f5b8e4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb @@ -33,7 +33,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The downsampling configuration (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/xpack-rollup.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-downsample-data-stream.html # def downsample(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.downsample' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb index 7343c2813f..a1abe49e4d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns information about whether a particular index exists. + # Check indices # # @option arguments [List] :index A comma-separated list of index names # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb index a3eef2ad97..a0da58aa06 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns information about whether a particular alias exists. + # Check aliases # # @option arguments [List] :name A comma-separated list of alias names to return # @option arguments [List] :index A comma-separated list of index names to filter aliases @@ -32,7 +32,7 @@ module Actions # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-aliases.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-exists-alias # def exists_alias(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.exists_alias' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb index f9784a5a74..276a5c2d7e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns information about whether a particular index template exists. + # Check index templates # # @option arguments [String] :name The name of the template # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/index-templates.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-exists-index-template # def exists_index_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.exists_index_template' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb index 153b3f993b..f7d013f5ef 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns information about whether a particular index template exists. + # Check existence of index templates # # @option arguments [List] :name The comma separated names of the index templates # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb index 13e6f85593..1fcbfe53f6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc. + # Get the status for a data stream lifecycle # # @option arguments [String] :index The name of the index to explain # @option arguments [Boolean] :include_defaults indicates if the API should return the default values the system uses for the index's lifecycle diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb index 4157e3e2f7..365754eb1f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns the field usage stats for each field of an index + # Get field usage stats # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb index 90d1498f65..7db51d28d1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Performs the flush operation on one or more indices. + # Flush data streams or indices # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string for all indices # @option arguments [Boolean] :force Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb index 88349b257d..607f573be3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Performs the force merge operation on one or more indices. + # Force a merge # # @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 [Boolean] :flush Specify whether the index should be flushed after performing the operation (default: true) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb index 9adeec3223..9a42b4110a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns information about one or more indices. + # Get index information # # @option arguments [List] :index A comma-separated list of index names # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb index 5b43226a4e..0f371c7807 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns an alias. + # Get aliases # # @option arguments [List] :name A comma-separated list of alias names to return # @option arguments [List] :index A comma-separated list of index names to filter aliases @@ -32,7 +32,7 @@ module Actions # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-aliases.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-alias.html # def get_alias(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_alias' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb index 3e84192382..24f6cdcd84 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns the data stream lifecycle of the selected data streams. + # Get data stream lifecycles # # @option arguments [List] :name A comma-separated list of data streams to get; use `*` to get all data streams # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb index 8f80aefd1c..06ae4f5b9d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Get data stream lifecycle statistics. + # Get data stream lifecycle stats # # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb index db1fdb7441..0023cd639a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns data streams. + # Get data streams # # @option arguments [List] :name A comma-separated list of data streams to get; use `*` to get all data streams # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) @@ -31,7 +31,7 @@ module Actions # @option arguments [Boolean] :verbose Whether the maximum timestamp for each data stream should be calculated and returned (default: false) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-data-stream.html # def get_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_stream' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb index efb1e65285..e9c80b071d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns the data stream options of the selected data streams. + # Returns the data stream options of the selected data streams # # @option arguments [List] :name A comma-separated list of data streams to get; use `*` to get all data streams # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb index fd373ea1f3..86047b8ae4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns mapping for one or more fields. + # Get mapping definitions # # @option arguments [List] :fields A comma-separated list of fields # @option arguments [List] :index A comma-separated list of index names diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb index 9750c905e8..6629a43e2d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns an index template. + # Get index templates # # @option arguments [String] :name A pattern that returned template names must match # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb index 272d9e158b..b089fe0b71 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns mappings for one or more indices. + # Get mapping definitions # # @option arguments [List] :index A comma-separated list of index names # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb index db63bd17d3..b641761c92 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns settings for one or more indices. + # Get index settings # # @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] :name The name of the settings that should be included diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb index 17aa26a759..37592a1cde 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns an index template. + # Get legacy index templates # # @option arguments [List] :name The comma separated names of the index templates # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb index 4e829a40ea..8117803127 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Indices module Actions - # Migrates an alias to a data stream + # Convert an index alias to a data stream # # @option arguments [String] :name The name of the alias to migrate # @option arguments [Time] :timeout Specify timeout for acknowledging the cluster state update # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-migrate-to-data-stream # def migrate_to_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.migrate_to_data_stream' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/modify_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/modify_data_stream.rb index a1778b1647..7b233b5da6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/modify_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/modify_data_stream.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Indices module Actions - # Modifies a data stream + # Update data streams # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The data stream modifications (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-modify-data-stream # def modify_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.modify_data_stream' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb index 61a51c9a58..8b98335eb4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Opens an index. + # Open a closed index # # @option arguments [List] :index A comma separated list of indices to open # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb index d9ad8c8fb9..046e248d54 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Indices module Actions - # Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + # Promote a data stream # # @option arguments [String] :name The name of the data stream # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-promote-data-stream # def promote_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.promote_data_stream' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb index 4422509ec3..0b9b228aaa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Creates or updates an alias. + # Create or update an alias # # @option arguments [List] :index A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. # @option arguments [String] :name The name of the alias to be created or updated @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The settings for the alias, such as `routing` or `filter` # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-aliases.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-put-alias # def put_alias(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.put_alias' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb index 039f533eda..f3636fef9c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Updates the data stream lifecycle of the selected data streams. + # Update data stream lifecycles # # @option arguments [List] :name A comma-separated list of data streams whose lifecycle will be updated; use `*` to set the lifecycle to all data streams # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The data stream lifecycle configuration that consist of the data retention # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams-put-lifecycle.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-put-data-lifecycle # def put_data_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.put_data_lifecycle' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb index 776bc3c563..4ef36f7dc0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Updates the data stream options of the selected data streams. + # Updates the data stream options of the selected data streams # # @option arguments [List] :name A comma-separated list of data streams whose options will be updated; use `*` to set the options to all data streams # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb index 12f0bb29ec..454defd8e9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Creates or updates an index template. + # Create or update an index template # # @option arguments [String] :name The name of the template # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The template definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-put-template.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-put-index-template # def put_index_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.put_index_template' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb index 98e2dfd6e8..bb02fee853 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Updates the index mappings. + # Update field mappings # # @option arguments [List] :index A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb index 388879eaca..63cf8fadf9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Updates the index settings. + # Update index settings # # @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 [Time] :master_timeout Specify timeout for connection to master diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb index dddcc32ff2..37407058d7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Creates or updates an index template. + # Create or update a legacy index template # # @option arguments [String] :name The name of the template # @option arguments [Number] :order The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb index ca0300de6c..ba12b93e08 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns information about ongoing index shard recoveries. + # Get index recovery information # # @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 [Boolean] :detailed Whether to display detailed information about shard recovery diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb index a5e089537b..a560c7ac9c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Performs the refresh operation in one or more indices. + # Refresh an index # # @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 [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb index 328bc29b52..694082818c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Reloads an index's search analyzers and their resources. + # Reload search analyzers # # @option arguments [List] :index A comma-separated list of index names to reload analyzers for # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb index 798ba54a00..ed06dc346f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Resolves the specified index expressions to return information about each cluster. If no index expression is provided, this endpoint will return information about all the remote clusters that are configured on the local cluster. + # Resolve the cluster # # @option arguments [List] :name A comma-separated list of cluster:index names or wildcard expressions # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb index 88be6346eb..61994fce66 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Returns information about any matching indices, aliases, and data streams + # Resolve indices # # @option arguments [List] :name A comma-separated list of names or wildcard expressions # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb index decc1060ba..000e8d1533 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb @@ -22,8 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Updates an alias to point to a new index when the existing index - # is considered to be too large or too old. + # Roll over to a new index # # @option arguments [String] :alias The name of the alias to rollover # @option arguments [String] :new_index The name of the rollover index diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb index 422b99d46f..518ae3ebb8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Provides low-level information about segments in a Lucene index. + # Get index segments # # @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 [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb index 719446ec6e..35579a4fee 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Provides store information for shard copies of indices. + # Get index shard stores # # @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] :status A comma-separated list of statuses used to filter on shards to get store information for (options: green, yellow, red, all) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb index 9950095ac6..07bdfabba6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Allow to shrink an existing index into a new index with fewer primary shards. + # Shrink an index # # @option arguments [String] :index The name of the source index to shrink # @option arguments [String] :target The name of the target index to shrink into diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb index 0550f04593..dc575ca509 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Simulate matching the given index name against the index templates in the system + # Simulate an index # # @option arguments [String] :name The name of the index (it must be a concrete index name) # @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb index 027e00a22b..95718a80cc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Simulate resolving the given template name or body + # Simulate an index template # # @option arguments [String] :name The name of the index template # @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb index 22a3c19e27..329f45810c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Allows you to split an existing index into a new index with more primary shards. + # Split an index # # @option arguments [String] :index The name of the source index to split # @option arguments [String] :target The name of the target index to split into diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb index 519bf2ecf1..ac6a27236e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Provides statistics on operations happening in an index. + # Get index statistics # # @option arguments [List] :metric Limit the information returned the specific metrics. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, bulk) # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb index 3c96a927ec..9883b21a61 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again. + # Unfreeze an index # # @option arguments [String] :index The name of the index to unfreeze # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb index bc7ebe2327..fa83b83f50 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Indices module Actions - # Updates index aliases. + # Create or update an alias # # @option arguments [Time] :timeout Request timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The definition of `actions` to perform (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-aliases.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-update-aliases # def update_aliases(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.update_aliases' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb index f61c8c2921..3365d66629 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Indices module Actions - # Allows a user to validate a potentially expensive query without executing it. + # Validate a query # # @option arguments [List] :index A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :explain Return detailed information about the error diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb index dd0881f0a0..070020b7e7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb @@ -28,7 +28,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The inference payload # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/chat-completion-inference.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/chat-completion-inference-api.html # def chat_completion_unified(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.chat_completion_unified' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb index 787383443d..909928be71 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Perform completion inference + # Perform completion inference on the service # # @option arguments [String] :inference_id The inference Id # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb index 14771bead2..788c753f43 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Perform inference + # Perform inference on the service # # @option arguments [String] :inference_id The inference Id # @option arguments [String] :task_type The task type diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb index 2e3e5911af..ff3d3613b2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure an inference endpoint for use in the Inference API + # Create an inference endpoint # # @option arguments [String] :inference_id The inference Id # @option arguments [String] :task_type The task type diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb index f958eaac58..17af7553fa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure an AlibabaCloud AI Search inference endpoint + # Create an AlibabaCloud AI Search inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :alibabacloud_inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb index 97f7f6607f..7a35148a18 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure an Amazon Bedrock inference endpoint + # Create an Amazon Bedrock inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :amazonbedrock_inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb index 9b5aa2aee7..ee767ac727 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Inference module Actions - # Configure a Amazon SageMaker inference endpoint + # Create an Amazon SageMaker inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :amazonsagemaker_inference_id The inference Id # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The inference endpoint's task and service settings # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-amazon-sagemaker.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-amazonsagemaker # def put_amazonsagemaker(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.put_amazonsagemaker' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb index 781aab2cc2..80997103f3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure an Anthropic inference endpoint + # Create an Anthropic inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :anthropic_inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb index 1e8bb9275a..2639a8d929 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure an Azure AI Studio inference endpoint + # Create an Azure AI studio inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :azureaistudio_inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb index 46bf98a79a..dd03ebe31c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure an Azure OpenAI inference endpoint + # Create an Azure OpenAI inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :azureopenai_inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb index 1f01aeea90..b244f39afe 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure a Cohere inference endpoint + # Create a Cohere inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :cohere_inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_custom.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_custom.rb index 51f3435223..be8c3faa04 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_custom.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_custom.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure a custom inference endpoint + # Create a custom inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :custom_inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_deepseek.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_deepseek.rb index 8a642b5d60..a8ecff6a19 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_deepseek.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_deepseek.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure a DeepSeek inference endpoint + # Create a DeepSeek inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :deepseek_inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb index 869fa8966d..230bdcdc79 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure an Elasticsearch inference endpoint + # Create an Elasticsearch inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :elasticsearch_inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb index 7cefbbd4f0..b59195c23b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure an ELSER inference endpoint + # Create an ELSER inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :elser_inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb index d8f5c30964..f93366fa1d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure a Google AI Studio inference endpoint + # Create an Google AI Studio inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :googleaistudio_inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb index 9b6808a8db..ddec4dfb62 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure a Google Vertex AI inference endpoint + # Create a Google Vertex AI inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :googlevertexai_inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb index 0d13feec56..e8afe712f0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure a HuggingFace inference endpoint + # Create a Hugging Face inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :huggingface_inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb index aeee6daa8d..b36c30e7c0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure a JinaAI inference endpoint + # Create an JinaAI inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :jinaai_inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb index 56efc361ba..a39e26b720 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure a Mistral inference endpoint + # Create a Mistral inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :mistral_inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb index 609c548f1b..09152c0921 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure an OpenAI inference endpoint + # Create an OpenAI inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :openai_inference_id The inference ID diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb index aec019e63b..06b2173169 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Inference module Actions - # Configure a VoyageAI inference endpoint + # Create a VoyageAI inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :voyageai_inference_id The inference ID # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The inference endpoint's task and service settings # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/inference-apis.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-voyageai.html # def put_voyageai(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.put_voyageai' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb index 132acdcf94..1baa54abc6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Configure a Watsonx inference endpoint + # Create a Watsonx inference endpoint # # @option arguments [String] :task_type The task type # @option arguments [String] :watsonx_inference_id The inference Id diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb index 1a899ca42e..990be7f70d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Perform reranking inference + # Perform reranking inference on the service # # @option arguments [String] :inference_id The inference Id # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb index 5e33dc2113..c7057ad250 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Perform sparse embedding inference + # Perform sparse embedding inference on the service # # @option arguments [String] :inference_id The inference Id # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb index 2a3cca56f6..699de09384 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Inference module Actions - # Perform streaming completion inference + # Perform streaming inference # # @option arguments [String] :inference_id The inference Id # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The inference payload # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/post-stream-inference-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/stream-inference-api.html # def stream_completion(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.stream_completion' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb index 7db5d326e9..ae93b8a118 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Perform text embedding inference + # Perform text embedding inference on the service # # @option arguments [String] :inference_id The inference Id # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb index 7aad34336d..11a5285239 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Update inference + # Update an inference endpoint # # @option arguments [String] :inference_id The inference Id # @option arguments [String] :task_type The task type diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/info.rb index 7def746106..0ed8ae279f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/info.rb @@ -21,11 +21,11 @@ module Elasticsearch module API module Actions - # Returns basic information about the cluster. + # Get cluster info # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/index.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/rest-api-root.html # def info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'info' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb index 6fa69ceb73..7e20dc549e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Ingest module Actions - # Deletes a geoip database configuration + # Delete GeoIP database configurations # # @option arguments [List] :id A comma-separated list of geoip database configurations to delete # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-geoip-database-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-delete-geoip-database # def delete_geoip_database(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.delete_geoip_database' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb index 53eca58811..2702fb3dd4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Ingest module Actions - # Deletes an ip location database configuration + # Delete IP geolocation database configurations # # @option arguments [List] :id A comma-separated list of ip location database configurations to delete # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb index ff0c65473e..702c7dc430 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Ingest module Actions - # Deletes a pipeline. + # Delete pipelines # # @option arguments [String] :id Pipeline ID # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb index 60e15ae9fc..0a584eb391 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Ingest module Actions - # Returns statistical information about geoip databases + # Get GeoIP statistics # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/geoip-stats-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/geoip-processor.html # def geo_ip_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.geo_ip_stats' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb index 32fd772469..6625a51eac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Ingest module Actions - # Returns geoip database configuration. + # Get GeoIP database configurations # # @option arguments [List] :id A comma-separated list of geoip database configurations to get; use `*` to get all geoip database configurations # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-geoip-database-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-get-geoip-database # def get_geoip_database(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.get_geoip_database' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb index 4c1d287a09..d0ead40b19 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Ingest module Actions - # Returns the specified ip location database configuration + # Get IP geolocation database configurations # # @option arguments [List] :id A comma-separated list of ip location database configurations to get; use `*` to get all ip location database configurations # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb index 65b3fa36a5..2167c7c425 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Ingest module Actions - # Returns a pipeline. + # Get pipelines # # @option arguments [String] :id Comma separated list of pipeline ids. Wildcards supported # @option arguments [Boolean] :summary Return pipelines without their definitions (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb index 1e24746ccd..5502c0b3eb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Ingest module Actions - # Returns a list of the built-in patterns. + # Run a grok processor # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/grok-processor.html#grok-processor-rest-get + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/grok-processor.html # def processor_grok(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.processor_grok' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb index 22ab67f26a..4e0e3ce687 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Ingest module Actions - # Puts the configuration for a geoip database to be downloaded + # Create or update a GeoIP database configuration # # @option arguments [String] :id The id of the database configuration # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The database configuration definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-geoip-database-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-put-geoip-database # def put_geoip_database(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.put_geoip_database' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb index 947fdedeeb..1651423548 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Ingest module Actions - # Puts the configuration for a ip location database to be downloaded + # Create or update an IP geolocation database configuration # # @option arguments [String] :id The id of the database configuration # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb index 97be41abe3..76aa156599 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Ingest module Actions - # Creates or updates a pipeline. + # Create or update a pipeline # # @option arguments [String] :id Pipeline ID # @option arguments [Integer] :if_version Required version for optimistic concurrency control for pipeline updates @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The ingest definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-pipeline-api.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ingest.html # def put_pipeline(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.put_pipeline' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb index b6508eb089..ec5536f6b3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Ingest module Actions - # Allows to simulate a pipeline with example documents. + # Simulate a pipeline # # @option arguments [String] :id Pipeline ID # @option arguments [Boolean] :verbose Verbose mode. Display data output for each processor in executed pipeline diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/knn_search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/knn_search.rb index 68f2c1923c..9848e0d82f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/knn_search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/knn_search.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Performs a kNN search. + # Run a knn search # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The search definition # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-search.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/knn-search-api.html # def knn_search(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'knn_search' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/delete.rb index 231924ce4b..cc9933bd84 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/delete.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module License module Actions - # Deletes licensing information for the cluster + # Delete the license # # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb index 547dd1ed7f..b4f60302ee 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module License module Actions - # Retrieves licensing information for the cluster + # Get license information # # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Boolean] :accept_enterprise Supported for backwards compatibility with 7.x. If this param is used it must be set to true *Deprecated* diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/get_basic_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/get_basic_status.rb index f8e1067b60..268c6f85e1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/get_basic_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/get_basic_status.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module License module Actions - # Retrieves information about the status of the basic license. + # Get the basic license status # # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/get_trial_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/get_trial_status.rb index 42adc48919..2dde16fecc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/get_trial_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/get_trial_status.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module License module Actions - # Retrieves information about the status of the trial license. + # Get the trial status # # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb index 194e0d81cb..60791c5807 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module License module Actions - # Updates the license for the cluster. + # Update the license # # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) # @option arguments [Time] :master_timeout Timeout for processing on master node @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body licenses to be installed # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-license.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-license-post # def post(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.post' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb index e9b5e15510..37a9ddaace 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module License module Actions - # Starts an indefinite basic license. + # Start a basic license # # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) # @option arguments [Time] :master_timeout Timeout for processing on master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb index e45eb6aff3..3fa672d7fd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module License module Actions - # starts a limited time trial license. + # Start a trial # # @option arguments [String] :type The type of trial license to generate (default: "trial") # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb index 91fd972606..68a8ec4547 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Logstash module Actions - # Deletes Logstash Pipelines used by Central Management + # Delete a Logstash pipeline # # @option arguments [String] :id The ID of the Pipeline # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb index 6828b70420..250b6974e1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Logstash module Actions - # Retrieves Logstash Pipelines used by Central Management + # Get Logstash pipelines # # @option arguments [String] :id A comma-separated list of Pipeline IDs # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb index 2ecd785284..6691fa2fb8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Logstash module Actions - # Adds and updates Logstash Pipelines used for Central Management + # Create or update a Logstash pipeline # # @option arguments [String] :id The ID of the Pipeline # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb index cb76c87d0b..9a86d2bccc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Clear the cached results from a trained model deployment + # Clear trained model deployment cache # # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb index 641020e7c9..f8ad22bad3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle. + # Close anomaly detection jobs # # @option arguments [String] :job_id The name of the job to close # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb index 5f6ce1b4d5..5e7aa155a3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes a calendar. + # Delete a calendar # # @option arguments [String] :calendar_id The ID of the calendar to delete # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb index 2221a53abc..e0c0b6f01f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes scheduled events from a calendar. + # Delete events from a calendar # # @option arguments [String] :calendar_id The ID of the calendar to modify # @option arguments [String] :event_id The ID of the event to remove from the calendar diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb index 6013536e36..897b9a6c4d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes anomaly detection jobs from a calendar. + # Delete anomaly jobs from a calendar # # @option arguments [String] :calendar_id The ID of the calendar to modify # @option arguments [String] :job_id The ID of the job to remove from the calendar diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb index 03201d6d2d..cc5aaa1664 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes an existing data frame analytics job. + # Delete a data frame analytics job # # @option arguments [String] :id The ID of the data frame analytics to delete # @option arguments [Boolean] :force True if the job should be forcefully deleted diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb index abfa820895..b1ee1dfd6d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes an existing datafeed. + # Delete a datafeed # # @option arguments [String] :datafeed_id The ID of the datafeed to delete # @option arguments [Boolean] :force True if the datafeed should be forcefully deleted diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb index 901544f8be..e6646d48b9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes expired and unused machine learning data. + # Delete expired ML data # # @option arguments [String] :job_id The ID of the job(s) to perform expired data hygiene for # @option arguments [Number] :requests_per_second The desired requests per second for the deletion processes. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb index 57aa13b96c..3cefdafe66 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes a filter. + # Delete a filter # # @option arguments [String] :filter_id The ID of the filter to delete # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb index aa5eda128a..cece5a628a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes forecasts from a machine learning job. + # Delete forecasts from a job # # @option arguments [String] :job_id The ID of the job from which to delete forecasts # @option arguments [String] :forecast_id The ID of the forecast to delete, can be comma delimited list. Leaving blank implies `_all` diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb index d959c9462b..3424c31cf9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes an existing anomaly detection job. + # Delete an anomaly detection job # # @option arguments [String] :job_id The ID of the job to delete # @option arguments [Boolean] :force True if the job should be forcefully deleted diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb index db28f80dc8..9d0e9babdd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes an existing model snapshot. + # Delete a model snapshot # # @option arguments [String] :job_id The ID of the job to fetch # @option arguments [String] :snapshot_id The ID of the snapshot to delete diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb index affbdb6647..a253a26952 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes an existing trained inference model that is currently not referenced by an ingest pipeline. + # Delete an unreferenced trained model # # @option arguments [String] :model_id The ID of the trained model to delete # @option arguments [Time] :timeout Controls the amount of time to wait for the model to be deleted. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb index 6980844cbb..8fa15fad72 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Deletes a model alias that refers to the trained model + # Delete a trained model alias # # @option arguments [String] :model_alias The trained model alias to delete # @option arguments [String] :model_id The trained model where the model alias is assigned diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb index 3ac076a99b..da4a38333b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module MachineLearning module Actions - # Estimates the model memory + # Estimate job model memory usage # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The analysis config, plus cardinality estimates for fields it references (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-apis.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-estimate-model-memory.html # def estimate_model_memory(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.estimate_model_memory' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb index 5203964e2c..1a5e11c387 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Evaluates the data frame analytics for an annotated index. + # Evaluate data frame analytics # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The evaluation definition (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb index b3ff232dac..9cc8c88019 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Explains a data frame analytics config. + # Explain data frame analytics config # # @option arguments [String] :id The ID of the data frame analytics to explain # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The data frame analytics config to explain # - # @see http://www.elastic.co/guide/en/elasticsearch/reference/8.19/explain-dfanalytics.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/explain-dfanalytics.html # def explain_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.explain_data_frame_analytics' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb index 74bc2c2c78..3984045e43 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Forces any buffered data to be processed by the job. + # Force buffered data to be processed # # @option arguments [String] :job_id The name of the job to flush # @option arguments [Boolean] :calc_interim Calculates interim results for the most recent bucket or all buckets within the latency period diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb index 1f3779bcb9..4c61670981 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Predicts the future behavior of a time series by using its historical behavior. + # Predict future behavior of a time series # # @option arguments [String] :job_id The ID of the job to forecast for # @option arguments [Time] :duration The duration of the forecast diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb index 3737957855..c1535ff9e1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves anomaly detection job results for one or more buckets. + # Get anomaly detection job results for buckets # # @option arguments [String] :job_id ID of the job to get bucket results from # @option arguments [String] :timestamp The timestamp of the desired single bucket result diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb index ebab594e14..a92baad35b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves information about the scheduled events in calendars. + # Get info about events in calendars # # @option arguments [String] :calendar_id The ID of the calendar containing the events # @option arguments [String] :job_id Get events for the job. When this option is used calendar_id must be '_all' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb index b6480375c9..5af3cdfd04 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves configuration information for calendars. + # Get calendar configuration info # # @option arguments [String] :calendar_id The ID of the calendar to fetch # @option arguments [Integer] :from skips a number of calendars diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb index 40d7ee266d..c6c047abf6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves anomaly detection job results for one or more categories. + # Get anomaly detection job results for categories # # @option arguments [String] :job_id The name of the job # @option arguments [Long] :category_id The identifier of the category definition of interest diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb index bdb595f07e..ef5ade3a69 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves configuration information for data frame analytics jobs. + # Get data frame analytics job configuration info # # @option arguments [String] :id The ID of the data frame analytics to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb index 0b8381758a..996cee8c8f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves usage information for data frame analytics jobs. + # Get data frame analytics job stats # # @option arguments [String] :id The ID of the data frame analytics stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb index 316e5b1124..210cc59235 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves usage information for datafeeds. + # Get datafeed stats # # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb index 0d48e2e70b..df8e357671 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves configuration information for datafeeds. + # Get datafeeds configuration info # # @option arguments [String] :datafeed_id The ID of the datafeeds to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb index 89d4bb8ec7..3128814fef 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves filters. + # Get filters # # @option arguments [String] :filter_id The ID of the filter to fetch # @option arguments [Integer] :from skips a number of filters diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb index 249db808e2..f029b90134 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves anomaly detection job results for one or more influencers. + # Get anomaly detection job results for influencers # # @option arguments [String] :job_id Identifier for the anomaly detection job # @option arguments [Boolean] :exclude_interim Exclude interim results diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb index 2d1bc42206..6ed150cad4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves usage information for anomaly detection jobs. + # Get anomaly detection job stats # # @option arguments [String] :job_id The ID of the jobs stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb index 352d05c9ba..3c531a1c77 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves configuration information for anomaly detection jobs. + # Get anomaly detection jobs configuration info # # @option arguments [String] :job_id The ID of the jobs to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb index f2142bc6b3..8bab10d9e9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Returns information on how ML is using memory. + # Get machine learning memory usage info # # @option arguments [String] :node_id Specifies the node or nodes to retrieve stats for. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb index b98e80dbc5..d5793af9b7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Gets stats for anomaly detection job model snapshot upgrades that are in progress. + # Get anomaly detection job model snapshot upgrade usage info # # @option arguments [String] :job_id The ID of the job. May be a wildcard, comma separated list or `_all`. # @option arguments [String] :snapshot_id The ID of the snapshot. May be a wildcard, comma separated list or `_all`. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb index d6526ef53c..7239661dee 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves information about model snapshots. + # Get model snapshots info # # @option arguments [String] :job_id The ID of the job to fetch # @option arguments [String] :snapshot_id The ID of the snapshot to fetch diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb index 1ffe1a7174..9246810496 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs. + # Get overall bucket results # # @option arguments [String] :job_id The job IDs for which to calculate overall bucket results # @option arguments [Integer] :top_n The number of top job bucket scores to be used in the overall_score calculation diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb index d821788a05..660b12ffb4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves anomaly records for an anomaly detection job. + # Get anomaly records for an anomaly detection job # # @option arguments [String] :job_id The ID of the job # @option arguments [Boolean] :exclude_interim Exclude interim results diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb index ada15b8fdb..c3d79b2327 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves configuration information for a trained inference model. + # Get trained model configuration info # # @option arguments [String] :model_id The ID of the trained models to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb index be4e975e47..75161d2787 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Retrieves usage information for trained inference models. + # Get trained models usage info # # @option arguments [String] :model_id The ID of the trained models stats to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb index d32e53951b..e6db0ebd02 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Evaluate a trained model. + # Evaluate a trained model # # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) # @option arguments [Time] :timeout Controls the amount of time to wait for inference results. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/info.rb index f48eaa03ee..1b965d70a0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/info.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Returns defaults and limits used by machine learning. + # Get machine learning information # # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb index 9085416510..b436235a04 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Opens one or more anomaly detection jobs. + # Open anomaly detection jobs # # @option arguments [String] :job_id The ID of the job to open # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb index 00de6a1897..1a1f63e1ea 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Posts scheduled events in a calendar. + # Add scheduled events to the calendar # # @option arguments [String] :calendar_id The ID of the calendar to modify # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb index f59d9dd3d0..bf4675af9a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Sends data to an anomaly detection job for analysis. + # Send data to an anomaly detection job for analysis # # @option arguments [String] :job_id The name of the job receiving the data # @option arguments [String] :reset_start Optional parameter to specify the start of the bucket resetting range diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb index bf7f6da6ab..c458251b30 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Previews that will be analyzed given a data frame analytics config. + # Preview features used by data frame analytics # # @option arguments [String] :id The ID of the data frame analytics to preview # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The data frame analytics config to preview # - # @see http://www.elastic.co/guide/en/elasticsearch/reference/8.19/preview-dfanalytics.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/preview-dfanalytics.html # def preview_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.preview_data_frame_analytics' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb index a0c766ee4d..2e8cbbd18c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Previews a datafeed. + # Preview a datafeed # # @option arguments [String] :datafeed_id The ID of the datafeed to preview # @option arguments [String] :start The start time from where the datafeed preview should begin diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb index d55a8bc2af..bcb7281274 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Instantiates a calendar. + # Create a calendar # # @option arguments [String] :calendar_id The ID of the calendar to create # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb index 365a88f2b8..9047d4dcf8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Adds an anomaly detection job to a calendar. + # Add anomaly detection job to calendar # # @option arguments [String] :calendar_id The ID of the calendar to modify # @option arguments [String] :job_id The ID of the job to add to the calendar diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb index 0688c470c9..d03b0ea3d0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Instantiates a data frame analytics job. + # Create a data frame analytics job # # @option arguments [String] :id The ID of the data frame analytics to create # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb index 6f0dae3d40..c6e8eed628 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Instantiates a datafeed. + # Create a datafeed # # @option arguments [String] :datafeed_id The ID of the datafeed to create # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb index 7583193778..6dd6e4a832 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Instantiates a filter. + # Create a filter # # @option arguments [String] :filter_id The ID of the filter to create # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb index 488b08083d..e99e57f2f0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Instantiates an anomaly detection job. + # Create an anomaly detection job # # @option arguments [String] :job_id The ID of the job to create # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false). Only set if datafeed_config is provided. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb index e22c4f6d49..379041679e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Creates an inference trained model. + # Create a trained model # # @option arguments [String] :model_id The ID of the trained models to store # @option arguments [Boolean] :defer_definition_decompression If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb index 3b25e0cd30..43a177eca7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Creates a new model alias (or reassigns an existing one) to refer to the trained model + # Create or update a trained model alias # # @option arguments [String] :model_alias The trained model alias to update # @option arguments [String] :model_id The trained model where the model alias should be assigned diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb index 05bb426da1..d3e833948f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Creates part of a trained model definition + # Create part of a trained model definition # # @option arguments [String] :model_id The ID of the trained model for this definition part # @option arguments [Integer] :part The part number diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb index 15d5de17f4..81ef4032b1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Creates a trained model vocabulary + # Create a trained model vocabulary # # @option arguments [String] :model_id The ID of the trained model for this vocabulary # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb index 34c2c3a0ad..9381b47509 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Resets an existing anomaly detection job. + # Reset an anomaly detection job # # @option arguments [String] :job_id The ID of the job to reset # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb index 508b3a0756..884bcd5ca2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Reverts to a specific snapshot. + # Revert to a snapshot # # @option arguments [String] :job_id The ID of the job to fetch # @option arguments [String] :snapshot_id The ID of the snapshot to revert to diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb index e479807a04..77f0e9f0bc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. + # Set upgrade_mode for ML indices # # @option arguments [Boolean] :enabled Whether to enable upgrade_mode ML setting or not. Defaults to false. # @option arguments [Time] :timeout Controls the time to wait before action times out. Defaults to 30 seconds diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb index 752692ce95..c7679ed5c4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Starts a data frame analytics job. + # Start a data frame analytics job # # @option arguments [String] :id The ID of the data frame analytics to start # @option arguments [Time] :timeout Controls the time to wait until the task has started. Defaults to 20 seconds diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb index 94228f2d56..5ac64e54ce 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Starts one or more datafeeds. + # Start datafeeds # # @option arguments [String] :datafeed_id The ID of the datafeed to start # @option arguments [String] :start The start time from where the datafeed should begin diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb index a0c61bc6f5..82bf05ba54 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Start a trained model deployment. + # Start a trained model deployment # # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) # @option arguments [String] :cache_size A byte-size value for configuring the inference cache size. For example, 20mb. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb index a00255b7aa..56e627752f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Stops one or more data frame analytics jobs. + # Stop data frame analytics jobs # # @option arguments [String] :id The ID of the data frame analytics to stop # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb index 00a8fae582..416856a295 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Stops one or more datafeeds. + # Stop datafeeds # # @option arguments [String] :datafeed_id The ID of the datafeed to stop # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb index 569abec433..c72734201b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Stop a trained model deployment. + # Stop a trained model deployment # # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no deployments. (This includes `_all` string or when no deployments have been specified) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb index 63f22f6842..27ed528f66 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module MachineLearning module Actions - # Updates certain properties of a data frame analytics job. + # Update a data frame analytics job # # @option arguments [String] :id The ID of the data frame analytics to update # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The data frame analytics settings to update (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-dfanalytics.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ml-update-data-frame-analytics # def update_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.update_data_frame_analytics' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb index e2504ee7e6..a8e29e49ea 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Updates certain properties of a datafeed. + # Update a datafeed # # @option arguments [String] :datafeed_id The ID of the datafeed to update # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb index 1e3d5fb84f..9765fcc9f3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Updates the description of a filter, adds items, or removes items. + # Update a filter # # @option arguments [String] :filter_id The ID of the filter to update # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb index 867bf0272f..e8b4c2b4e0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Updates certain properties of an anomaly detection job. + # Update an anomaly detection job # # @option arguments [String] :job_id The ID of the job to create # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb index 2e7d2bbb3c..a3eb572bd7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Updates certain properties of a snapshot. + # Update a snapshot # # @option arguments [String] :job_id The ID of the job to fetch # @option arguments [String] :snapshot_id The ID of the snapshot to update diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb index 926aca7199..2dd9307dc5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module MachineLearning module Actions - # Updates certain properties of trained model deployment. + # Update a trained model deployment # # @option arguments [String] :model_id The unique identifier of the trained model. # @option arguments [Integer] :number_of_allocations Update the model deployment to this number of allocations. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The updated trained model deployment settings # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-trained-model-deployment.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ml-update-trained-model-deployment # def update_trained_model_deployment(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.update_trained_model_deployment' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb index ac694af534..64913a4c8c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Upgrades a given job snapshot to the current major version. + # Upgrade a snapshot # # @option arguments [String] :job_id The ID of the job # @option arguments [String] :snapshot_id The ID of the snapshot diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/validate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/validate.rb index 0ff2efd891..fd904576da 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/validate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/validate.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module MachineLearning module Actions - # Validates an anomaly detection job. + # Validate an anomaly detection job # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The job config (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/validate_detector.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/validate_detector.rb index 58cc720861..96b73afbd9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/validate_detector.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/validate_detector.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module MachineLearning module Actions - # Validates an anomaly detection detector. + # Validate an anomaly detection job # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The detector (*Required*) # - # @see https://www.elastic.co/guide/en/machine-learning/8.19/ml-jobs.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8 # def validate_detector(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.validate_detector' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb b/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb index 8692a4b3a0..7b9d777b73 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Allows to get multiple documents in one request. + # Get multiple documents # # @option arguments [String] :index The name of the index # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb b/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb index f70df131d2..10d3304f9b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Migration module Actions - # Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. + # Get deprecation information # # @option arguments [String] :index Index pattern # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb index b58fc60caf..ad535a83c8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Migration module Actions - # Find out whether system features need to be upgraded or not + # Get feature migration information # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/migration-api-feature-upgrade.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/feature-migration-api.html # def get_feature_upgrade_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'migration.get_feature_upgrade_status' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb b/elasticsearch-api/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb index fcefb2d563..d6b7e316db 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module Migration module Actions - # Begin upgrades for system features + # Start the feature migration # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/migration-api-feature-upgrade.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/feature-migration-api.html # def post_feature_upgrade(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'migration.post_feature_upgrade' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb b/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb index f5dccd2da4..4e55791c44 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Monitoring module Actions - # Used by the monitoring features to send monitoring data. + # Send monitoring data # # @option arguments [String] :type Default document type for items which don't provide one *Deprecated* # @option arguments [String] :system_id Identifier of the monitored system @@ -37,7 +37,7 @@ module Actions # Deprecated since version 7.0.0 # # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/monitor-elasticsearch-cluster.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8 # def bulk(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'monitoring.bulk' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb index 12c33f1bad..78924a711d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb @@ -21,13 +21,13 @@ module Elasticsearch module API module Actions - # Allows to execute several search operations in one request. + # Run multiple searches # # @option arguments [List] :index A comma-separated list of index names to use as default # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response - # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. + # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb index ae49cacf2d..063a986ead 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Allows to execute several search template operations in one request. + # Run multiple templated searches # # @option arguments [List] :index A comma-separated list of index names to use as default # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) @@ -32,7 +32,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-multi-search.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/multi-search-template.html # def msearch_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'msearch_template' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb b/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb index 6dae587944..a91b7c6afb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns multiple termvectors in one request. + # Get multiple term vectors # # @option arguments [String] :index The index in which the document resides. # @option arguments [List] :ids A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb index 8ff0da159c..9409b59df0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Nodes module Actions - # Removes the archived repositories metering information present in the cluster. + # Clear the archived repositories metering # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb index 639b7bb86b..12ebbd912c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Nodes module Actions - # Returns cluster repositories metering information. + # Get cluster repositories metering # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb index 812e74a283..397dcabaf9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Nodes module Actions - # Returns information about hot threads on each node in the cluster. + # Get the hot threads for nodes # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes # @option arguments [Time] :interval The interval for the second sampling of threads diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb index 8546bf6748..f1ff1930e5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Nodes module Actions - # Returns information about nodes in the cluster. + # Get node information # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes # @option arguments [List] :metric A comma-separated list of metrics you wish returned. Use `_all` to retrieve all metrics and `_none` to retrieve the node identity without any additional metrics. (options: settings, os, process, jvm, thread_pool, transport, http, plugins, ingest, indices, aggregations, _all, _none) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb index d4531be8df..681e64c43f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Nodes module Actions - # Reloads secure settings. + # Reload the keystore on nodes in the cluster # # @option arguments [List] :node_id A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes. # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An object containing the password for the elasticsearch keystore # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/secure-settings.html#reloadable-secure-settings + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-nodes-reload-secure-settings.html # def reload_secure_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'nodes.reload_secure_settings' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb index 74de48dab2..410ad99353 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Nodes module Actions - # Returns statistical information about nodes in the cluster. + # Get node statistics # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, breaker, fs, http, indices, jvm, os, process, thread_pool, transport, discovery, indexing_pressure) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb index c6dff35e6c..02c40d808d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Nodes module Actions - # Returns low-level information about REST actions usage on nodes. + # Get feature usage information # # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, rest_actions) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb b/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb index f1a001f339..7e86a0b8a1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Open a point in time that can be used in subsequent searches + # Open a point in time # # @option arguments [List] :index A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ping.rb index af476f97c7..a9bc325c35 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ping.rb @@ -21,11 +21,11 @@ module Elasticsearch module API module Actions - # Returns whether the cluster is running. + # Ping the cluster # # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/index.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster.html # def ping(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ping' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/flamegraph.rb b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/flamegraph.rb index 00f154fdfa..3053d0e846 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/flamegraph.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/flamegraph.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Profiling module Actions - # Extracts a UI-optimized structure to render flamegraphs from Universal Profiling. + # Extracts a UI-optimized structure to render flamegraphs from Universal Profiling # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The filter conditions for the flamegraph (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/stacktraces.rb b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/stacktraces.rb index 60f350366f..59ab3fc9ba 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/stacktraces.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/stacktraces.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Profiling module Actions - # Extracts raw stacktrace information from Universal Profiling. + # Extracts raw stacktrace information from Universal Profiling # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The filter conditions for stacktraces (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/status.rb index 0a0e27cc9f..028a19da66 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/status.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Profiling module Actions - # Returns basic information about the status of Universal Profiling. + # Returns basic information about the status of Universal Profiling # # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/topn_functions.rb b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/topn_functions.rb index 1b23442f24..88886c5c48 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/topn_functions.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/topn_functions.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Profiling module Actions - # Extracts a list of topN functions from Universal Profiling. + # Extracts a list of topN functions from Universal Profiling # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The filter conditions for stacktraces (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb index 73ddd072d4..f23ac09c2d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Creates or updates a script. + # Create or update a script or search template # # @option arguments [String] :id Script ID # @option arguments [String] :context Script context @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The document (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-scripting.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/create-stored-script-api.html # def put_script(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'put_script' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_rule.rb index 26ad9e0e8e..0d000d272d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_rule.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module QueryRules module Actions - # Deletes an individual query rule within a ruleset. + # Delete a query rule # # @option arguments [String] :ruleset_id The unique identifier of the query ruleset this rule exists in # @option arguments [String] :rule_id The unique identifier of the rule to delete. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb index d817ddca69..857150a02d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module QueryRules module Actions - # Deletes a query ruleset. + # Delete a query ruleset # # @option arguments [String] :ruleset_id The unique identifier of the query ruleset to delete # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_rule.rb index 3419f28b79..cef54b4557 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_rule.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module QueryRules module Actions - # Returns the details about an individual query rule within a ruleset. + # Get a query rule # # @option arguments [String] :ruleset_id The unique identifier of the query ruleset the rule exists within # @option arguments [String] :rule_id The unique identifier of the rule to be retrieved. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb index 2a6d976064..d2e08f6004 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module QueryRules module Actions - # Returns the details about a query ruleset. + # Get a query ruleset # # @option arguments [String] :ruleset_id The unique identifier of the query ruleset # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb index feeb204201..cab2036256 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module QueryRules module Actions - # Lists query rulesets. + # Get all query rulesets # # @option arguments [Integer] :from Starting offset (default: 0) # @option arguments [Integer] :size specifies a max number of results to get (default: 100) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_rule.rb index 5efbe58264..d23c5cde36 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_rule.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module QueryRules module Actions - # Creates or updates a query rule within a ruleset. + # Create or update a query rule # # @option arguments [String] :ruleset_id The unique identifier of the ruleset this rule should be added to. The ruleset will be created if it does not exist. # @option arguments [String] :rule_id The unique identifier of the rule to be created or updated. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb index 7b6c231eb2..3d191690f1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module QueryRules module Actions - # Creates or updates a query ruleset. + # Create or update a query ruleset # # @option arguments [String] :ruleset_id The unique identifier of the ruleset to be created or updated. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/test.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/test.rb index dba8b8922a..43e2b6af70 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/test.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/test.rb @@ -22,11 +22,7 @@ module Elasticsearch module API module QueryRules module Actions - # Tests a query ruleset to identify the rules that would match input criteria - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Test a query ruleset # # @option arguments [String] :ruleset_id The unique identifier of the ruleset to test. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb index 3bd2c902c9..c7bf9a7da4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Allows to evaluate the quality of ranked search results over a set of typical search queries + # Evaluate ranked search results # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb index 4e3143edb4..daa3836955 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb @@ -21,9 +21,7 @@ module Elasticsearch module API module Actions - # Allows to copy documents from one index to another, optionally filtering the source - # documents by a query, changing the destination index settings, or fetching the - # documents from a remote cluster. + # Reindex documents # # @option arguments [Boolean] :refresh Should the affected indexes be refreshed? # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb index b9feac026d..e728f8d5c8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Changes the number of requests per second for a particular Reindex operation. + # Throttle a reindex operation # # @option arguments [String] :task_id The task id to rethrottle # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb index bbe1ca78ef..ea5ab53e44 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Allows to use the Mustache language to pre-render a search definition. + # Render a search template # # @option arguments [String] :id The id of the stored search template # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/delete_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/delete_job.rb index 3f46aaae31..566145925d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/delete_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/delete_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Rollup module Actions - # Deletes an existing rollup job. + # Delete a rollup job # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_jobs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_jobs.rb index 379d1940b4..9f3eff2691 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_jobs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_jobs.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Rollup module Actions - # Retrieves the configuration, stats, and status of rollup jobs. + # Get rollup job information # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_caps.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_caps.rb index 974237b97a..ccf2dfaba1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_caps.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_caps.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Rollup module Actions - # Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + # Get the rollup job capabilities # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_index_caps.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_index_caps.rb index 554e7ad6b0..62528ac2df 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_index_caps.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_index_caps.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Rollup module Actions - # Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored). + # Get the rollup index capabilities # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/put_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/put_job.rb index 87ed067882..5a61278db9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/put_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/put_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Rollup module Actions - # Creates a rollup job. + # Create a rollup job # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/rollup_search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/rollup_search.rb index e41ca1f100..cc09c06856 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/rollup_search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/rollup_search.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Rollup module Actions - # Enables searching rolled-up data using the standard query DSL. + # Search rolled-up data # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/start_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/start_job.rb index 12baf5e770..e94cbc4d5a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/start_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/start_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Rollup module Actions - # Starts an existing, stopped rollup job. + # Start rollup jobs # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/stop_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/stop_job.rb index d3299e2a73..b1f7d5a7c3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/stop_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/stop_job.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Rollup module Actions - # Stops an existing, started rollup job. + # Stop rollup jobs # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb b/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb index 5d4fd3014e..cb0b9a852e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Allows an arbitrary script to be executed and a result to be returned + # Run a script # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb b/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb index 177b287f75..37caf871aa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Allows to retrieve a large numbers of results from a single search request. + # Run a scrolling search # # @option arguments [String] :scroll_id The scroll ID *Deprecated* # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search @@ -34,7 +34,7 @@ module Actions # Deprecated since version 7.0.0 # # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-request-body.html#request-body-search-scroll + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/scroll-api.html # def scroll(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'scroll' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb index b7c7176f6e..eaa1350f7d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns results matching a query. + # Run a search # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [String] :analyzer The analyzer to use for the query string @@ -65,7 +65,7 @@ module Actions # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting # @option arguments [Number] :batched_reduce_size The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests - # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. + # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response # @option arguments [String] :min_compatible_shard_node The minimum compatible version that all shards involved in search should have for this request to be successful # @option arguments [Boolean] :include_named_queries_score Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete.rb index 19c7f09f30..8d1fcd206a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module SearchApplication module Actions - # Deletes a search application. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Delete a search application + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :name The name of the search application # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb index c338e587b7..da6eb33dc5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SearchApplication module Actions - # Delete a behavioral analytics collection. + # Delete a behavioral analytics collection # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get.rb index ca043c958b..2207c84820 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module SearchApplication module Actions - # Returns the details about a search application. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Get search application details + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :name The name of the search application # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb index 2394845cf0..a82c857bac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SearchApplication module Actions - # Returns the existing behavioral analytics collections. + # Get behavioral analytics collections # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/list.rb index 01173079dc..91d3e4bee6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/list.rb @@ -22,18 +22,18 @@ module Elasticsearch module API module SearchApplication module Actions - # Returns the existing search applications. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Get search applications + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :q Query in the Lucene query string syntax # @option arguments [Integer] :from Starting offset (default: 0) # @option arguments [Integer] :size specifies a max number of results to get # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/list-search-applications.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/list-analytics-collection.html # def list(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.list' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb index 73ddcf543e..6899ee4f44 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SearchApplication module Actions - # Creates a behavioral analytics event for existing collection. + # Create a behavioral analytics collection event # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -34,7 +34,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The event definition (*Required*) # - # @see http://todo.com/tbd + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/post-analytics-collection-event.html # def post_behavioral_analytics_event(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.post_behavioral_analytics_event' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put.rb index cd9b35c83a..589dfc7b44 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module SearchApplication module Actions - # Creates or updates a search application. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Create or update a search application + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :name The name of the search application to be created or updated # @option arguments [Boolean] :create If true, requires that a search application with the specified resource_id does not already exist. (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb index a187eca0e9..2bee403078 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SearchApplication module Actions - # Creates a behavioral analytics collection. + # Create a behavioral analytics collection # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/render_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/render_query.rb index c20901495c..73583f4f7b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/render_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/render_query.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SearchApplication module Actions - # Renders a query for given search application search parameters + # Render a search application query # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/search.rb index c1b269a0a6..eda911efbd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/search.rb @@ -22,11 +22,11 @@ module Elasticsearch module API module SearchApplication module Actions - # Perform a search against a search application - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Run a search application search + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [String] :name The name of the search application to be searched # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb index 291f7d1aa7..15d859123e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb @@ -21,11 +21,7 @@ module Elasticsearch module API module Actions - # Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile. - # This functionality is Experimental and may be changed or removed - # completely in a future release. Elastic will take a best effort approach - # to fix any issues, but experimental features are not subject to the - # support SLA of official GA features. + # Search a vector tile # # @option arguments [List] :index Comma-separated list of data streams, indices, or aliases to search # @option arguments [String] :field Field containing geospatial data to return diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb index b377bedd34..51d00d3112 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns information about the indices and shards that a search request would be executed against. + # Get the search shards # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb index cbc21165c2..c34c0d9f8e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Allows to use the Mustache language to pre-render a search definition. + # Run a search with a search template # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -40,7 +40,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The search definition template and its params (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-template.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-template-api.html # def search_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_template' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb index b7da357cd3..12dd2ebd42 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SearchableSnapshots module Actions - # Retrieve node-level cache statistics about searchable snapshots. + # Get cache statistics # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the @@ -31,7 +31,7 @@ module Actions # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-apis.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-api-cache-stats.html # def cache_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.cache_stats' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb index 097b6b91da..ede1b5c096 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb @@ -28,13 +28,13 @@ module Actions # to fix any issues, but experimental features are not subject to the # support SLA of official GA features. # - # @option arguments [List] :index A comma-separated list of index names + # @option arguments [List] :index Clear the cache # @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 [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-apis.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-api-clear-cache.html # def clear_cache(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.clear_cache' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb index 62025abbf6..5273da36b4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SearchableSnapshots module Actions - # Mount a snapshot as a searchable index. + # Mount a snapshot # # @option arguments [String] :repository The name of the repository containing the snapshot of the index to mount # @option arguments [String] :snapshot The name of the snapshot of the index to mount diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb index ca8948ab46..627c902ffc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module SearchableSnapshots module Actions - # Retrieve shard-level statistics about searchable snapshots. + # Get searchable snapshot statistics # # @option arguments [List] :index A comma-separated list of index names # @option arguments [String] :level Return stats aggregated at cluster, index or shard level (options: cluster, indices, shards) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-apis.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-api-stats.html # def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.stats' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/activate_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/activate_user_profile.rb index 718ab960fc..4cc6a1e155 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/activate_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/activate_user_profile.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Creates or updates the user profile on behalf of another user. + # Activate a user profile # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The grant type and user's credential (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/authenticate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/authenticate.rb index f7be3e180c..62cc281bf4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/authenticate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/authenticate.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Enables authentication as a user and retrieve information about the authenticated user. + # Authenticate a user # # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_delete_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_delete_role.rb index e436b23452..b6928b010d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_delete_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_delete_role.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Bulk delete roles in the native realm. + # Bulk delete roles # # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_put_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_put_role.rb index acb4b1e719..efac4848b3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_put_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_put_role.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Bulk adds and updates roles in the native realm. + # Bulk create or update roles # # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb index 6a85256ac1..240f84b039 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Updates the attributes of multiple existing API keys. + # Bulk update API keys # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The API key request to update the attributes of multiple API keys. (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb index b5b0bc3825..47fbfdef89 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Changes the passwords of users in the native realm and built-in users. + # Change passwords # # @option arguments [String] :username The username of the user to change the password for # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. (options: true, false, wait_for) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb index 5cab032b6a..33d419f71a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Clear a subset or all entries from the API key cache. + # Clear the API key cache # # @option arguments [List] :ids A comma-separated list of IDs of API keys to clear from the cache # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb index 792bc94f3a..f795c20ad3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Evicts application privileges from the native application privileges cache. + # Clear the privileges cache # # @option arguments [List] :application A comma-separated list of application names # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb index b75450023a..4d4dc06e98 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Evicts users from the user cache. Can completely clear the cache or evict specific users. + # Clear the user cache # # @option arguments [List] :realms Comma-separated list of realms to clear # @option arguments [List] :usernames Comma-separated list of usernames to clear from the cache diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb index 632f210fe3..8b07edb1eb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Evicts roles from the native role cache. + # Clear the roles cache # # @option arguments [List] :name Role name # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb index 95315a1065..a5aadec0a6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Evicts tokens from the service account token caches. + # Clear service account token caches # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb index 63b22a7c07..7d409f7428 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Creates an API key for access without requiring basic authentication. + # Create an API key # # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb index 957c280d2d..5cf0d66261 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Creates a cross-cluster API key for API key based remote cluster access. + # Create a cross-cluster API key # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The request to create a cross-cluster API key (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb index 62aaad6404..78ca0dd203 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Creates a service account token for access without requiring basic authentication. + # Create a service account token # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delegate_pki.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delegate_pki.rb index 3b961ef089..ddf9f8b0ce 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delegate_pki.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delegate_pki.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Delegate PKI authentication. + # Delegate PKI authentication # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The X509Certificate chain. (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb index a66dcff300..cfd16c6c48 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Removes application privileges. + # Delete application privileges # # @option arguments [String] :application Application name # @option arguments [String] :name Privilege name diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb index 317a4d2e1f..7cd068f53d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Removes roles in the native realm. + # Delete roles # # @option arguments [String] :name Role name # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. (options: true, false, wait_for) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb index c4d057d5b9..c4f119e49c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Removes role mappings. + # Delete role mappings # # @option arguments [String] :name Role-mapping name # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. (options: true, false, wait_for) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb index b02f80926d..550dfcc4b8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Deletes a service account token. + # Delete service account tokens # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb index b4521a43ce..6725b4e697 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Deletes users from the native realm. + # Delete users # # @option arguments [String] :username username # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. (options: true, false, wait_for) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb index 6954f5a4fd..170b5946a2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Disables users in the native realm. + # Disable users # # @option arguments [String] :username The username of the user to disable # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. (options: true, false, wait_for) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb index d77fb1865b..2312b47575 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Disables a user profile so it's not visible in user profile searches. + # Disable a user profile # # @option arguments [String] :uid Unique identifier for the user profile # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb index 050b78824b..8d9f172d7a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Enables users in the native realm. + # Enable users # # @option arguments [String] :username The username of the user to enable # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. (options: true, false, wait_for) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb index a356d5484d..ff66f1a5f4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Enables a user profile so it's visible in user profile searches. + # Enable a user profile # # @option arguments [String] :uid An unique identifier of the user profile # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_kibana.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_kibana.rb index d6b37730e8..10909fc4d5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_kibana.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_kibana.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster. + # Enroll Kibana # # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_node.rb index af2f1be05f..df69fc5734 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_node.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_node.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Allows a new node to enroll to an existing cluster with security enabled. + # Enroll a node # # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb index 965797ed8c..e5bb9d02f0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Retrieves information for one or more API keys. + # Get API key information # # @option arguments [String] :id API key id of the API key to be retrieved # @option arguments [String] :name API key name of the API key to be retrieved diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb index 8281d329ff..01db8a6211 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + # Get builtin privileges # # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb index ef143f4e1d..5883f0ab5b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Retrieves application privileges. + # Get application privileges # # @option arguments [String] :application Application name # @option arguments [String] :name Privilege name diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb index bbf0c847ed..a99796dd0c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Retrieves roles in the native realm. + # Get roles # # @option arguments [List] :name A comma-separated list of role names # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb index a501f36671..afb0cb8536 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Retrieves role mappings. + # Get role mappings # # @option arguments [List] :name A comma-separated list of role-mapping names # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb index 1bbe0374cf..07091d000c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Retrieves information about service accounts. + # Get service accounts # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb index 9618ee4461..a7e356f6f5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Retrieves information of all service credentials for a service account. + # Get service account credentials # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_settings.rb index 9084911989..7887cc0f99 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_settings.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Retrieve settings for the security system indices + # Get security index settings # # @option arguments [Time] :master_timeout Timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_token.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_token.rb index 7edfe4817d..fdb623745e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_token.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Creates a bearer token for access without requiring basic authentication. + # Get a token # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The token request to get (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb index f6a910c921..aa4ff49d18 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Retrieves information about users in the native realm and built-in users. + # Get users # # @option arguments [List] :username A comma-separated list of usernames # @option arguments [Boolean] :with_profile_uid flag to retrieve profile uid (if exists) associated to the user diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb index 069910fe21..e02f0a15f6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Retrieves security privileges for the logged in user. + # Get user privileges # # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb index 70ca47f466..db4293aa13 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Retrieves user profiles for the given unique ID(s). + # Get a user profile # # @option arguments [List] :uid A comma-separated list of unique identifier for user profiles # @option arguments [List] :data A comma-separated list of keys for which the corresponding application data are retrieved. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb index 41052908b6..c50294cc0f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Creates an API key on behalf of another user. + # Grant an API key # # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb index 6f1af85b75..850ee8e6ab 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Determines whether the specified user has a specified list of privileges. + # Check user privileges # # @option arguments [String] :user Username # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb index 2b7b64aaea..07c8be9a1b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Determines whether the users associated with the specified profile IDs have all the requested privileges. + # Check user profile privileges # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The privileges to check and the list of profile IDs (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_api_key.rb index 3bf6083475..0ca34667c3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_api_key.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Invalidates one or more API keys. + # Invalidate API keys # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The api key request to invalidate API key(s) (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_token.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_token.rb index d683ff10eb..bdc84dae55 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_token.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Invalidates one or more access tokens or refresh tokens. + # Invalidate a token # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The token to invalidate (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_authenticate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_authenticate.rb index f08a601b4c..21953160bc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_authenticate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_authenticate.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair + # Authenticate OpenID Connect # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The OpenID Connect response to authenticate (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_logout.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_logout.rb index 13791e39f6..a989d2d1bc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_logout.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_logout.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API + # Logout of OpenID Connect # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Access token and refresh token to invalidate (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb index 45d10071f5..dfb1aaa223 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Creates an OAuth 2.0 authentication request as a URL string + # Prepare OpenID connect authentication # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The OpenID Connect authentication realm configuration (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb index e874f68ed5..4123a1a87a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Adds or updates application privileges. + # Create or update application privileges # # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. (options: true, false, wait_for) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb index 410a3e3299..44465dca7a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Adds and updates roles in the native realm. + # Create or update roles # # @option arguments [String] :name Role name # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. (options: true, false, wait_for) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb index 6b9ba33e66..bbfd7f4295 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Creates and updates role mappings. + # Create or update role mappings # # @option arguments [String] :name Role-mapping name # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. (options: true, false, wait_for) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb index d30c0a5dba..6a41ef6fbc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Adds and updates users in the native realm. These users are commonly referred to as native users. + # Create or update users # # @option arguments [String] :username The username of the User # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes. (options: true, false, wait_for) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb index 6520a5f35e..93d5e571e0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Retrieves information for API keys using a subset of query DSL + # Find API keys with a query # # @option arguments [Boolean] :with_limited_by flag to show the limited-by role descriptors of API Keys # @option arguments [Boolean] :with_profile_uid flag to also retrieve the API Key's owner profile uid, if it exists diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_role.rb index c378475410..fdeb64cf14 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_role.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Retrieves information for Roles using a subset of query DSL + # Find roles with a query # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body From, size, query, sort and search_after diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb index 6cdbbfb823..3a1940ad05 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Retrieves information for Users using a subset of query DSL + # Find users with a query # # @option arguments [Boolean] :with_profile_uid flag to retrieve profile uid (if exists) associated with the user # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_authenticate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_authenticate.rb index fb8f4e1b1b..935faf7b70 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_authenticate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_authenticate.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair + # Authenticate SAML # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The SAML response to authenticate (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_complete_logout.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_complete_logout.rb index 7163d115a2..1e47abba74 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_complete_logout.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_complete_logout.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Verifies the logout response sent from the SAML IdP + # Logout of SAML completely # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The logout response to verify (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_invalidate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_invalidate.rb index da23a73b79..867e1b1daf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_invalidate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_invalidate.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Consumes a SAML LogoutRequest + # Invalidate SAML # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The LogoutRequest message (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_logout.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_logout.rb index 4cff36d50e..ce6c7dc0ef 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_logout.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_logout.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Invalidates an access token and a refresh token that were generated via the SAML Authenticate API + # Logout of SAML # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The tokens to invalidate (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb index 2962561264..30778e696d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Creates a SAML authentication request + # Prepare SAML authentication # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The realm for which to create the authentication request, identified by either its name or the ACS URL (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb index e073d504e2..87327766eb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider + # Create SAML service provider metadata # # @option arguments [String] :realm_name The name of the SAML realm to get the metadata for # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb index 16bcb86ca4..768c253a3b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Get suggestions for user profiles that match specified search criteria. + # Suggest a user profile # # @option arguments [List] :data A comma-separated list of keys for which the corresponding application data are retrieved. # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb index fde2807b44..7544512c0c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Updates attributes of an existing API key. + # Update an API key # # @option arguments [String] :id The ID of the API key to update # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb index af8505a35b..42e378ea9a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Updates attributes of an existing cross-cluster API key. + # Update a cross-cluster API key # # @option arguments [String] :id The ID of the cross-cluster API key to update # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_settings.rb index 4951c6bf4b..ab64c64a81 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_settings.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Update settings for the security system index + # Update security index settings # # @option arguments [Time] :master_timeout Timeout for connection to master # @option arguments [Time] :timeout Timeout for acknowledgements from all nodes diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb index 2dbe7c608f..4cd3a07a66 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Security module Actions - # Update application specific data for the user profile of the given unique ID. + # Update user profile data # # @option arguments [String] :uid An unique identifier of the user profile # @option arguments [Number] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb index ea9374cfa4..93eefb2f0f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Shutdown module Actions - # Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + # Cancel node shutdown preparations # # @option arguments [String] :node_id The node id of node to be removed from the shutdown state # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-shutdown.html # def delete_node(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'shutdown.delete_node' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb index a54d202492..bac8eb1b31 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Shutdown module Actions - # Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + # Get the shutdown status # # @option arguments [String] :node_id Which node for which to retrieve the shutdown status # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-shutdown.html # def get_node(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'shutdown.get_node' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb index a2f098cc29..816b3e6d89 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Shutdown module Actions - # Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + # Prepare a node to be shut down # # @option arguments [String] :node_id The node id of node to be shut down # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The shutdown type definition to register (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-shutdown.html # def put_node(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'shutdown.put_node' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb b/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb index f3c6a9bf8f..64b095eb5c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Simulate module Actions - # Simulates running ingest with example documents. + # Simulate data ingestion # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb index 436515d073..a90790bc7a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Snapshot module Actions - # Removes stale data from repository. + # Clean up the snapshot repository # # @option arguments [String] :repository A repository name # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb index d3ae1520a2..4e35e82853 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Snapshot module Actions - # Clones indices from one snapshot into another snapshot in the same repository. + # Clone a snapshot # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot The name of the snapshot to clone from @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The snapshot clone definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/clone-snapshot-api.html # def clone(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.clone' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb index ff1171a3ff..152a81e5de 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Snapshot module Actions - # Creates a snapshot in a repository. + # Create a snapshot # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot A snapshot name @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The snapshot definition # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/create-snapshot-api.html # def create(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.create' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb index dfc6a5ea49..40567ba775 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Snapshot module Actions - # Creates a repository. + # Create or update a snapshot repository # # @option arguments [String] :repository A repository name # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The repository definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-snapshot-repo-api.html # def create_repository(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.create_repository' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb index d94bfcfb62..0b9b09df71 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Snapshot module Actions - # Deletes one or more snapshots. + # Delete snapshots # # @option arguments [String] :repository A repository name # @option arguments [List] :snapshot A comma-separated list of snapshot names @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-snapshot-api.html # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.delete' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb index 5722815a32..358056bf09 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Snapshot module Actions - # Deletes a repository. + # Delete snapshot repositories # # @option arguments [List] :repository Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-snapshot-repo-api.html # def delete_repository(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.delete_repository' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb index 44dc87e1f0..77ccf316a1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Snapshot module Actions - # Returns information about a snapshot. + # Get snapshot information # # @option arguments [String] :repository A repository name # @option arguments [List] :snapshot A comma-separated list of snapshot names @@ -41,7 +41,7 @@ module Actions # @option arguments [Boolean] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-snapshot-api.html # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.get' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb index eb05645f5a..d9e2b2f207 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Snapshot module Actions - # Returns information about a repository. + # Get snapshot repository information # # @option arguments [List] :repository A comma-separated list of repository names # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-snapshot-repo-api.html # def get_repository(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.get_repository' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb index 9fac326c76..8054fb5326 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Snapshot module Actions - # Analyzes a repository for correctness and performance + # Analyze a snapshot repository # # @option arguments [String] :repository A repository name # @option arguments [Number] :blob_count Number of blobs to create during the test. Defaults to 100. @@ -39,7 +39,7 @@ module Actions # @option arguments [Boolean] :rarely_abort_writes Whether to rarely abort writes before they complete. Defaults to 'true'. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/repo-analysis-api.html # def repository_analyze(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.repository_analyze' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb index 23379f1e3e..0d7ba04e33 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Snapshot module Actions - # Restores a snapshot. + # Restore a snapshot # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot A snapshot name @@ -31,7 +31,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Details of what to restore # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/restore-snapshot-api.html # def restore(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.restore' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb index f9e183f463..3dc6f3bb7a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Snapshot module Actions - # Returns information about the status of a snapshot. + # Get the snapshot status # # @option arguments [String] :repository A repository name # @option arguments [List] :snapshot A comma-separated list of snapshot names @@ -30,7 +30,7 @@ module Actions # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-snapshot-status-api.html # def status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.status' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb index 1e7b5c93f5..acbcf56543 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Snapshot module Actions - # Verifies a repository. + # Verify a snapshot repository # # @option arguments [String] :repository A repository name # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/modules-snapshots.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/verify-snapshot-repo-api.html # def verify_repository(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.verify_repository' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb index b653fc6383..b00558f909 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Deletes an existing snapshot lifecycle policy. + # Delete a policy # # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to remove # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb index 7554d33e1b..f28fd6bfbf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + # Run a policy # # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to be executed # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb index 066341fff6..23f4c85d3c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Deletes any snapshots that are expired according to the policy's retention rules. + # Run a retention policy # # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb index c4351377eb..b0e4156a65 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + # Get policy information # # @option arguments [List] :policy_id Comma-separated list of snapshot lifecycle policies to retrieve # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb index 504472ad01..e02f27d588 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + # Get snapshot lifecycle management statistics # # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb index 51c3f85aab..48b174e952 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Retrieves the status of snapshot lifecycle management (SLM). + # Get the snapshot lifecycle management status # # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb index 039987aa0b..5731ce3509 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Creates or updates a snapshot lifecycle policy. + # Create or update a policy # # @option arguments [String] :policy_id The id of the snapshot lifecycle policy # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb index 82c762389c..f134ae7c64 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Turns on snapshot lifecycle management (SLM). + # Start snapshot lifecycle management # # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb index 41a1ac0d57..7f219a8258 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Turns off snapshot lifecycle management (SLM). + # Stop snapshot lifecycle management # # @option arguments [Time] :master_timeout Timeout for processing on master node # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/clear_cursor.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/clear_cursor.rb index b0326a0c48..98ba23042d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/clear_cursor.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/clear_cursor.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SQL module Actions - # Clears the SQL cursor + # Clear an SQL search cursor # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Specify the cursor value in the `cursor` element to clean the cursor. (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb index 5b759a74bd..7e80224f46 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SQL module Actions - # Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + # Delete an async SQL search # # @option arguments [String] :id The async search ID # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb index 0edb091915..1d9e222689 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SQL module Actions - # Returns the current status and available results for an async SQL search or stored synchronous SQL search + # Get async SQL search results # # @option arguments [String] :id The async search ID # @option arguments [String] :delimiter Separator for CSV results diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb index 38c3ca63d2..a14b485f25 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SQL module Actions - # Returns the current status of an async SQL search or a stored synchronous SQL search + # Get the async SQL search status # # @option arguments [String] :id The async search ID # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb index 9b66f5bf27..ae3216bcb2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SQL module Actions - # Executes a SQL request + # Get SQL search results # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/translate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/translate.rb index 4b7cd930ff..145e6eb7d7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/translate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/translate.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SQL module Actions - # Translates SQL into Elasticsearch queries + # Translate SQL into Elasticsearch queries # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Specify the query in the `query` element. (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ssl/certificates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ssl/certificates.rb index 5900fdbbcb..4bc964d830 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ssl/certificates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ssl/certificates.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module SSL module Actions - # Retrieves information about the X.509 certificates used to encrypt communications in the cluster. + # Get SSL certificates # # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb index e11637a12a..b389c46254 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Synonyms module Actions - # Deletes a synonym set + # Delete a synonym set # # @option arguments [String] :id The id of the synonyms set to be deleted # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb index e1ecaed2a9..79882e81b3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Synonyms module Actions - # Deletes a synonym rule in a synonym set + # Delete a synonym rule # # @option arguments [String] :set_id The id of the synonym set to be updated # @option arguments [String] :rule_id The id of the synonym rule to be deleted diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb index 31484eba25..2a5459e98c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Synonyms module Actions - # Retrieves a synonym set + # Get a synonym set # # @option arguments [String] :id The name of the synonyms set to be retrieved # @option arguments [Integer] :from Starting offset diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb index 52841cb9f8..8155eba326 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Synonyms module Actions - # Retrieves a synonym rule from a synonym set + # Get a synonym rule # # @option arguments [String] :set_id The id of the synonym set to retrieve the synonym rule from # @option arguments [String] :rule_id The id of the synonym rule to retrieve diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb index 8899ed6ca6..28fd344cb5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Synonyms module Actions - # Retrieves a summary of all defined synonym sets + # Get all synonym sets # # @option arguments [Integer] :from Starting offset # @option arguments [Integer] :size specifies a max number of results to get # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/list-synonyms-sets.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-synonyms-set.html # def get_synonyms_sets(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'synonyms.get_synonyms_sets' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb index bcd80b7215..160df4a84d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Synonyms module Actions - # Creates or updates a synonyms set + # Create or update a synonym set # # @option arguments [String] :id The id of the synonyms set to be created or updated # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb index 3573a15323..86406efd16 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Synonyms module Actions - # Creates or updates a synonym rule in a synonym set + # Create or update a synonym rule # # @option arguments [String] :set_id The id of the synonym set to be updated with the synonym rule # @option arguments [String] :rule_id The id of the synonym rule to be updated or created diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb index 904535c146..72703d28dd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Tasks module Actions - # Cancels a task, if it can be cancelled through an API. + # Cancel a task # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb index 7cbb5476f5..3ba88629e3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Tasks module Actions - # Returns information about a task. + # Get task information # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb index 74e2e8b48b..ada230ddf0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Tasks module Actions - # Returns a list of tasks. + # Get all tasks # This functionality is Experimental and may be changed or removed # completely in a future release. Elastic will take a best effort approach # to fix any issues, but experimental features are not subject to the diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb b/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb index f50e2569a1..e394afaae2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + # Get terms in an index # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb b/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb index 232dcbe46a..e607a60612 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Returns information and statistics about terms in the fields of a particular document. + # Get term vector information # # @option arguments [String] :index The index in which the document resides. # @option arguments [String] :id The id of the document, when not specified a doc param should be supplied. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb index 7b568e1202..2d2dd90857 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module TextStructure module Actions - # Finds the structure of a text field in an index. + # Find the structure of a text field # # @option arguments [String] :index The index containing the analyzed field (*Required*) # @option arguments [String] :field The field that should be analyzed (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb index 60032f44e9..927bf13e08 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module TextStructure module Actions - # Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch. + # Find the structure of text messages # # @option arguments [Time] :timeout Timeout after which the analysis will be aborted # @option arguments [String] :format Optional parameter to specify the high level file format (options: ndjson, xml, delimited, semi_structured_text) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_structure.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_structure.rb index f8ec9b23de..b5157099c9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_structure.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_structure.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module TextStructure module Actions - # Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. + # Find the structure of a text file # # @option arguments [Integer] :lines_to_sample How many lines of the file should be included in the analysis # @option arguments [Integer] :line_merge_size_limit Maximum number of characters permitted in a single message when lines are merged to create messages. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb index d76d32f726..3bfde7707b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module TextStructure module Actions - # Tests a Grok pattern on some text. + # Test a Grok pattern # # @option arguments [String] :ecs_compatibility Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled' # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb index 72ec3e6fc4..db48decef3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Deletes an existing transform. + # Delete a transform # # @option arguments [String] :transform_id The id of the transform to delete # @option arguments [Boolean] :force When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_node_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_node_stats.rb index 0eee13e3f9..dd184906d5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_node_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_node_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Retrieves transform usage information for transform nodes. + # Retrieves transform usage information for transform nodes # # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb index 12cdcdf7f1..8a4d685db7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Retrieves configuration information for transforms. + # Get transforms # # @option arguments [String] :transform_id The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms # @option arguments [Integer] :from skips a number of transform configs, defaults to 0 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb index 573ec18192..494084dfd5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Retrieves usage information for transforms. + # Get transform stats # # @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms # @option arguments [Number] :from skips a number of transform stats, defaults to 0 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb index 679ce8bf67..e0f05db2da 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Previews a transform. + # Preview a transform # # @option arguments [String] :transform_id The id of the transform to preview. # @option arguments [Time] :timeout Controls the time to wait for the preview diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb index 85f4b0252f..0b880fc389 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Instantiates a transform. + # Create a transform # # @option arguments [String] :transform_id The id of the new transform. # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb index 52d4ec2c2f..4e501327ac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Resets an existing transform. + # Reset a transform # # @option arguments [String] :transform_id The id of the transform to reset # @option arguments [Boolean] :force When `true`, the transform is reset regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be reset. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb index 0317dadd7d..d996ce1e03 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Schedules now a transform. + # Schedule a transform to start now # # @option arguments [String] :transform_id The id of the transform. (*Required*) # @option arguments [Time] :timeout Controls the time to wait for the scheduling to take place diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb index e29a0af981..4d5ff41993 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Transform module Actions - # Sets a cluster wide upgrade_mode setting that prepares transform indices for an upgrade. + # Set upgrade_mode for transform indices # # @option arguments [Boolean] :enabled Whether to enable upgrade_mode Transform setting or not. Defaults to false. # @option arguments [Time] :timeout Controls the time to wait before action times out. Defaults to 30 seconds # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/transform-set-upgrade-mode.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-set-upgrade-mode # def set_upgrade_mode(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.set_upgrade_mode' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb index ce8ac82641..dff3844d1a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Starts one or more transforms. + # Start a transform # # @option arguments [String] :transform_id The id of the transform to start # @option arguments [String] :from Restricts the set of transformed entities to those changed after this time diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb index 07584c3d7e..32016ea903 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Stops one or more transforms. + # Stop transforms # # @option arguments [String] :transform_id The id of the transform to stop # @option arguments [Boolean] :force Whether to force stop a failed transform or not. Default to false diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb index 197b225d7c..22c1d94b2e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Transform module Actions - # Updates certain properties of a transform. + # Update a transform # # @option arguments [String] :transform_id The id of the transform. (*Required*) # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false. @@ -30,7 +30,7 @@ module Actions # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The update transform definition (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-transform.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-transform-update-transform # def update_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.update_transform' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb index 1af5d9ec36..a1fd8a18c6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Transform module Actions - # Upgrades all transforms. + # Upgrade all transforms # # @option arguments [Boolean] :dry_run Whether to only check for updates but don't execute # @option arguments [Time] :timeout Controls the time to wait for the upgrade # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/upgrade-transforms.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-transform-upgrade-transforms # def upgrade_transforms(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.upgrade_transforms' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update.rb index 82414c049b..293d406c36 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update.rb @@ -21,7 +21,7 @@ module Elasticsearch module API module Actions - # Updates a document with a script or partial document. + # Update a document # # @option arguments [String] :id Document ID # @option arguments [String] :index The name of the index diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb index 995906b999..a600c8ef3d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb @@ -21,8 +21,7 @@ module Elasticsearch module API module Actions - # Performs an update on every document in the index without changing the source, - # for example to pick up a mapping change. + # Update documents # # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices # @option arguments [String] :analyzer The analyzer to use for the query string diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb index 201fc299e0..70379d2eb7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb @@ -21,13 +21,13 @@ module Elasticsearch module API module Actions - # Changes the number of requests per second for a particular Update By Query operation. + # Throttle an update by query operation # # @option arguments [String] :task_id The task id to rethrottle # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*) # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update-by-query.html + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update-by-query.html#docs-update-by-query-rethrottle # def update_by_query_rethrottle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'update_by_query_rethrottle' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb index fd475579e9..caa0e9d41d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Watcher module Actions - # Acknowledges a watch, manually throttling the execution of the watch's actions. + # Acknowledge a watch # # @option arguments [String] :watch_id Watch ID # @option arguments [List] :action_id A comma-separated list of the action ids to be acked # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-ack-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-ack-watch # def ack_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.ack_watch' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb index afb9731b31..02352e6e44 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Watcher module Actions - # Activates a currently inactive watch. + # Activate a watch # # @option arguments [String] :watch_id Watch ID # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-activate-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-activate-watch # def activate_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.activate_watch' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb index 0a4b9db0cf..56ce280919 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Watcher module Actions - # Deactivates a currently active watch. + # Deactivate a watch # # @option arguments [String] :watch_id Watch ID # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-deactivate-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-deactivate-watch # def deactivate_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.deactivate_watch' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb index de8fa77624..52c4bafb53 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Watcher module Actions - # Removes a watch from Watcher. + # Delete a watch # # @option arguments [String] :id Watch ID # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-delete-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-delete-watch # def delete_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.delete_watch' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb index e7f4c0b9f0..b18c5635af 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Watcher module Actions - # Forces the execution of a stored watch. + # Run a watch # # @option arguments [String] :id Watch ID # @option arguments [Boolean] :debug indicates whether the watch should execute in debug mode # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Execution control # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-execute-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-execute-watch # def execute_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.execute_watch' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_settings.rb index 8e621a326a..547fa1dc06 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_settings.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Watcher module Actions - # Retrieve settings for the watcher system index + # Get Watcher index settings # # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-get-settings.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-get-settings # def get_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.get_settings' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb index 1d62906fce..200d2afc9d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Watcher module Actions - # Retrieves a watch by its ID. + # Get a watch # # @option arguments [String] :id Watch ID # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-get-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-get-watch # def get_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.get_watch' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb index b4c1468f30..0ded8efd98 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Watcher module Actions - # Creates a new watch, or updates an existing one. + # Create or update a watch # # @option arguments [String] :id Watch ID # @option arguments [Boolean] :active Specify whether the watch is in/active by default @@ -30,9 +30,9 @@ module Actions # @option arguments [Number] :if_seq_no only update the watch if the last operation that has changed the watch has the specified sequence number # @option arguments [Number] :if_primary_term only update the watch if the last operation that has changed the watch has the specified primary term # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The watch + # @option arguments [Hash] :body The watch (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-put-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-put-watch # def put_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.put_watch' } @@ -42,6 +42,7 @@ def put_watch(arguments = {}) end request_opts[:defined_params] = defined_params unless defined_params.empty? + raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] arguments = arguments.clone diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/query_watches.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/query_watches.rb index b31447b74f..7e3c702b38 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/query_watches.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/query_watches.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Watcher module Actions - # Retrieves stored watches. + # Query watches # # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body From, size, query, sort and search_after # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-query-watches.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-query-watches # def query_watches(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.query_watches' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/start.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/start.rb index 6b5b1ddcef..0d3a1747ac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/start.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/start.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Watcher module Actions - # Starts Watcher if it is not already running. + # Start the watch service # # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-start.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-start # def start(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.start' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb index 48122bd30a..43aa9981cd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Watcher module Actions - # Retrieves the current Watcher metrics. + # Get Watcher statistics # # @option arguments [List] :metric Controls what additional stat metrics should be include in the response (options: _all, queued_watches, current_watches, pending_watches) # @option arguments [Boolean] :emit_stacktraces Emits stack traces of currently running watches # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-stats # def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.stats' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stop.rb index 32547e206d..5c4b5d02aa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stop.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stop.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module Watcher module Actions - # Stops Watcher if it is running. + # Stop the watch service # # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-stop.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-stop # def stop(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.stop' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb index ee05dfaee0..c14590234c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb @@ -22,14 +22,14 @@ module Elasticsearch module API module Watcher module Actions - # Update settings for the watcher system index + # Update Watcher index settings # # @option arguments [Time] :timeout Specify timeout for waiting for acknowledgement from all nodes # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body An object with the new index settings (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/watcher-api-update-settings.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-update-settings # def update_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.update_settings' } diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb index 47ecd2b003..1122b7ff1a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module XPack module Actions - # Retrieves information about the installed X-Pack features. + # Get information # # @option arguments [Boolean] :human Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. The default value is true. # @option arguments [List] :categories Comma-separated list of info categories. Can be any of: build, license, features diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb index b5c12b6c4a..f0ef64d9fb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb @@ -22,12 +22,12 @@ module Elasticsearch module API module XPack module Actions - # Retrieves usage information about the installed X-Pack features. + # Get usage information # # @option arguments [Time] :master_timeout Specify timeout for watch write operation # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/usage-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-xpack # def usage(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'xpack.usage' } From 0d70c22f6422939e8a72f8a2ce12529a88cba3e0 Mon Sep 17 00:00:00 2001 From: Fernando Briano Date: Tue, 14 Oct 2025 10:56:26 +0100 Subject: [PATCH 3/4] [API] Removes connector.last_sync spec --- .../api/actions/connector/last_sync_spec.rb | 38 ------------------- 1 file changed, 38 deletions(-) delete mode 100644 elasticsearch-api/spec/elasticsearch/api/actions/connector/last_sync_spec.rb diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/connector/last_sync_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/connector/last_sync_spec.rb deleted file mode 100644 index 68cb2b635e..0000000000 --- a/elasticsearch-api/spec/elasticsearch/api/actions/connector/last_sync_spec.rb +++ /dev/null @@ -1,38 +0,0 @@ -# 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. - -require 'spec_helper' - -describe 'client.connector#last_sync' do - let(:expected_args) do - [ - 'PUT', - '_connector/foo/_last_sync', - {}, - {}, - {}, - { - :defined_params=>{ connector_id: 'foo' }, - endpoint: 'connector.last_sync' - } - ] - end - - it 'performs the request' do - expect(client_double.connector.last_sync(connector_id: 'foo', body: {})).to be_a Elasticsearch::API::Response - end -end From 7749b86c944fcb45ffd88d10acb7c57fa6f9abfd Mon Sep 17 00:00:00 2001 From: Fernando Briano Date: Tue, 14 Oct 2025 11:32:03 +0100 Subject: [PATCH 4/4] Skips streams tests, connector.last_sync endpoints removed from spec --- elasticsearch-api/spec/rest_api/skipped_tests_free.yml | 3 +++ elasticsearch-api/spec/rest_api/skipped_tests_platinum.yml | 3 +++ 2 files changed, 6 insertions(+) diff --git a/elasticsearch-api/spec/rest_api/skipped_tests_free.yml b/elasticsearch-api/spec/rest_api/skipped_tests_free.yml index 279a83305b..a68ba9285c 100644 --- a/elasticsearch-api/spec/rest_api/skipped_tests_free.yml +++ b/elasticsearch-api/spec/rest_api/skipped_tests_free.yml @@ -258,3 +258,6 @@ - :file: 'data_stream/240_data_stream_settings.yml' :description: '*' +- + :file: 'streams/logs/10_basic.yml' + :description: '*' diff --git a/elasticsearch-api/spec/rest_api/skipped_tests_platinum.yml b/elasticsearch-api/spec/rest_api/skipped_tests_platinum.yml index 765bd11c5d..a8fd2c5fa9 100644 --- a/elasticsearch-api/spec/rest_api/skipped_tests_platinum.yml +++ b/elasticsearch-api/spec/rest_api/skipped_tests_platinum.yml @@ -416,3 +416,6 @@ - :file: 'watcher/put_watch/90_auto_create_index.yml' :description: '*' +- + :file: 'entsearch/connector/80_connector_update_last_sync_stats.yml' + :description: '*'