From 387bcb7de83d9986753f201c1c2f31f077a17654 Mon Sep 17 00:00:00 2001 From: Elastic Machine Date: Sat, 1 Jun 2024 06:06:44 +0000 Subject: [PATCH] Auto-generated API code --- .../lib/elasticsearch/api/actions/async_search/delete.rb | 1 - .../lib/elasticsearch/api/actions/async_search/get.rb | 1 - .../lib/elasticsearch/api/actions/async_search/status.rb | 1 - .../lib/elasticsearch/api/actions/async_search/submit.rb | 1 - .../api/actions/autoscaling/delete_autoscaling_policy.rb | 1 - .../api/actions/autoscaling/get_autoscaling_policy.rb | 1 - .../api/actions/autoscaling/put_autoscaling_policy.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb | 1 - .../lib/elasticsearch/api/actions/cat/allocation.rb | 1 - .../lib/elasticsearch/api/actions/cat/component_templates.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb | 1 - .../lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb | 1 - .../lib/elasticsearch/api/actions/cat/ml_datafeeds.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb | 1 - .../lib/elasticsearch/api/actions/cat/ml_trained_models.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb | 1 - .../lib/elasticsearch/api/actions/cat/pending_tasks.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb | 1 - .../lib/elasticsearch/api/actions/cat/repositories.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb | 1 - .../lib/elasticsearch/api/actions/cat/thread_pool.rb | 1 - .../lib/elasticsearch/api/actions/cat/transforms.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb | 1 - .../lib/elasticsearch/api/actions/cluster/allocation_explain.rb | 1 - .../api/actions/cluster/delete_component_template.rb | 1 - .../api/actions/cluster/delete_voting_config_exclusions.rb | 1 - .../api/actions/cluster/exists_component_template.rb | 1 - .../elasticsearch/api/actions/cluster/get_component_template.rb | 1 - .../lib/elasticsearch/api/actions/cluster/get_settings.rb | 1 - .../lib/elasticsearch/api/actions/cluster/health.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb | 1 - .../lib/elasticsearch/api/actions/cluster/pending_tasks.rb | 1 - .../api/actions/cluster/post_voting_config_exclusions.rb | 1 - .../elasticsearch/api/actions/cluster/put_component_template.rb | 1 - .../lib/elasticsearch/api/actions/cluster/put_settings.rb | 1 - .../lib/elasticsearch/api/actions/cluster/reroute.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/count.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/create.rb | 1 - .../cross_cluster_replication/delete_auto_follow_pattern.rb | 1 - .../api/actions/cross_cluster_replication/follow.rb | 1 - .../api/actions/cross_cluster_replication/follow_info.rb | 1 - .../api/actions/cross_cluster_replication/follow_stats.rb | 1 - .../api/actions/cross_cluster_replication/forget_follower.rb | 1 - .../actions/cross_cluster_replication/get_auto_follow_pattern.rb | 1 - .../cross_cluster_replication/pause_auto_follow_pattern.rb | 1 - .../api/actions/cross_cluster_replication/pause_follow.rb | 1 - .../actions/cross_cluster_replication/put_auto_follow_pattern.rb | 1 - .../cross_cluster_replication/resume_auto_follow_pattern.rb | 1 - .../api/actions/cross_cluster_replication/resume_follow.rb | 1 - .../api/actions/cross_cluster_replication/unfollow.rb | 1 - .../api/actions/dangling_indices/delete_dangling_index.rb | 1 - .../api/actions/dangling_indices/import_dangling_index.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/delete.rb | 1 - .../lib/elasticsearch/api/actions/delete_by_query.rb | 1 - .../lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb | 1 - .../lib/elasticsearch/api/actions/enrich/delete_policy.rb | 1 - .../lib/elasticsearch/api/actions/enrich/execute_policy.rb | 1 - .../lib/elasticsearch/api/actions/enrich/get_policy.rb | 1 - .../lib/elasticsearch/api/actions/enrich/put_policy.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb | 1 - .../lib/elasticsearch/api/actions/eql/get_status.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb | 1 - .../lib/elasticsearch/api/actions/esql/async_query_get.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/exists.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/explain.rb | 1 - .../lib/elasticsearch/api/actions/features/get_features.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb | 1 - .../lib/elasticsearch/api/actions/fleet/global_checkpoints.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/get.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/index.rb | 1 - .../api/actions/index_lifecycle_management/delete_lifecycle.rb | 1 - .../api/actions/index_lifecycle_management/explain_lifecycle.rb | 1 - .../api/actions/index_lifecycle_management/get_lifecycle.rb | 1 - .../actions/index_lifecycle_management/migrate_to_data_tiers.rb | 1 - .../api/actions/index_lifecycle_management/move_to_step.rb | 1 - .../api/actions/index_lifecycle_management/put_lifecycle.rb | 1 - .../api/actions/index_lifecycle_management/remove_policy.rb | 1 - .../api/actions/index_lifecycle_management/retry.rb | 1 - .../lib/elasticsearch/api/actions/indices/add_block.rb | 1 - .../lib/elasticsearch/api/actions/indices/analyze.rb | 1 - .../lib/elasticsearch/api/actions/indices/clear_cache.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb | 1 - .../lib/elasticsearch/api/actions/indices/create.rb | 1 - .../lib/elasticsearch/api/actions/indices/create_data_stream.rb | 1 - .../lib/elasticsearch/api/actions/indices/data_streams_stats.rb | 1 - .../lib/elasticsearch/api/actions/indices/delete.rb | 1 - .../lib/elasticsearch/api/actions/indices/delete_alias.rb | 1 - .../lib/elasticsearch/api/actions/indices/delete_data_stream.rb | 1 - .../elasticsearch/api/actions/indices/delete_index_template.rb | 1 - .../lib/elasticsearch/api/actions/indices/delete_template.rb | 1 - .../lib/elasticsearch/api/actions/indices/exists.rb | 1 - .../lib/elasticsearch/api/actions/indices/exists_alias.rb | 1 - .../elasticsearch/api/actions/indices/exists_index_template.rb | 1 - .../lib/elasticsearch/api/actions/indices/exists_template.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb | 1 - .../lib/elasticsearch/api/actions/indices/forcemerge.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb | 1 - .../lib/elasticsearch/api/actions/indices/get_alias.rb | 1 - .../lib/elasticsearch/api/actions/indices/get_data_stream.rb | 1 - .../lib/elasticsearch/api/actions/indices/get_field_mapping.rb | 1 - .../lib/elasticsearch/api/actions/indices/get_index_template.rb | 1 - .../lib/elasticsearch/api/actions/indices/get_mapping.rb | 1 - .../lib/elasticsearch/api/actions/indices/get_settings.rb | 1 - .../lib/elasticsearch/api/actions/indices/get_template.rb | 1 - .../elasticsearch/api/actions/indices/migrate_to_data_stream.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb | 1 - .../lib/elasticsearch/api/actions/indices/promote_data_stream.rb | 1 - .../lib/elasticsearch/api/actions/indices/put_alias.rb | 1 - .../lib/elasticsearch/api/actions/indices/put_index_template.rb | 1 - .../lib/elasticsearch/api/actions/indices/put_mapping.rb | 1 - .../lib/elasticsearch/api/actions/indices/put_settings.rb | 1 - .../lib/elasticsearch/api/actions/indices/put_template.rb | 1 - .../lib/elasticsearch/api/actions/indices/recovery.rb | 1 - .../lib/elasticsearch/api/actions/indices/refresh.rb | 1 - .../elasticsearch/api/actions/indices/reload_search_analyzers.rb | 1 - .../lib/elasticsearch/api/actions/indices/resolve_cluster.rb | 1 - .../lib/elasticsearch/api/actions/indices/resolve_index.rb | 1 - .../lib/elasticsearch/api/actions/indices/rollover.rb | 1 - .../lib/elasticsearch/api/actions/indices/segments.rb | 1 - .../lib/elasticsearch/api/actions/indices/shard_stores.rb | 1 - .../lib/elasticsearch/api/actions/indices/shrink.rb | 1 - .../elasticsearch/api/actions/indices/simulate_index_template.rb | 1 - .../lib/elasticsearch/api/actions/indices/simulate_template.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb | 1 - .../lib/elasticsearch/api/actions/indices/unfreeze.rb | 1 - .../lib/elasticsearch/api/actions/indices/update_aliases.rb | 1 - .../lib/elasticsearch/api/actions/indices/validate_query.rb | 1 - .../lib/elasticsearch/api/actions/ingest/delete_pipeline.rb | 1 - .../lib/elasticsearch/api/actions/ingest/get_pipeline.rb | 1 - .../lib/elasticsearch/api/actions/ingest/put_pipeline.rb | 1 - .../lib/elasticsearch/api/actions/ingest/simulate.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb | 1 - .../lib/elasticsearch/api/actions/license/post_start_basic.rb | 1 - .../lib/elasticsearch/api/actions/license/post_start_trial.rb | 1 - .../lib/elasticsearch/api/actions/logstash/delete_pipeline.rb | 1 - .../lib/elasticsearch/api/actions/logstash/get_pipeline.rb | 1 - .../lib/elasticsearch/api/actions/logstash/put_pipeline.rb | 1 - .../machine_learning/clear_trained_model_deployment_cache.rb | 1 - .../lib/elasticsearch/api/actions/machine_learning/close_job.rb | 1 - .../api/actions/machine_learning/delete_calendar.rb | 1 - .../api/actions/machine_learning/delete_calendar_event.rb | 1 - .../api/actions/machine_learning/delete_calendar_job.rb | 1 - .../api/actions/machine_learning/delete_data_frame_analytics.rb | 1 - .../api/actions/machine_learning/delete_datafeed.rb | 1 - .../api/actions/machine_learning/delete_expired_data.rb | 1 - .../elasticsearch/api/actions/machine_learning/delete_filter.rb | 1 - .../api/actions/machine_learning/delete_forecast.rb | 1 - .../lib/elasticsearch/api/actions/machine_learning/delete_job.rb | 1 - .../api/actions/machine_learning/delete_model_snapshot.rb | 1 - .../api/actions/machine_learning/delete_trained_model.rb | 1 - .../api/actions/machine_learning/delete_trained_model_alias.rb | 1 - .../api/actions/machine_learning/explain_data_frame_analytics.rb | 1 - .../lib/elasticsearch/api/actions/machine_learning/flush_job.rb | 1 - .../lib/elasticsearch/api/actions/machine_learning/forecast.rb | 1 - .../elasticsearch/api/actions/machine_learning/get_buckets.rb | 1 - .../api/actions/machine_learning/get_calendar_events.rb | 1 - .../elasticsearch/api/actions/machine_learning/get_calendars.rb | 1 - .../elasticsearch/api/actions/machine_learning/get_categories.rb | 1 - .../api/actions/machine_learning/get_data_frame_analytics.rb | 1 - .../actions/machine_learning/get_data_frame_analytics_stats.rb | 1 - .../api/actions/machine_learning/get_datafeed_stats.rb | 1 - .../elasticsearch/api/actions/machine_learning/get_datafeeds.rb | 1 - .../elasticsearch/api/actions/machine_learning/get_filters.rb | 1 - .../api/actions/machine_learning/get_influencers.rb | 1 - .../elasticsearch/api/actions/machine_learning/get_job_stats.rb | 1 - .../lib/elasticsearch/api/actions/machine_learning/get_jobs.rb | 1 - .../api/actions/machine_learning/get_memory_stats.rb | 1 - .../actions/machine_learning/get_model_snapshot_upgrade_stats.rb | 1 - .../api/actions/machine_learning/get_model_snapshots.rb | 1 - .../api/actions/machine_learning/get_overall_buckets.rb | 1 - .../elasticsearch/api/actions/machine_learning/get_records.rb | 1 - .../api/actions/machine_learning/get_trained_models.rb | 1 - .../api/actions/machine_learning/get_trained_models_stats.rb | 1 - .../api/actions/machine_learning/infer_trained_model.rb | 1 - .../lib/elasticsearch/api/actions/machine_learning/open_job.rb | 1 - .../api/actions/machine_learning/post_calendar_events.rb | 1 - .../lib/elasticsearch/api/actions/machine_learning/post_data.rb | 1 - .../api/actions/machine_learning/preview_data_frame_analytics.rb | 1 - .../api/actions/machine_learning/preview_datafeed.rb | 1 - .../elasticsearch/api/actions/machine_learning/put_calendar.rb | 1 - .../api/actions/machine_learning/put_calendar_job.rb | 1 - .../api/actions/machine_learning/put_data_frame_analytics.rb | 1 - .../elasticsearch/api/actions/machine_learning/put_datafeed.rb | 1 - .../lib/elasticsearch/api/actions/machine_learning/put_filter.rb | 1 - .../lib/elasticsearch/api/actions/machine_learning/put_job.rb | 1 - .../api/actions/machine_learning/put_trained_model.rb | 1 - .../api/actions/machine_learning/put_trained_model_alias.rb | 1 - .../machine_learning/put_trained_model_definition_part.rb | 1 - .../api/actions/machine_learning/put_trained_model_vocabulary.rb | 1 - .../lib/elasticsearch/api/actions/machine_learning/reset_job.rb | 1 - .../api/actions/machine_learning/revert_model_snapshot.rb | 1 - .../api/actions/machine_learning/set_upgrade_mode.rb | 1 - .../api/actions/machine_learning/start_data_frame_analytics.rb | 1 - .../elasticsearch/api/actions/machine_learning/start_datafeed.rb | 1 - .../actions/machine_learning/start_trained_model_deployment.rb | 1 - .../api/actions/machine_learning/stop_data_frame_analytics.rb | 1 - .../elasticsearch/api/actions/machine_learning/stop_datafeed.rb | 1 - .../actions/machine_learning/stop_trained_model_deployment.rb | 1 - .../api/actions/machine_learning/update_data_frame_analytics.rb | 1 - .../api/actions/machine_learning/update_datafeed.rb | 1 - .../elasticsearch/api/actions/machine_learning/update_filter.rb | 1 - .../lib/elasticsearch/api/actions/machine_learning/update_job.rb | 1 - .../api/actions/machine_learning/update_model_snapshot.rb | 1 - .../api/actions/machine_learning/upgrade_job_snapshot.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/mget.rb | 1 - .../lib/elasticsearch/api/actions/migration/deprecations.rb | 1 - .../lib/elasticsearch/api/actions/monitoring/bulk.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb | 1 - .../lib/elasticsearch/api/actions/msearch_template.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb | 1 - .../lib/elasticsearch/api/actions/nodes/hot_threads.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb | 1 - .../elasticsearch/api/actions/nodes/reload_secure_settings.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb | 1 - .../lib/elasticsearch/api/actions/open_point_in_time.rb | 1 - .../lib/elasticsearch/api/actions/profiling/status.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb | 1 - .../lib/elasticsearch/api/actions/reindex_rethrottle.rb | 1 - .../lib/elasticsearch/api/actions/render_search_template.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/search.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb | 1 - .../lib/elasticsearch/api/actions/search_template.rb | 1 - .../lib/elasticsearch/api/actions/searchable_snapshots/mount.rb | 1 - .../lib/elasticsearch/api/actions/searchable_snapshots/stats.rb | 1 - .../lib/elasticsearch/api/actions/security/change_password.rb | 1 - .../elasticsearch/api/actions/security/clear_api_key_cache.rb | 1 - .../api/actions/security/clear_cached_privileges.rb | 1 - .../elasticsearch/api/actions/security/clear_cached_realms.rb | 1 - .../lib/elasticsearch/api/actions/security/clear_cached_roles.rb | 1 - .../api/actions/security/clear_cached_service_tokens.rb | 1 - .../lib/elasticsearch/api/actions/security/create_api_key.rb | 1 - .../elasticsearch/api/actions/security/create_service_token.rb | 1 - .../lib/elasticsearch/api/actions/security/delete_privileges.rb | 1 - .../lib/elasticsearch/api/actions/security/delete_role.rb | 1 - .../elasticsearch/api/actions/security/delete_role_mapping.rb | 1 - .../elasticsearch/api/actions/security/delete_service_token.rb | 1 - .../lib/elasticsearch/api/actions/security/delete_user.rb | 1 - .../lib/elasticsearch/api/actions/security/disable_user.rb | 1 - .../elasticsearch/api/actions/security/disable_user_profile.rb | 1 - .../lib/elasticsearch/api/actions/security/enable_user.rb | 1 - .../elasticsearch/api/actions/security/enable_user_profile.rb | 1 - .../lib/elasticsearch/api/actions/security/get_api_key.rb | 1 - .../lib/elasticsearch/api/actions/security/get_privileges.rb | 1 - .../lib/elasticsearch/api/actions/security/get_role.rb | 1 - .../lib/elasticsearch/api/actions/security/get_role_mapping.rb | 1 - .../elasticsearch/api/actions/security/get_service_accounts.rb | 1 - .../api/actions/security/get_service_credentials.rb | 1 - .../lib/elasticsearch/api/actions/security/get_user.rb | 1 - .../lib/elasticsearch/api/actions/security/get_user_profile.rb | 1 - .../lib/elasticsearch/api/actions/security/grant_api_key.rb | 1 - .../lib/elasticsearch/api/actions/security/has_privileges.rb | 1 - .../lib/elasticsearch/api/actions/security/put_privileges.rb | 1 - .../lib/elasticsearch/api/actions/security/put_role.rb | 1 - .../lib/elasticsearch/api/actions/security/put_role_mapping.rb | 1 - .../lib/elasticsearch/api/actions/security/put_user.rb | 1 - .../lib/elasticsearch/api/actions/security/query_api_keys.rb | 1 - .../lib/elasticsearch/api/actions/security/query_user.rb | 1 - .../api/actions/security/saml_service_provider_metadata.rb | 1 - .../elasticsearch/api/actions/security/suggest_user_profiles.rb | 1 - .../lib/elasticsearch/api/actions/security/update_api_key.rb | 1 - .../api/actions/security/update_user_profile_data.rb | 1 - .../lib/elasticsearch/api/actions/shutdown/delete_node.rb | 1 - .../lib/elasticsearch/api/actions/shutdown/get_node.rb | 1 - .../lib/elasticsearch/api/actions/shutdown/put_node.rb | 1 - .../lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb | 1 - .../lib/elasticsearch/api/actions/snapshot/clone.rb | 1 - .../lib/elasticsearch/api/actions/snapshot/create.rb | 1 - .../lib/elasticsearch/api/actions/snapshot/create_repository.rb | 1 - .../lib/elasticsearch/api/actions/snapshot/delete.rb | 1 - .../lib/elasticsearch/api/actions/snapshot/delete_repository.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb | 1 - .../lib/elasticsearch/api/actions/snapshot/get_repository.rb | 1 - .../lib/elasticsearch/api/actions/snapshot/repository_analyze.rb | 1 - .../lib/elasticsearch/api/actions/snapshot/restore.rb | 1 - .../lib/elasticsearch/api/actions/snapshot/status.rb | 1 - .../lib/elasticsearch/api/actions/snapshot/verify_repository.rb | 1 - .../actions/snapshot_lifecycle_management/delete_lifecycle.rb | 1 - .../actions/snapshot_lifecycle_management/execute_lifecycle.rb | 1 - .../api/actions/snapshot_lifecycle_management/get_lifecycle.rb | 1 - .../api/actions/snapshot_lifecycle_management/put_lifecycle.rb | 1 - .../lib/elasticsearch/api/actions/sql/delete_async.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb | 1 - .../lib/elasticsearch/api/actions/sql/get_async_status.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb | 1 - .../lib/elasticsearch/api/actions/synonyms/delete_synonym.rb | 1 - .../elasticsearch/api/actions/synonyms/delete_synonym_rule.rb | 1 - .../lib/elasticsearch/api/actions/synonyms/get_synonym.rb | 1 - .../lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb | 1 - .../lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb | 1 - .../lib/elasticsearch/api/actions/synonyms/put_synonym.rb | 1 - .../lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb | 1 - .../elasticsearch/api/actions/text_structure/find_structure.rb | 1 - .../api/actions/text_structure/test_grok_pattern.rb | 1 - .../lib/elasticsearch/api/actions/transform/delete_transform.rb | 1 - .../lib/elasticsearch/api/actions/transform/get_transform.rb | 1 - .../elasticsearch/api/actions/transform/get_transform_stats.rb | 1 - .../lib/elasticsearch/api/actions/transform/preview_transform.rb | 1 - .../lib/elasticsearch/api/actions/transform/put_transform.rb | 1 - .../lib/elasticsearch/api/actions/transform/reset_transform.rb | 1 - .../api/actions/transform/schedule_now_transform.rb | 1 - .../lib/elasticsearch/api/actions/transform/start_transform.rb | 1 - .../lib/elasticsearch/api/actions/transform/stop_transform.rb | 1 - .../lib/elasticsearch/api/actions/transform/update_transform.rb | 1 - .../elasticsearch/api/actions/transform/upgrade_transforms.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/update.rb | 1 - .../lib/elasticsearch/api/actions/update_by_query.rb | 1 - .../lib/elasticsearch/api/actions/update_by_query_rethrottle.rb | 1 - .../lib/elasticsearch/api/actions/watcher/ack_watch.rb | 1 - .../lib/elasticsearch/api/actions/watcher/activate_watch.rb | 1 - .../lib/elasticsearch/api/actions/watcher/deactivate_watch.rb | 1 - .../lib/elasticsearch/api/actions/watcher/delete_watch.rb | 1 - .../lib/elasticsearch/api/actions/watcher/execute_watch.rb | 1 - .../lib/elasticsearch/api/actions/watcher/get_watch.rb | 1 - .../lib/elasticsearch/api/actions/watcher/put_watch.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb | 1 - elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb | 1 - 346 files changed, 346 deletions(-) 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 b708eb6910..14b44b55ac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb @@ -23,7 +23,6 @@ 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. - # # @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 c88a01911f..6b2374a31e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb @@ -23,7 +23,6 @@ module API module AsyncSearch module Actions # Retrieves the results of a previously submitted async search request given its ID. - # # @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 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/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb index 5585361687..0df0433ef9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb @@ -23,7 +23,6 @@ module API module AsyncSearch module Actions # Retrieves the status of a previously submitted async search request given its ID. - # # @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 # @option arguments [Hash] :headers Custom HTTP headers 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 d5f71ca8c5..3b00a222b2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb @@ -23,7 +23,6 @@ module API module AsyncSearch module Actions # Executes a search request asynchronously. - # # @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 # @option arguments [Boolean] :keep_on_completion Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false) 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 142957c367..93112f3e27 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 @@ -23,7 +23,6 @@ module API module Autoscaling module Actions # Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. - # # @option arguments [String] :name the name of the autoscaling policy # @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 fb6b9b53a6..9eb00cb637 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 @@ -23,7 +23,6 @@ module API module Autoscaling module Actions # Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported. - # # @option arguments [String] :name the name of the autoscaling policy # @option arguments [Hash] :headers Custom HTTP headers # 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 fe975a99c1..df2326d24b 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 @@ -23,7 +23,6 @@ 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. - # # @option arguments [String] :name the name of the autoscaling policy # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body the specification of the autoscaling policy (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb b/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb index 82e0f7e9e0..ed6baae5e2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Allows to perform multiple index/update/delete operations in a single request. - # # @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) # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb index 3e8baad1b1..d50019d3c6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Shows information about currently configured aliases to indices including filter and routing infos. - # # @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 # @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/cat/allocation.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb index a3485691cd..d1ca1646be 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb @@ -23,7 +23,6 @@ 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. - # # @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) 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 0f5a943b32..a9775b1390 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns information about existing component_templates 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 # @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/cat/count.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb index 6004c02d8a..06714a907a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Provides quick access to the document count of the entire cluster, or individual indices. - # # @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 [List] :h Comma-separated list of column names to display diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb index a2251fb96d..722f5f8fc3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Shows how much heap memory is currently being used by fielddata on every data node in the cluster. - # # @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) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb index 2a7c1b8ea6..67cbbfd888 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns a concise representation of the cluster health. - # # @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/help.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb index eb513aa2c8..32b30658b1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns help for the Cat APIs. - # # @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 [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 636dc95b97..5c525e6e19 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns information about indices: number of primaries and replicas, document counts, disk size, ... - # # @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) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb index e62f87a06d..aa14e856f2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns information about the master node. - # # @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 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 889c8ba30c..ce5f366971 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 @@ -23,7 +23,6 @@ module API module Cat module Actions # Gets configuration and usage information about 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) 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 cb8685f574..6c0913dd43 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Gets configuration and usage information about 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) # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml 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 92e55cb6e0..7c5b3779a0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Gets configuration and usage information about 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) 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 3aac6624fa..9e1d0450d3 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 @@ -23,7 +23,6 @@ module API module Cat module Actions # Gets configuration and usage information about inference 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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb index 42226a65a6..b292542a28 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns information about custom node attributes. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb index 261e6ccf48..fa23cca238 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns basic statistics about performance of cluster nodes. - # # @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] :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) 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 3695f9479a..2c3efcb08d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns a concise representation of the cluster pending tasks. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb index 9dc2d477d7..8c3266ed71 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns information about installed plugins across nodes node. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb index ab2b5788dd..4829dd96bd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns information about index shard recoveries, both on-going completed. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb index dbfd4647fa..9635c6e291 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns information about snapshot repositories registered in the cluster. - # # @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 # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb index f024458605..5fbfefd8d6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Provides low-level information about the segments in the shards of an index. - # # @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) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb index f28711e20a..67de71a45c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Provides a detailed view of shard allocation on nodes. - # # @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) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb index 4832079a98..889d744b70 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns all snapshots in a specific repository. - # # @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 # @option arguments [Boolean] :ignore_unavailable Set to true to ignore unavailable snapshots diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb index 92f2066551..29322c6897 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Returns information about existing templates. - # # @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 # @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/cat/thread_pool.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb index 2e700be694..56eb87efa0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb @@ -24,7 +24,6 @@ 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. - # # @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 # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb index ed24d8552b..d10b9f2823 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb @@ -23,7 +23,6 @@ module API module Cat module Actions # Gets configuration and usage information about transforms. - # # @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 # @option arguments [Integer] :size specifies a max number of transforms to get, defaults to 100 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb b/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb index 6c5cef9cd7..5aad2ac935 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Explicitly clears the search context for a scroll. - # # @option arguments [List] :scroll_id A comma-separated list of scroll IDs to clear *Deprecated* # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter 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 9ea91de49e..a3638bc0ba 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Provides explanations for shard allocations in the cluster. - # # @option arguments [Boolean] :include_yes_decisions Return 'YES' decisions in explanation (default: false) # @option arguments [Boolean] :include_disk_info Return information about disk usage and shard sizes (default: false) # @option arguments [Hash] :headers Custom HTTP headers 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 f92ed55963..742db481d7 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 @@ -23,7 +23,6 @@ module API module Cluster module Actions # Deletes a component template - # # @option arguments [String] :name The name of the template # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master 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 1f536ee6ee..96e00fd517 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 @@ -23,7 +23,6 @@ module API module Cluster module Actions # Clears 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 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 ad75545c18..03bb3f85bd 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 @@ -23,7 +23,6 @@ module API module Cluster module Actions # Returns information about whether a particular component template exist - # # @option arguments [String] :name The name of the template # @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) 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 e3a094ab08..ad0c13f097 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 @@ -23,7 +23,6 @@ module API module Cluster module Actions # Returns one or more 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 # @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/cluster/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb index 0d4e0362e6..f92a078601 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Returns 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 # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb index 56c794b792..6c253673d8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Returns basic information about the health of the cluster. - # # @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) # @option arguments [String] :level Specify the level of detail for returned information (options: cluster, indices, shards) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb index 9b62f7713c..c945509498 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Returns different information about the cluster. - # # @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 38fc0c5e76..e851e6bf3d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb @@ -24,7 +24,6 @@ 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. - # # @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 # @option arguments [Hash] :headers Custom HTTP headers 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 3c0d090512..804e5e0915 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 @@ -23,7 +23,6 @@ module API module Cluster module Actions # Updates the cluster voting config exclusions by node ids or node names. - # # @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. # @option arguments [Time] :timeout Explicit operation timeout 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 9bec069f23..a7a8cab10d 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 @@ -23,7 +23,6 @@ module API module Cluster module Actions # Creates or updates 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 # @option arguments [Time] :timeout Explicit operation timeout 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 eec380817a..61abc54029 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Updates 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 # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb index c3269599f1..95f8c5aa4c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Allows to manually change the allocation of individual shards in 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 # @option arguments [Boolean] :retry_failed Retries allocation of shards that are blocked due to too many subsequent allocation failures diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb index 473fbf365e..48460249db 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Returns a comprehensive information about the state of the cluster. - # # @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 # @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/cluster/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb index b7adfcb7f9..10dd6de1e6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb @@ -23,7 +23,6 @@ module API module Cluster module Actions # Returns high-level overview of 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] :flat_settings Return settings in flat format (default: false) # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/count.rb b/elasticsearch-api/lib/elasticsearch/api/actions/count.rb index d21f1fdd6b..e744951c8d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/count.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/count.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns number of documents matching a query. - # # @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) # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/create.rb index 3cd830531a..a380bfce03 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/create.rb @@ -24,7 +24,6 @@ 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. - # # @option arguments [String] :id Document ID # @option arguments [String] :index The name of the index # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) 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 1cc8731002..e882ceefda 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 @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Deletes auto-follow patterns. - # # @option arguments [String] :name The name of the auto follow pattern. # @option arguments [Hash] :headers Custom HTTP headers # 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 4660b57e53..01813410f4 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 @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Creates a new follower index configured to follow the referenced leader index. - # # @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) # @option arguments [Hash] :headers Custom HTTP headers 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 5a0a0ae456..2c8debc060 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 @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Retrieves information about all follower indices, including parameters and status for each follower index - # # @option arguments [List] :index A comma-separated list of index patterns; use `_all` to perform the operation on all indices # @option arguments [Hash] :headers Custom HTTP headers # 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 738cb0365d..e9fe2fa493 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 @@ -23,7 +23,6 @@ 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. - # # @option arguments [List] :index A comma-separated list of index patterns; use `_all` to perform the operation on all indices # @option arguments [Hash] :headers Custom HTTP headers # 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 013e8aef92..8a539d67f6 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 @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Removes the follower retention leases from the leader. - # # @option arguments [String] :index the name of the leader index for which specified follower retention leases should be removed # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body the name and UUID of the follower index, the name of the cluster containing the follower index, and the alias from the perspective of that cluster for the remote cluster containing the leader index (*Required*) 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 ea8b32ec52..5e6476aecb 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 @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. - # # @option arguments [String] :name The name of the auto follow pattern. # @option arguments [Hash] :headers Custom HTTP headers # 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 52ad3fef93..1be2c9a73c 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 @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Pauses 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 [Hash] :headers Custom HTTP headers # 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 8844dfbc28..fa1d87cc5b 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 @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Pauses a follower index. The follower index will not fetch any additional operations from the leader index. - # # @option arguments [String] :index The name of the follower index that should pause following its leader index. # @option arguments [Hash] :headers Custom HTTP headers # 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 4444768ae5..020a3003b6 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 @@ -23,7 +23,6 @@ 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. - # # @option arguments [String] :name The name of the auto follow pattern. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The specification of the auto follow pattern (*Required*) 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 f2d2f54a1d..3e40e11487 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 @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Resumes an auto-follow pattern that has been paused - # # @option arguments [String] :name The name of the auto follow pattern to resume discovering new indices to follow. # @option arguments [Hash] :headers Custom HTTP headers # 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 288ea27311..bd98ee5642 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 @@ -23,7 +23,6 @@ module API module CrossClusterReplication module Actions # Resumes a follower index that has been paused - # # @option arguments [String] :index The name of the follow index to resume following. # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The name of the leader index and other optional ccr related parameters 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 6160961493..26229e0a6c 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 @@ -23,7 +23,6 @@ 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. - # # @option arguments [String] :index The name of the follower index that should be turned into a regular index. # @option arguments [Hash] :headers Custom HTTP headers # 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 e5b44b94e8..b0414430ce 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 @@ -23,7 +23,6 @@ module API module DanglingIndices module Actions # Deletes the specified 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 # @option arguments [Time] :timeout Explicit operation timeout 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 72844d84ee..d186201cf3 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 @@ -23,7 +23,6 @@ module API module DanglingIndices module Actions # Imports the specified 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 # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb index f93e305536..61de4c5001 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Removes a document from the index. - # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the delete 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/delete_by_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb index a6a5770f52..e785bbdbaf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Deletes documents matching the provided query. - # # @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 # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false) 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 2d7e2f7e12..b11ba2dcd8 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 @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Changes the number of requests per second for a particular 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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb index 61dd89ba9e..c881a333db 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Deletes a script. - # # @option arguments [String] :id Script ID # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master 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 f3dfa1b24a..1066574815 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb @@ -23,7 +23,6 @@ module API module Enrich module Actions # Deletes an existing enrich policy and its enrich index. - # # @option arguments [String] :name The name of the enrich policy # @option arguments [Hash] :headers Custom HTTP headers # 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 aa2905b003..7b4dfad031 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb @@ -23,7 +23,6 @@ module API module Enrich module Actions # Creates the enrich index for an existing 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. # @option arguments [Hash] :headers Custom HTTP headers 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 57c92a2773..9cc125dd7f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb @@ -23,7 +23,6 @@ module API module Enrich module Actions # Gets information about an enrich policy. - # # @option arguments [List] :name A comma-separated list of enrich policy names # @option arguments [Hash] :headers Custom HTTP headers # 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 76928c3780..cf6c766c8b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb @@ -23,7 +23,6 @@ module API module Enrich module Actions # Creates a new enrich policy. - # # @option arguments [String] :name The name of the enrich policy # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The enrich policy to register (*Required*) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb index 61d342d7ed..a0459fdb96 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb @@ -23,7 +23,6 @@ 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. - # # @option arguments [String] :id The async search ID # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb index ba45d855f8..4614aaf52d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb @@ -23,7 +23,6 @@ module API module Eql module Actions # Returns async results from previously executed Event Query Language (EQL) search - # # @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 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 ba9cf7ac74..25c414e548 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb @@ -23,7 +23,6 @@ module API module Eql module Actions # Returns the status of a previously submitted async or stored Event Query Language (EQL) 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/eql/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb index 3b24a1f384..d4b31c9639 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb @@ -23,7 +23,6 @@ module API module Eql module Actions # Returns results matching a query expressed in Event Query Language (EQL) - # # @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 # @option arguments [Boolean] :keep_on_completion Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false) 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 a0aa257fbb..d26c4fae1e 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 @@ -23,7 +23,6 @@ module API module Esql module Actions # Retrieves the results of a previously submitted async query request given its ID. - # # @option arguments [String] :id The async query 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 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/exists.rb b/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb index dda0f3423f..c3388b1c23 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns information about whether a document exists in an index. - # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb b/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb index 16e01537e4..b79ca7725b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns information about whether a document source exists in an index. - # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index # @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/explain.rb b/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb index b18b310a1e..bb417a4aa0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns information about why a specific matches (or doesn't match) a query. - # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index # @option arguments [Boolean] :analyze_wildcard Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false) 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 2da90e7769..22e370bafc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb @@ -23,7 +23,6 @@ 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 - # # @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/field_caps.rb b/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb index 3b7fc98af6..9508e08c10 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns the information about the capabilities of fields among multiple indices. - # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [List] :fields A comma-separated list of field names # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) 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 f82fbe9bb9..e80d4f82d4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb @@ -23,7 +23,6 @@ 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. - # # @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 # @option arguments [Boolean] :wait_for_index Whether to wait for the target index to exist and all primary shards be active diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get.rb index d3237e0f5a..c9763641df 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns a document. - # # @option arguments [String] :id The document ID # @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/get_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb index b94cedcc0a..429111e108 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns a script. - # # @option arguments [String] :id Script ID # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb index 58edb80f9c..c9b897f33e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns the source of a document. - # # @option arguments [String] :id The document ID # @option arguments [String] :index The name of the index # @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/graph/explore.rb b/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb index 8fe9713f07..725e3f1d13 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb @@ -23,7 +23,6 @@ module API module Graph module Actions # Explore extracted and summarized information about the documents and 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 [String] :routing Specific routing value # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb b/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb index 098a0791c8..3fe5c0ac4c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns the health of the cluster. - # # @option arguments [String] :feature A feature of the cluster, as returned by the top-level health API # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Boolean] :verbose Opt in for more information about the health of the system diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index.rb index aaf53b6648..508d77773a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Creates or updates a document in an index. - # # @option arguments [String] :id Document ID # @option arguments [String] :index The name of the index # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) 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 715d5da126..1c4f564504 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 @@ -23,7 +23,6 @@ module API module IndexLifecycleManagement module Actions # Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted. - # # @option arguments [String] :policy The name of the index lifecycle policy # @option arguments [Hash] :headers Custom HTTP headers # 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 9e015589b0..c9d2db68c7 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 @@ -23,7 +23,6 @@ module API module IndexLifecycleManagement module Actions # Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step. - # # @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 # @option arguments [Boolean] :only_errors filters the indices included in the response to ones in an ILM error state, implies only_managed 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 253e303c64..2ec07f5dc1 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 @@ -23,7 +23,6 @@ module API module IndexLifecycleManagement module Actions # Returns the specified policy definition. Includes the policy version and last modified date. - # # @option arguments [String] :policy The name of the index lifecycle policy # @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 d5e6ab9a1c..3da2d2bd8b 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 @@ -23,7 +23,6 @@ module API module IndexLifecycleManagement module Actions # Migrates the indices and ILM policies away from custom node attribute allocation routing 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 # @option arguments [Hash] :body Optionally specify a legacy index template name to delete and optionally specify a node attribute name used for index shard routing (defaults to "data") 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 ebfee81d03..ccfe6c2abf 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 @@ -23,7 +23,6 @@ module API module IndexLifecycleManagement module Actions # Manually moves an index into the specified step and executes that step. - # # @option arguments [String] :index The name of the index whose lifecycle step is to change # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The new lifecycle step to move to 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 c7a935f5f2..db1cd794e5 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 @@ -23,7 +23,6 @@ module API module IndexLifecycleManagement module Actions # Creates a lifecycle policy - # # @option arguments [String] :policy The name of the index lifecycle policy # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The lifecycle policy definition to register 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 0f220dbe49..cdef242adc 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 @@ -23,7 +23,6 @@ module API module IndexLifecycleManagement module Actions # Removes the assigned lifecycle policy and stops managing the specified 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 366a3a5b88..ac5728a244 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 @@ -23,7 +23,6 @@ module API module IndexLifecycleManagement module Actions # Retries executing the policy for an index that is in the ERROR step. - # # @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/indices/add_block.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb index 74b42d5292..a4d6af830e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Adds a block to an index. - # # @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) # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb index cb3b1d9f1f..c449c92a6b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Performs the analysis process on a text and return the tokens breakdown of the text. - # # @option arguments [String] :index The name of the index to scope the operation # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Define analyzer/tokenizer parameters and the text on which the analysis should be performed 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 61196f72e3..fafc6a2386 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Clears all or specific caches for one or more indices. - # # @option arguments [List] :index A comma-separated list of index name to limit the operation # @option arguments [Boolean] :fielddata Clear field data # @option arguments [List] :fields A comma-separated list of fields to clear when using the `fielddata` parameter (default: all) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb index 52f6f9fdc4..2473e8fd05 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Clones 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 # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb index 3784520ec5..02340effb2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Closes an index. - # # @option arguments [List] :index A comma separated list of indices to close # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb index c28c1ab46e..9592d20d07 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Creates an index with optional settings and mappings. - # # @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. # @option arguments [Time] :timeout Explicit operation timeout 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 ea986d67cb..12e8dbc4c6 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 @@ -23,7 +23,6 @@ module API module Indices module Actions # Creates a data stream - # # @option arguments [String] :name The name of the data stream # @option arguments [Hash] :headers Custom HTTP headers # 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 9b62facfcd..ecf2d2c75a 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 @@ -23,7 +23,6 @@ module API module Indices module Actions # Provides statistics on operations happening in a data stream. - # # @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 # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb index 4f9785fbb2..18fb18f1ce 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Deletes an index. - # # @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 # @option arguments [Time] :master_timeout Specify timeout for connection to master 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 737848e90a..98fd424353 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Deletes 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. # @option arguments [Time] :timeout Explicit timestamp for the document 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 937f8fb09c..40ec919b6e 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 @@ -23,7 +23,6 @@ module API module Indices module Actions # Deletes a data stream. - # # @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 [Hash] :headers Custom HTTP headers 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 bdc344e9c3..35266f5a9b 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 @@ -23,7 +23,6 @@ module API module Indices module Actions # Deletes an index template. - # # @option arguments [String] :name The name of the template # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master 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 a7a30bbbda..54f4da6da8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Deletes an index template. - # # @option arguments [String] :name The name of the template # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb index eb23431190..8764aa72b1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns information about whether a particular index exists. - # # @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) # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (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 4a50551c9c..9510561b7d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns information about whether a particular alias exists. - # # @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 # @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/exists_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb index 24cf486d67..c74a2adfd0 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 @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns information about whether a particular index template exists. - # # @option arguments [String] :name The name of the template # @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/indices/exists_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb index c5923e304d..a3407eb704 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns information about whether a particular index template exists. - # # @option arguments [List] :name The comma separated names of the index templates # @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/indices/flush.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb index dfc6032c72..9af3a7d65e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Performs the flush operation on one or more 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) # @option arguments [Boolean] :wait_if_ongoing If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb index 8cab5ec35c..563f477779 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Performs the force merge operation on one or more indices. - # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [Boolean] :flush Specify whether the index should be flushed after performing the operation (default: true) # @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.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb index 07f352c645..f96479463c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns information about one or more 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) # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (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 5d3457d871..46e6803fec 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns an alias. - # # @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 # @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_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb index 689b3a63fb..55a053c524 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 @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns 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) # @option arguments [Boolean] :include_defaults Return all relevant default configurations for the data stream (default: false) 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 7a95eb2d14..2858287e34 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 @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns mapping for one or more fields. - # # @option arguments [List] :fields A comma-separated list of fields # @option arguments [List] :index A comma-separated list of index names # @option arguments [Boolean] :include_defaults Whether the default mapping values should be returned as well 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 9ddc745ba8..fca2fc076e 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 @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns an index template. - # # @option arguments [String] :name A pattern that returned template names must match # @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/indices/get_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb index d43487df3b..8486d20d44 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns mappings for one or more indices. - # # @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) # @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) 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 6b6cb688e7..556a3b39f8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns settings for one or more indices. - # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [List] :name The name of the settings that should be included # @option arguments [Time] :master_timeout Specify timeout for connection to master 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 ddf52e2739..71fa8b2dc8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns an index template. - # # @option arguments [List] :name The comma separated names of the index templates # @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/indices/migrate_to_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb index cfe937f1a3..2c8d054c06 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 @@ -23,7 +23,6 @@ module API module Indices module Actions # Migrates an alias to a data stream - # # @option arguments [String] :name The name of the alias to migrate # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb index 9ff40672cc..b502ce622d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Opens an index. - # # @option arguments [List] :index A comma separated list of indices to open # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master 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 26882c5c97..7c6642be55 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 @@ -23,7 +23,6 @@ module API module Indices module Actions # Promotes a data stream from a replicated data stream managed by CCR to a regular data stream - # # @option arguments [String] :name The name of the data stream # @option arguments [Hash] :headers Custom HTTP headers # 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 d1a468c13a..5cb84f5bac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Creates or updates 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 # @option arguments [Time] :timeout Explicit timestamp for the document 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 e814893074..b389ce6e08 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 @@ -23,7 +23,6 @@ module API module Indices module Actions # Creates or updates 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 # @option arguments [String] :cause User defined reason for creating/updating the 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 fd90f181bb..929c11618d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Updates the index 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 # @option arguments [Time] :master_timeout Specify timeout for connection to master 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 15e3d3071b..7d1fd0e58c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Updates the 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 # @option arguments [Time] :timeout Explicit operation timeout 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 7a62832fb9..86aa113863 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Creates or updates an 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) # @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/indices/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb index 215fa1cfc6..b3354a578e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns information about ongoing index shard recoveries. - # # @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 # @option arguments [Boolean] :active_only Display only those recoveries that are currently on-going diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb index fac8063769..a6527aeacb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Performs the refresh operation in one or more indices. - # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [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) 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 5368b40727..045b868533 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 @@ -23,7 +23,6 @@ module API module Indices module Actions # Reloads an index's search analyzers and their resources. - # # @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) # @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) 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 9a7529dddb..c69e915c2a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Resolves the specified index expressions to return information about each cluster, including the local cluster, if included. - # # @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) # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled 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 14ee04fecd..5b0e9ddad9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Returns information about any matching indices, aliases, and data streams - # # @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) # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb index 1c2c0e4dda..2b9606265b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb @@ -24,7 +24,6 @@ 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. - # # @option arguments [String] :alias The name of the alias to rollover # @option arguments [String] :new_index The name of the rollover index # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb index 68c494993c..a8d8ab4b45 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Provides low-level information about segments in a Lucene 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) # @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) 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 82e1426f6b..105608605f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Provides store information for shard copies of indices. - # # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices # @option arguments [List] :status A comma-separated list of statuses used to filter on shards to get store information for (options: green, yellow, red, all) # @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/shrink.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb index 84e6f002d5..70244652d4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Allow to shrink an existing index into a new index with fewer primary shards. - # # @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 # @option arguments [Time] :timeout Explicit operation timeout 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 0aa22d13c0..9c3eae1aa9 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 @@ -23,7 +23,6 @@ module API module Indices module Actions # Simulate matching the given index name against the index templates in the system - # # @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 # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes 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 4adcc79fee..daae434e95 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Simulate resolving the given template name or body - # # @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 # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb index 6ea9fadae8..bcbcc4804e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Allows you to split an existing index into a new index with more primary shards. - # # @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 # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb index b42d329a9d..538c05058c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Provides statistics on operations happening in an index. - # # @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 # @option arguments [List] :completion_fields A comma-separated list of fields for the `completion` index metric (supports wildcards) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb index 1b05a92c5d..13ef206390 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/unfreeze.rb @@ -23,7 +23,6 @@ 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. - # # @option arguments [String] :index The name of the index to unfreeze # @option arguments [Time] :timeout Explicit operation timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master 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 d6e26631c6..21d6e6c663 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Updates index aliases. - # # @option arguments [Time] :timeout Request timeout # @option arguments [Time] :master_timeout Specify timeout for connection to master # @option arguments [Hash] :headers Custom HTTP headers 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 d36fe53979..8e0e523315 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb @@ -23,7 +23,6 @@ module API module Indices module Actions # Allows a user to validate a potentially expensive query without executing it. - # # @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 # @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/ingest/delete_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb index 481398bab7..41d86ef5f3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb @@ -23,7 +23,6 @@ module API module Ingest module Actions # Deletes a pipeline. - # # @option arguments [String] :id Pipeline ID # @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/ingest/get_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb index 0dcf117cc2..58f737a190 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb @@ -23,7 +23,6 @@ module API module Ingest module Actions # Returns a pipeline. - # # @option arguments [String] :id Comma separated list of pipeline ids. Wildcards supported # @option arguments [Boolean] :summary Return pipelines without their definitions (default: false) # @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 b76a2fe063..df64a7e5df 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb @@ -23,7 +23,6 @@ module API module Ingest module Actions # Creates or updates a pipeline. - # # @option arguments [String] :id Pipeline ID # @option arguments [Integer] :if_version Required version for optimistic concurrency control for pipeline updates # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb index a1c99a1708..76126ce374 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb @@ -23,7 +23,6 @@ module API module Ingest module Actions # Allows to simulate a pipeline with example documents. - # # @option arguments [String] :id Pipeline ID # @option arguments [Boolean] :verbose Verbose mode. Display data output for each processor in executed pipeline # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb index 0e93eaf6cc..c314c77d29 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb @@ -23,7 +23,6 @@ module API module License module Actions # Retrieves licensing information for the cluster - # # @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* # @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 c1dcd46407..f94afe6cbc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb @@ -23,7 +23,6 @@ module API module License module Actions # Updates the license for the cluster. - # # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body licenses to be installed 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 d459fa52a4..cf76b0bbce 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 @@ -23,7 +23,6 @@ module API module License module Actions # Starts an indefinite basic license. - # # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) # @option arguments [Hash] :headers Custom HTTP headers # 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 9838c27960..ae6a35b9fa 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 @@ -23,7 +23,6 @@ module API module License module Actions # starts a limited time trial license. - # # @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) # @option arguments [Hash] :headers Custom HTTP headers 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 7c7950b415..46f9da6afc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb @@ -23,7 +23,6 @@ module API module Logstash module Actions # Deletes Logstash Pipelines used by Central Management - # # @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 84ad05a22e..68078f8c3c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb @@ -23,7 +23,6 @@ module API module Logstash module Actions # Retrieves Logstash Pipelines used by Central Management - # # @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 57f204f4f0..8078395eea 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb @@ -23,7 +23,6 @@ module API module Logstash module Actions # Adds and updates Logstash Pipelines used for Central Management - # # @option arguments [String] :id The ID of the Pipeline # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The Pipeline to add or update (*Required*) 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 5e5d6ee841..0800a6a9d3 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Clear the cached results from a trained model deployment - # # @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 1a3b485f5c..5f7283782f 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 @@ -23,7 +23,6 @@ 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. - # # @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) # @option arguments [Boolean] :force True if the job should be forcefully closed 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 a29c56daa4..5f0d63a917 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes 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 aea14c2724..d3facad617 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes scheduled 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 # @option arguments [Hash] :headers Custom HTTP headers 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 5223b36462..b56b17a251 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes anomaly detection 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 # @option arguments [Hash] :headers Custom HTTP headers 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 42576e7a9a..123752d97c 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes an existing 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 # @option arguments [Time] :timeout Controls the time to wait until a job is deleted. Defaults to 1 minute 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 dc095a1f04..fe8ed28561 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes an existing 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 # @option arguments [Hash] :headers Custom HTTP headers 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 227a6e5f5b..f55cb3a5f0 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes expired and unused machine learning 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. # @option arguments [Time] :timeout How long can the underlying delete processes run until they are canceled 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 b6ce784e71..093970096a 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes 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 d724308942..078c5907b7 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes forecasts from a machine learning 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` # @option arguments [Boolean] :allow_no_forecasts Whether to ignore if `_all` matches no forecasts 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 8085eb0ace..97658e4790 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes an existing 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 # @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/delete_model_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb index 1982798b24..abfa35ee42 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes an existing 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 # @option arguments [Hash] :headers Custom HTTP headers 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 a322d25d06..7e32f61db9 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes an existing trained inference model that is currently not referenced by an ingest pipeline. - # # @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. # @option arguments [Boolean] :force True if the model should be forcefully 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 f7d2d1e6ed..37d85a21f9 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Deletes a model alias that refers to the trained model - # # @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 # @option arguments [Hash] :headers Custom HTTP headers 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 a108ee8877..b0be67a519 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Explains a 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 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 7f6e2e91bb..b04ca31ed5 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Forces any buffered data to be processed by the job. - # # @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 # @option arguments [String] :start When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results 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 730c757c88..a5ada14af0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Predicts the future behavior of a time series by using its historical behavior. - # # @option arguments [String] :job_id The ID of the job to forecast for # @option arguments [Time] :duration The duration of the forecast # @option arguments [Time] :expires_in The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity. 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 1d39b8e1d6..5b912bbaeb 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves anomaly detection job results for one or more 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 # @option arguments [Boolean] :expand Include anomaly records 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 9a42fbf91f..ea08d9ef7f 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves information about the scheduled 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' # @option arguments [String] :start Get events after this time 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 453c49d091..d69d5b15ed 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves configuration information for calendars. - # # @option arguments [String] :calendar_id The ID of the calendar to fetch # @option arguments [Integer] :from skips a number of calendars # @option arguments [Integer] :size specifies a max number of calendars to get 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 4aca122e42..bbd3ddbba4 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves anomaly detection job results for one or more categories. - # # @option arguments [String] :job_id The name of the job # @option arguments [Long] :category_id The identifier of the category definition of interest # @option arguments [Integer] :from skips a number of categories 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 2daab3faad..3c9bbd8ca7 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves configuration information for 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 data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) # @option arguments [Integer] :from skips a number of analytics 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 8b9969c83d..d54ad19410 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves usage information for data frame analytics jobs. - # # @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) # @option arguments [Integer] :from skips a number of analytics 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 33b424183e..9d7c8558d9 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves usage information for 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) # @option arguments [Hash] :headers Custom HTTP headers 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 d4be083288..4c628adbcd 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves configuration information for datafeeds. - # # @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) # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on datafeed PUT 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 14c001900c..79f877ebfb 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves filters. - # # @option arguments [String] :filter_id The ID of the filter to fetch # @option arguments [Integer] :from skips a number of filters # @option arguments [Integer] :size specifies a max number of filters to get 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 ea1f1dbd20..32064cfaa7 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves anomaly detection job results for one or more influencers. - # # @option arguments [String] :job_id Identifier for the anomaly detection job # @option arguments [Boolean] :exclude_interim Exclude interim results # @option arguments [Integer] :from skips a number of influencers 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 779e969f11..a08afbf20d 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves usage information for 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 [Hash] :headers Custom HTTP headers 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 2075870e61..d4033195f2 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves configuration information for anomaly detection jobs. - # # @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) # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on job PUT 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 6ee4f5fbab..02efc36e95 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Returns information on how ML is using memory. - # # @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 # @option arguments [Time] :timeout Explicit operation timeout 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 bf80f5f276..e24385c726 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Gets stats for anomaly detection job model snapshot upgrades that are in progress. - # # @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`. # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs or no snapshots. (This includes the `_all` string.) 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 379236d416..e6348885ad 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves information about model snapshots. - # # @option arguments [String] :job_id The ID of the job to fetch # @option arguments [String] :snapshot_id The ID of the snapshot to fetch # @option arguments [Integer] :from Skips a number of documents 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 1bd6a51f2f..849f6413e4 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs. - # # @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 # @option arguments [String] :bucket_span The span of the overall buckets. Defaults to the longest job bucket_span 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 5d3bfd0ff9..33d39c709c 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves 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 # @option arguments [Integer] :from skips a number of records 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 a7bb136dd3..cc2dd41db0 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves configuration information for a trained inference model. - # # @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) # @option arguments [String] :include A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none. 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 1a50216fde..a79d222f9d 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Retrieves usage information for trained inference 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 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 5e393e22e5..a1b57a9475 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # 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. # @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 b2632de990..3b4a44f135 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Opens one or more anomaly detection jobs. - # # @option arguments [String] :job_id The ID of the job to open # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Query parameters can be specified in the body 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 9b2aeb5470..6c26d911a8 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Posts scheduled events in a calendar. - # # @option arguments [String] :calendar_id The ID of the calendar to modify # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body A list of events (*Required*) 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 21a7f295bc..b48f80787e 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Sends 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 # @option arguments [String] :reset_end Optional parameter to specify the end 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 c46a3bdb4d..f89b29b3fa 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Previews that will be analyzed given a data frame analytics config. - # # @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 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 4f9eb55236..42ef462ea1 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Previews 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 # @option arguments [String] :end The end time when the datafeed preview should stop 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 b980b9a9fb..773c1b73e7 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Instantiates a calendar. - # # @option arguments [String] :calendar_id The ID of the calendar to create # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The calendar details 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 d06eb38086..e7b56fcafc 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Adds an anomaly detection job to 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 add to the calendar # @option arguments [Hash] :headers Custom HTTP headers 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 6d8ec8992c..11c4f675a7 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Instantiates 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 # @option arguments [Hash] :body The data frame analytics configuration (*Required*) 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 0d1d103e6e..15db3f0e06 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Instantiates a datafeed. - # # @option arguments [String] :datafeed_id The ID of the datafeed to create # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) # @option arguments [Boolean] :allow_no_indices Ignore if the source indices expressions resolves to no concrete indices (default: true) 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 f77f79bb3b..6f08856a71 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Instantiates a filter. - # # @option arguments [String] :filter_id The ID of the filter to create # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The filter details (*Required*) 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 62dd0a716a..ec4600ca95 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Instantiates 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. # @option arguments [Boolean] :allow_no_indices Ignore if the source indices expressions resolves to no concrete indices (default: true). 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 19d5625c23..4fde54a5c1 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Creates an inference 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. # @option arguments [Boolean] :wait_for_completion Whether to wait for all child operations(e.g. model download) to complete, before returning or not. Default to false 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 b2cb8bd49f..b8f76ce1c5 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Creates a new model alias (or reassigns an existing one) to refer to the trained model - # # @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 # @option arguments [Boolean] :reassign If the model_alias already exists and points to a separate model_id, this parameter must be true. Defaults to false. 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 d04b226b86..74e3a0ba95 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Creates 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 # @option arguments [Hash] :headers Custom HTTP headers 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 666c262d66..5483ab7fee 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Creates 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 # @option arguments [Hash] :body The trained model vocabulary (*Required*) 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 ff87923799..e66571bf34 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Resets an existing 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 # @option arguments [Boolean] :delete_user_annotations Should annotations added by the user be deleted 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 d948d32a3f..ed93ef7083 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Reverts to a specific 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 # @option arguments [Boolean] :delete_intervening_results Should we reset the results back to the time of the snapshot? 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 5ca10045ae..53e194dea7 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. - # # @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 # @option arguments [Hash] :headers Custom HTTP headers 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 cfb1d6f7f0..f1f14f2f71 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Starts 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 # @option arguments [Hash] :headers Custom HTTP headers 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 4b9ead6c41..78cf350e5c 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Starts one or more 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 # @option arguments [String] :end The end time when the datafeed should stop. When not set, the datafeed continues in real time 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 870bbfd849..5c0899249b 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # 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. # @option arguments [String] :deployment_id The Id of the new deployment. Defaults to the model_id if not set. 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 50c3175b58..c1d82f01a0 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Stops one or more 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) # @option arguments [Boolean] :force True if the data frame analytics should be forcefully stopped 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 5d42c73aa1..36bd996944 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Stops one or more 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) # @option arguments [Boolean] :allow_no_datafeeds Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) *Deprecated* 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 e91619a5ab..f6b9ceafa2 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # 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) # @option arguments [Boolean] :force True if the deployment should be forcefully stopped 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 3582bbdc48..f672539672 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Updates certain properties of 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*) 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 959927a13c..2c856abbd1 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Updates certain properties of a datafeed. - # # @option arguments [String] :datafeed_id The ID of the datafeed to update # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) # @option arguments [Boolean] :allow_no_indices Ignore if the source indices expressions resolves to no concrete indices (default: true) 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 d546aea524..e7e5304dfb 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Updates the description of a filter, adds items, or removes items. - # # @option arguments [String] :filter_id The ID of the filter to update # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The filter update (*Required*) 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 0fa040e882..cd46f23d6c 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Updates certain properties of an anomaly detection job. - # # @option arguments [String] :job_id The ID of the job to create # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The job update settings (*Required*) 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 4e92cd0ea4..c3ccc93593 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Updates certain properties of 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 # @option arguments [Hash] :headers Custom HTTP headers 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 b9ef0a4cac..02a8b129b8 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 @@ -23,7 +23,6 @@ module API module MachineLearning module Actions # Upgrades a given job snapshot to the current major version. - # # @option arguments [String] :job_id The ID of the job # @option arguments [String] :snapshot_id The ID of the snapshot # @option arguments [Time] :timeout How long should the API wait for the job to be opened and the old snapshot to be loaded. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb b/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb index 1b7e751359..1ef650a363 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Allows to get multiple documents in one request. - # # @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. # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb b/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb index 4f791782b4..c667f68766 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb @@ -23,7 +23,6 @@ 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. - # # @option arguments [String] :index Index pattern # @option arguments [Hash] :headers Custom HTTP headers # diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb b/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb index 2b1ce58e32..da1d005632 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/monitoring/bulk.rb @@ -23,7 +23,6 @@ module API module Monitoring module Actions # Used by the monitoring features to 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 # @option arguments [String] :system_api_version API Version of the monitored system diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb index 02d6e91b54..c6d5d44498 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Allows to execute several search operations in one request. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb index 8e088c73a6..76e9b3822a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Allows to execute several search template operations in one request. - # # @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 [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/mtermvectors.rb b/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb index abd406e974..8c609b7c7f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns multiple termvectors in one request. - # # @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 # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". 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 f468af61f4..b93ef1468e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb @@ -23,7 +23,6 @@ module API module Nodes module Actions # Returns information about hot threads on each node in the cluster. - # # @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 # @option arguments [Number] :snapshots Number of samples of thread stacktrace (default: 10) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb index 036b8e1186..ae668c23b3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb @@ -23,7 +23,6 @@ module API module Nodes module Actions # Returns information about nodes in the cluster. - # # @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) # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) 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 d1215c478f..4db94cba1f 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 @@ -23,7 +23,6 @@ module API module Nodes module Actions # Reloads secure settings. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb index 8b09fc8e8d..a6958b37d6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb @@ -23,7 +23,6 @@ module API module Nodes module Actions # Returns statistical information about nodes in the cluster. - # # @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) # @option arguments [List] :index_metric Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, bulk, shard_stats) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb index 919370ab2e..b417756a18 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb @@ -23,7 +23,6 @@ module API module Nodes module Actions # Returns low-level information about REST actions usage on 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 [List] :metric Limit the information returned to the specified metrics (options: _all, rest_actions) # @option arguments [Time] :timeout Explicit operation timeout 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 82cf677f4f..cb6ccc04be 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 @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Open a point in time that can be used in subsequent searches - # # @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) # @option arguments [String] :routing Specific routing value diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/status.rb index d007933c05..dcda94e1ac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/profiling/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/profiling/status.rb @@ -23,7 +23,6 @@ module API module Profiling module Actions # 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 # @option arguments [Boolean] :wait_for_resources_created Whether to return immediately or wait until resources have been created diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb index 3098feeac9..f0967716e2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Creates or updates a script. - # # @option arguments [String] :id Script ID # @option arguments [String] :context Script context # @option arguments [Time] :timeout Explicit operation timeout diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb index c693f7fc6d..84e832a588 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Allows to evaluate the quality of ranked search results over a set of typical search queries - # # @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) # @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) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb index a60d10bb7c..1f24a9ff78 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb @@ -24,7 +24,6 @@ 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. - # # @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. # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the reindex 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/reindex_rethrottle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb index 52d50fb066..bcb80333fc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Changes the number of requests per second for a particular 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*) # @option arguments [Hash] :headers Custom HTTP headers 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 b888bdabdf..6d494b47a8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Allows to use the Mustache language to pre-render a search definition. - # # @option arguments [String] :id The id of the stored search template # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The search definition template and its params diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb b/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb index 1c0384772f..8cdfa5563d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Allows to retrieve a large numbers of results from a single search request. - # # @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 # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb index 2bb015390e..f0f0b04082 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns results matching a query. - # # @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 # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb index 5b96ceb2bd..0150a05fa1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns information about the indices and shards that a search request would be executed against. - # # @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) # @option arguments [String] :routing Specific routing value diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb index 4d075a06cb..810422500a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Allows to use the Mustache language to pre-render a search definition. - # # @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) # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled 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 79093a3598..da669a382c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb @@ -23,7 +23,6 @@ module API module SearchableSnapshots module Actions # Mount a snapshot as a searchable index. - # # @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 # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node 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 e0d67b1168..9479f26f90 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb @@ -23,7 +23,6 @@ module API module SearchableSnapshots module Actions # Retrieve shard-level statistics about searchable snapshots. - # # @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 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 f6b99b50a0..e15fb01bf4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Changes the passwords of users in the native realm and built-in users. - # # @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) # @option arguments [Hash] :headers Custom HTTP headers 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 bd2142aea3..f5105cd14a 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Clear a subset or all entries from 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 82869d982d..ed4a737a78 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Evicts application privileges from the native application 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 33aeaa5527..2697f951e6 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Evicts users from the user cache. Can completely clear the cache or evict specific users. - # # @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 # @option arguments [Hash] :headers Custom HTTP headers 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 52929c882e..66df20b04e 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Evicts roles from the native role 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 855b67c4c0..16331fbb76 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Evicts tokens from the service account token caches. - # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name # @option arguments [List] :name A comma-separated list of service token names 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 73734c5d47..ec41d5fb18 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Creates an API key for access without requiring basic authentication. - # # @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 # @option arguments [Hash] :body The api key request to create an 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 370db91514..9283087eb6 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Creates a service account token for access without requiring basic authentication. - # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name # @option arguments [String] :name An identifier for the token name 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 9af6bd6101..23ff4b955a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Removes application privileges. - # # @option arguments [String] :application Application name # @option arguments [String] :name Privilege 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.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb index 9704e9ade5..ba12dd5912 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Removes roles in the native realm. - # # @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) # @option arguments [Hash] :headers Custom HTTP headers 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 d80032d162..141a7ae099 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Removes 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) # @option arguments [Hash] :headers Custom HTTP headers 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 d6e1abb684..207c829b29 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Deletes a service account token. - # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name # @option arguments [String] :name An identifier for the token 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 f8fa424e08..336ded1b98 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Deletes users from the native realm. - # # @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) # @option arguments [Hash] :headers Custom HTTP headers 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 343e006d57..8f5f0e8fbd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Disables users in the native realm. - # # @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) # @option arguments [Hash] :headers Custom HTTP headers 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 05b8f81c35..1935489933 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Disables a user profile so it's not visible in user profile searches. - # # @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) # @option arguments [Hash] :headers Custom HTTP headers 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 ee09515ed4..e422f01525 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Enables users in the native realm. - # # @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) # @option arguments [Hash] :headers Custom HTTP headers 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 29ecf3c3df..0ddd0ec6b0 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Enables a user profile so it's visible in user profile searches. - # # @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) # @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 4f180d520a..e3b5346379 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves information for one or more API keys. - # # @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 # @option arguments [String] :username user name of the user who created this API key to be retrieved 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 393616fe5c..19c06bfd1a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves application privileges. - # # @option arguments [String] :application Application name # @option arguments [String] :name Privilege name # @option arguments [Hash] :headers Custom HTTP headers 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 226f6a812e..a524671f0f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves roles in the native realm. - # # @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 9639ab9eda..11e76c0d21 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves 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 0deda969ad..83365f8eb2 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves information about service accounts. - # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name # @option arguments [Hash] :headers Custom HTTP headers 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 234db5d11a..061f651d2d 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves information of all service credentials for a service account. - # # @option arguments [String] :namespace An identifier for the namespace # @option arguments [String] :service An identifier for the service name # @option arguments [Hash] :headers Custom HTTP headers 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 17b2585711..b698bfc8c6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves information about users in the native realm and built-in 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 # @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 8a717edbf3..97e31c9ac7 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves user profiles for the given unique ID(s). - # # @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. # @option arguments [Hash] :headers Custom HTTP headers 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 2fad190ee3..31d3a0e18e 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Creates an API key on behalf of another 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) # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The api key request to create an API key (*Required*) 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 136ab4546a..96bf5a1297 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Determines whether the specified user has a specified list of privileges. - # # @option arguments [String] :user Username # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The privileges to test (*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 aea8a3971d..b6c9ca3f37 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Adds or updates 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 # @option arguments [Hash] :body The privilege(s) to add (*Required*) 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 8c9d7d4e88..11ca516ccb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Adds and updates roles in the native realm. - # # @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) # @option arguments [Hash] :headers Custom HTTP headers 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 92ff0bac61..719ebf8935 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Creates and updates 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) # @option arguments [Hash] :headers Custom HTTP headers 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 7024428da5..ab5aec4fd7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Adds and updates users in the native realm. These users are commonly referred to as native 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) # @option arguments [Hash] :headers Custom HTTP headers 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 c6e7418eb6..4bc143ed86 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves information for API keys using a subset of query DSL - # # @option arguments [Boolean] :with_limited_by flag to show the limited-by role descriptors of API Keys # @option arguments [Boolean] :typed_keys flag to prefix aggregation names by their respective types in the response # @option arguments [Hash] :headers Custom HTTP headers 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 653ac47185..8238c5928e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb @@ -23,7 +23,6 @@ module API module Security module Actions # Retrieves information for Users using a subset of query DSL - # # @option arguments [Boolean] :with_profile_uid flag to retrieve profile uid (if exists) associated with the user # @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/saml_service_provider_metadata.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb index 7a258e7e86..dd66ede4ad 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider - # # @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 021cd2260c..521a04f8c4 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Get suggestions for user profiles that match specified search criteria. - # # @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 # @option arguments [Hash] :body The suggestion definition for user profiles 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 7ec670ff6f..ea40cc49a9 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Updates attributes of an existing API key. - # # @option arguments [String] :id The ID of the API key to update # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The API key request to update attributes of an API key. 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 6a7c2df6f0..23cdaf1aa1 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 @@ -23,7 +23,6 @@ module API module Security module Actions # Update application specific data for the user profile of the given unique ID. - # # @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 # @option arguments [Number] :if_primary_term only perform the update operation if the last operation that has changed the document has the specified primary term 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 f56dad05b3..e80042a35d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb @@ -23,7 +23,6 @@ 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. - # # @option arguments [String] :node_id The node id of node to be removed from the shutdown state # @option arguments [Hash] :headers Custom HTTP headers # 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 f7d62070cb..070e3aea15 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb @@ -23,7 +23,6 @@ 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. - # # @option arguments [String] :node_id Which node for which to retrieve the shutdown status # @option arguments [Hash] :headers Custom HTTP headers # 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 a8f49a550a..1ef5f35e1e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb @@ -23,7 +23,6 @@ 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. - # # @option arguments [String] :node_id The node id of node to be shut down # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The shutdown type definition to register (*Required*) 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 b97a04d2ee..c9e141fe87 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Removes stale data from 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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb index ce3203bab0..554154a09e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Clones indices from one snapshot into another snapshot in the same repository. - # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot The name of the snapshot to clone from # @option arguments [String] :target_snapshot The name of the cloned snapshot to create diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb index cd1e0056d6..38a43f51f1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Creates a snapshot in a repository. - # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot A snapshot name # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node 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 a480bc38fc..585704f2fb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Creates a 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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb index bcbbbbbde0..f24728dd73 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Deletes one or more snapshots. - # # @option arguments [String] :repository A repository name # @option arguments [List] :snapshot A comma-separated list of snapshot names # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node 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 708ba4d699..3a8aa2a172 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Deletes a repository. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb index 644397c592..fe5fa054c5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Returns information about a snapshot. - # # @option arguments [String] :repository A repository name # @option arguments [List] :snapshot A comma-separated list of snapshot names # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node 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 23e4c5e920..ac4de7d88a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Returns information about a repository. - # # @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) 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 5f6e623823..b8988e94dd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Analyzes a repository for correctness and performance - # # @option arguments [String] :repository A repository name # @option arguments [Number] :blob_count Number of blobs to create during the test. Defaults to 100. # @option arguments [Number] :concurrency Number of operations to run concurrently during the test. Defaults to 10. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb index 595aad7d5c..1302d75524 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Restores a snapshot. - # # @option arguments [String] :repository A repository name # @option arguments [String] :snapshot A snapshot name # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb index 249ca24401..9cdad2bb5e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Returns information about the status of a snapshot. - # # @option arguments [String] :repository A repository name # @option arguments [List] :snapshot A comma-separated list of snapshot names # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node 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 5b65297587..f6cc2eb7e1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb @@ -23,7 +23,6 @@ module API module Snapshot module Actions # Verifies a 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 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 76f9bf7a52..537f9dc539 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 @@ -23,7 +23,6 @@ module API module SnapshotLifecycleManagement module Actions # Deletes an existing snapshot lifecycle policy. - # # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to remove # @option arguments [Hash] :headers Custom HTTP headers # 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 9973a5bbcc..c020b79877 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 @@ -23,7 +23,6 @@ module API module SnapshotLifecycleManagement module Actions # Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. - # # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to be executed # @option arguments [Hash] :headers Custom HTTP headers # 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 d16dcbe7e3..91544e653e 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 @@ -23,7 +23,6 @@ module API module SnapshotLifecycleManagement module Actions # Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. - # # @option arguments [List] :policy_id Comma-separated list of snapshot lifecycle policies to retrieve # @option arguments [Hash] :headers Custom HTTP headers # 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 ff6569c377..1f899b408a 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 @@ -23,7 +23,6 @@ module API module SnapshotLifecycleManagement module Actions # Creates or updates a snapshot lifecycle policy. - # # @option arguments [String] :policy_id The id of the snapshot lifecycle policy # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body The snapshot lifecycle policy definition to register 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 6551dbe0ec..9985d2b41c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb @@ -23,7 +23,6 @@ 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. - # # @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 018da139e3..cdd06dd7bf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb @@ -23,7 +23,6 @@ module API module SQL module Actions # Returns the current status and available results for an async SQL search or stored synchronous SQL search - # # @option arguments [String] :id The async search ID # @option arguments [String] :delimiter Separator for CSV results # @option arguments [String] :format Short version of the Accept header, e.g. json, yaml 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 370aebb0a1..b806062553 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 @@ -23,7 +23,6 @@ module API module SQL module Actions # Returns the current status of an async SQL search or a stored synchronous 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/query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb index 711a66883b..696b121bef 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb @@ -23,7 +23,6 @@ module API module SQL module Actions # Executes a SQL request - # # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Use the `query` element to start a query. Use the `cursor` element to continue a query. (*Required*) 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 576b264fbd..d6ad81166a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb @@ -23,7 +23,6 @@ module API module Synonyms module Actions # Deletes 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 a4f57f0e9f..4265c66306 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 @@ -23,7 +23,6 @@ module API module Synonyms module Actions # Deletes a synonym rule in a synonym set - # # @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 # @option arguments [Hash] :headers Custom HTTP headers 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 2114481ad3..7fb74cf7e5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb @@ -23,7 +23,6 @@ module API module Synonyms module Actions # Retrieves a synonym set - # # @option arguments [String] :id The name of the synonyms set to be retrieved # @option arguments [Integer] :from Starting offset # @option arguments [Integer] :size specifies a max number of results to get 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 fc50649d5c..566a669fc6 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 @@ -23,7 +23,6 @@ module API module Synonyms module Actions # Retrieves a synonym rule from a synonym set - # # @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 # @option arguments [Hash] :headers Custom HTTP headers 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 5c74145275..76ab78b527 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 @@ -23,7 +23,6 @@ module API module Synonyms module Actions # Retrieves a summary of all defined 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 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 ae2ea7cfdf..b064fc7e85 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb @@ -23,7 +23,6 @@ module API module Synonyms module Actions # Creates or updates a synonyms set - # # @option arguments [String] :id The id of the synonyms set to be created or updated # @option arguments [Hash] :headers Custom HTTP headers # @option arguments [Hash] :body Synonyms set rules (*Required*) 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 a069a099d9..0438932b5a 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 @@ -23,7 +23,6 @@ module API module Synonyms module Actions # Creates or updates a synonym rule in a synonym set - # # @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 # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb b/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb index 115d690b9d..c8ca3a8e12 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb @@ -22,7 +22,6 @@ 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. - # # @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 # @option arguments [Hash] :body field name, string which is the prefix expected in matching terms, timeout and size for max number of results diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb b/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb index cb22d23909..98d31f1198 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Returns information and statistics about terms in the fields of a particular document. - # # @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. # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned. 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 bcdc03b407..3a69345860 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 @@ -23,7 +23,6 @@ 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. - # # @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. # @option arguments [Time] :timeout Timeout after which the analysis will be aborted 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 494b86016f..b66d9782fd 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 @@ -23,7 +23,6 @@ module API module TextStructure module Actions # Tests a Grok pattern on some text. - # # @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 # @option arguments [Hash] :body The Grok pattern and text. (*Required*) 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 7ac935f3a1..3f011bd5a6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Deletes an existing 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. # @option arguments [Boolean] :delete_dest_index When `true`, the destination index is deleted together with the transform. The default value is `false`, meaning that the destination index will not be deleted. 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 a19307a81d..d7ed8dc7f9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Retrieves configuration information for 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 # @option arguments [Integer] :size specifies a max number of transforms to get, defaults to 100 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 12e8e83472..34f1666a07 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 @@ -23,7 +23,6 @@ module API module Transform module Actions # Retrieves usage information for transforms. - # # @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 # @option arguments [Number] :size specifies a max number of transform stats to get, defaults to 100 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 e9311266b7..f5eda9e88e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Previews 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 # @option arguments [Hash] :headers Custom HTTP headers 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 a936b22d7a..503a6ce384 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Instantiates 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. # @option arguments [Time] :timeout Controls the time to wait for the transform to start 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 0565eec368..6d79b6b686 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Resets an existing 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. # @option arguments [Time] :timeout Controls the time to wait for the transform to 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 179547b871..7d0c47e290 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 @@ -23,7 +23,6 @@ module API module Transform module Actions # Schedules now a transform. - # # @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 # @option arguments [Hash] :headers Custom HTTP headers 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 e0fa4df54d..440e6a62e0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Starts one or more transforms. - # # @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 # @option arguments [Time] :timeout Controls the time to wait for the transform to start 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 bdebaedd36..e420637690 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Stops one or more 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 # @option arguments [Boolean] :wait_for_completion Whether to wait for the transform to fully stop before returning 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 3440951960..02edb244e5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Updates certain properties of 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. # @option arguments [Time] :timeout Controls the time to wait for the update 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 a0925db183..95eb90599f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb @@ -23,7 +23,6 @@ module API module Transform module Actions # Upgrades 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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update.rb index 8bbcf1e905..bc586d7eb8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update.rb @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Updates a document with a script or partial document. - # # @option arguments [String] :id Document ID # @option arguments [String] :index The name of the index # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update 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/update_by_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb index bf58392de8..de0f4144f9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb @@ -23,7 +23,6 @@ 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. - # # @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 # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false) 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 dde9379799..028d5e774e 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 @@ -22,7 +22,6 @@ module Elasticsearch module API module Actions # Changes the number of requests per second for a particular 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 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 0e5e407c06..11b3277e89 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb @@ -23,7 +23,6 @@ module API module Watcher module Actions # Acknowledges a watch, manually throttling the execution of the watch's actions. - # # @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 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 7fe107e9dd..9ed0eeb203 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb @@ -23,7 +23,6 @@ module API module Watcher module Actions # Activates a currently inactive watch. - # # @option arguments [String] :watch_id Watch ID # @option arguments [Hash] :headers Custom HTTP headers # 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 f575e69a8e..40375c359d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb @@ -23,7 +23,6 @@ module API module Watcher module Actions # Deactivates a currently active watch. - # # @option arguments [String] :watch_id Watch ID # @option arguments [Hash] :headers Custom HTTP headers # 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 036c529fee..72944aac1f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb @@ -23,7 +23,6 @@ module API module Watcher module Actions # Removes a watch from Watcher. - # # @option arguments [String] :id Watch ID # @option arguments [Hash] :headers Custom HTTP headers # 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 247d4f010e..c9aa81e9b0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb @@ -23,7 +23,6 @@ module API module Watcher module Actions # Forces the execution of a stored 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 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 4141da7520..b345d5b684 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb @@ -23,7 +23,6 @@ module API module Watcher module Actions # Retrieves a watch by its ID. - # # @option arguments [String] :id Watch ID # @option arguments [Hash] :headers Custom HTTP headers # 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 b74c573061..9a34040be0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb @@ -23,7 +23,6 @@ module API module Watcher module Actions # Creates a new watch, or updates an existing one. - # # @option arguments [String] :id Watch ID # @option arguments [Boolean] :active Specify whether the watch is in/active by default # @option arguments [Number] :version Explicit version number for concurrency control diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb index ffc2c6cff9..657e569e5f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb @@ -23,7 +23,6 @@ module API module Watcher module Actions # Retrieves the current Watcher metrics. - # # @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 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb index 5a513d4644..fbc8ad8865 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb @@ -23,7 +23,6 @@ module API module XPack module Actions # Retrieves information about the installed X-Pack features. - # # @option arguments [List] :categories Comma-separated list of info categories. Can be any of: build, license, features # @option arguments [Boolean] :accept_enterprise If this param is used it must be set to true *Deprecated* # @option arguments [Hash] :headers Custom HTTP headers diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb index 4f8e9401e2..aaa3397aae 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb @@ -23,7 +23,6 @@ module API module XPack module Actions # Retrieves usage information about the installed X-Pack features. - # # @option arguments [Time] :master_timeout Specify timeout for watch write operation # @option arguments [Hash] :headers Custom HTTP headers #